# SOME DESCRIPTIVE TITLE # Copyright (C) YEAR the authors of Guix (msgids) # This file is distributed under the same license as the guix manual package. # FIRST AUTHOR , YEAR. # #, fuzzy msgid "" msgstr "" "#-#-#-#-# guix.pot (guix manual 1.4.0rc1) #-#-#-#-#\n" "Project-Id-Version: guix manual 1.4.0rc1\n" "Report-Msgid-Bugs-To: bug-guix@gnu.org\n" "POT-Creation-Date: 2022-12-18 16:29+0100\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" "Language: \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" "#-#-#-#-# contributing.pot (guix manual 1.4.0rc1) #-#-#-#-#\n" "Project-Id-Version: guix manual 1.4.0rc1\n" "Report-Msgid-Bugs-To: bug-guix@gnu.org\n" "POT-Creation-Date: 2022-12-10 16:55+0100\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" "Language: \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" #. type: Plain text #: doc/guix.texi:7 msgid "@documentencoding UTF-8" msgstr "" #. type: title #: doc/guix.texi:7 doc/guix.texi:140 #, no-wrap msgid "GNU Guix Reference Manual" msgstr "" #. type: include #: doc/guix.texi:10 #, no-wrap msgid "version.texi" msgstr "" #. type: copying #: doc/guix.texi:112 msgid "" "Copyright @copyright{} 2012-2022 Ludovic Courtès@* Copyright @copyright{} " "2013, 2014, 2016 Andreas Enge@* Copyright @copyright{} 2013 Nikita " "Karetnikov@* Copyright @copyright{} 2014, 2015, 2016 Alex Kost@* Copyright " "@copyright{} 2015, 2016 Mathieu Lirzin@* Copyright @copyright{} 2014 Pierre-" "Antoine Rault@* Copyright @copyright{} 2015 Taylan Ulrich Bayırlı/Kammer@* " "Copyright @copyright{} 2015, 2016, 2017, 2019, 2020, 2021 Leo Famulari@* " "Copyright @copyright{} 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022 " "Ricardo Wurmus@* Copyright @copyright{} 2016 Ben Woodcroft@* Copyright " "@copyright{} 2016, 2017, 2018, 2021 Chris Marusich@* Copyright @copyright{} " "2016, 2017, 2018, 2019, 2020, 2021, 2022 Efraim Flashner@* Copyright " "@copyright{} 2016 John Darrington@* Copyright @copyright{} 2016, 2017 Nikita " "Gillmann@* Copyright @copyright{} 2016, 2017, 2018, 2019, 2020 Jan " "Nieuwenhuizen@* Copyright @copyright{} 2016, 2017, 2018, 2019, 2020, 2021 " "Julien Lepiller@* Copyright @copyright{} 2016 Alex ter Weele@* Copyright " "@copyright{} 2016, 2017, 2018, 2019, 2020, 2021 Christopher Baines@* " "Copyright @copyright{} 2017, 2018, 2019 Clément Lassieur@* Copyright " "@copyright{} 2017, 2018, 2020, 2021, 2022 Mathieu Othacehe@* Copyright " "@copyright{} 2017 Federico Beffa@* Copyright @copyright{} 2017, 2018 Carlo " "Zancanaro@* Copyright @copyright{} 2017 Thomas Danckaert@* Copyright " "@copyright{} 2017 humanitiesNerd@* Copyright @copyright{} 2017, 2021 " "Christine Lemmer-Webber@* Copyright @copyright{} 2017, 2018, 2019, 2020, " "2021, 2022 Marius Bakke@* Copyright @copyright{} 2017, 2019, 2020, 2022 " "Hartmut Goebel@* Copyright @copyright{} 2017, 2019, 2020, 2021, 2022 Maxim " "Cournoyer@* Copyright @copyright{} 2017–2022 Tobias Geerinckx-Rice@* " "Copyright @copyright{} 2017 George Clemmer@* Copyright @copyright{} 2017 " "Andy Wingo@* Copyright @copyright{} 2017, 2018, 2019, 2020 Arun Isaac@* " "Copyright @copyright{} 2017 nee@* Copyright @copyright{} 2018 Rutger " "Helling@* Copyright @copyright{} 2018, 2021 Oleg Pykhalov@* Copyright " "@copyright{} 2018 Mike Gerwitz@* Copyright @copyright{} 2018 Pierre-Antoine " "Rouby@* Copyright @copyright{} 2018, 2019 Gábor Boskovits@* Copyright " "@copyright{} 2018, 2019, 2020, 2022 Florian Pelz@* Copyright @copyright{} " "2018 Laura Lazzati@* Copyright @copyright{} 2018 Alex Vong@* Copyright " "@copyright{} 2019 Josh Holland@* Copyright @copyright{} 2019, 2020 Diego " "Nicola Barbato@* Copyright @copyright{} 2019 Ivan Petkov@* Copyright " "@copyright{} 2019 Jakob L. Kreuze@* Copyright @copyright{} 2019 Kyle " "Andrews@* Copyright @copyright{} 2019 Alex Griffin@* Copyright @copyright{} " "2019, 2020, 2021, 2022 Guillaume Le Vaillant@* Copyright @copyright{} 2020 " "Liliana Marie Prikler@* Copyright @copyright{} 2019, 2020, 2021, 2022 Simon " "Tournier@* Copyright @copyright{} 2020 Wiktor Żelazny@* Copyright " "@copyright{} 2020 Damien Cassou@* Copyright @copyright{} 2020 Jakub " "Kądziołka@* Copyright @copyright{} 2020 Jack Hill@* Copyright @copyright{} " "2020 Naga Malleswari@* Copyright @copyright{} 2020, 2021 Brice Waegeneire@* " "Copyright @copyright{} 2020 R Veera Kumar@* Copyright @copyright{} 2020, " "2021 Pierre Langlois@* Copyright @copyright{} 2020 pinoaffe@* Copyright " "@copyright{} 2020 André Batista@* Copyright @copyright{} 2020, 2021 " "Alexandru-Sergiu Marton@* Copyright @copyright{} 2020 raingloom@* Copyright " "@copyright{} 2020 Daniel Brooks@* Copyright @copyright{} 2020 John Soo@* " "Copyright @copyright{} 2020 Jonathan Brielmaier@* Copyright @copyright{} " "2020 Edgar Vincent@* Copyright @copyright{} 2021, 2022 Maxime Devos@* " "Copyright @copyright{} 2021 B. Wilson@* Copyright @copyright{} 2021 Xinglu " "Chen@* Copyright @copyright{} 2021 Raghav Gururajan@* Copyright @copyright{} " "2021 Domagoj Stolfa@* Copyright @copyright{} 2021 Hui Lu@* Copyright " "@copyright{} 2021 pukkamustard@* Copyright @copyright{} 2021 Alice Brenon@* " "Copyright @copyright{} 2021, 2022 Josselin Poiret@* Copyright @copyright{} " "2021 muradm@* Copyright @copyright{} 2021, 2022 Andrew Tropin@* Copyright " "@copyright{} 2021 Sarah Morgensen@* Copyright @copyright{} 2022 Remco van 't " "Veer@* Copyright @copyright{} 2022 Aleksandr Vityazev@* Copyright " "@copyright{} 2022 Philip M@sup{c}Grath@* Copyright @copyright{} 2022 Karl " "Hallsby@* Copyright @copyright{} 2022 Justin Veilleux@* Copyright " "@copyright{} 2022 Reily Siegel@* Copyright @copyright{} 2022 Simon Streit@* " "Copyright @copyright{} 2022 (@* Copyright @copyright{} 2022 John Kehayias@*" msgstr "" #. type: copying #: doc/guix.texi:119 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 "" #. type: dircategory #: doc/guix.texi:121 #, no-wrap msgid "System administration" msgstr "" #. type: menuentry #: doc/guix.texi:129 msgid "Guix: (guix)" msgstr "" #. type: menuentry #: doc/guix.texi:129 msgid "Manage installed software and system configuration." msgstr "" #. type: menuentry #: doc/guix.texi:129 msgid "guix package: (guix)Invoking guix package" msgstr "" #. type: menuentry #: doc/guix.texi:129 msgid "Installing, removing, and upgrading packages." msgstr "" #. type: menuentry #: doc/guix.texi:129 msgid "guix gc: (guix)Invoking guix gc" msgstr "" #. type: menuentry #: doc/guix.texi:129 msgid "Reclaiming unused disk space." msgstr "" #. type: menuentry #: doc/guix.texi:129 msgid "guix pull: (guix)Invoking guix pull" msgstr "" #. type: menuentry #: doc/guix.texi:129 msgid "Update the list of available packages." msgstr "" #. type: menuentry #: doc/guix.texi:129 msgid "guix system: (guix)Invoking guix system" msgstr "" #. type: menuentry #: doc/guix.texi:129 msgid "Manage the operating system configuration." msgstr "" #. type: menuentry #: doc/guix.texi:129 msgid "guix deploy: (guix)Invoking guix deploy" msgstr "" #. type: menuentry #: doc/guix.texi:129 msgid "Manage operating system configurations for remote hosts." msgstr "" #. type: dircategory #: doc/guix.texi:131 #, no-wrap msgid "Software development" msgstr "" #. type: menuentry #: doc/guix.texi:137 msgid "guix shell: (guix)Invoking guix shell" msgstr "" #. type: menuentry #: doc/guix.texi:137 msgid "Creating software environments." msgstr "" #. type: menuentry #: doc/guix.texi:137 msgid "guix environment: (guix)Invoking guix environment" msgstr "" #. type: menuentry #: doc/guix.texi:137 msgid "Building development environments with Guix." msgstr "" #. type: menuentry #: doc/guix.texi:137 msgid "guix build: (guix)Invoking guix build" msgstr "" #. type: menuentry #: doc/guix.texi:137 msgid "Building packages." msgstr "" #. type: menuentry #: doc/guix.texi:137 msgid "guix pack: (guix)Invoking guix pack" msgstr "" #. type: menuentry #: doc/guix.texi:137 msgid "Creating binary bundles." msgstr "" #. type: subtitle #: doc/guix.texi:141 #, no-wrap msgid "Using the GNU Guix Functional Package Manager" msgstr "" #. type: author #: doc/guix.texi:142 #, no-wrap msgid "The GNU Guix Developers" msgstr "" #. type: titlepage #: doc/guix.texi:148 msgid "Edition @value{EDITION} @* @value{UPDATED} @*" msgstr "" #. type: node #: doc/guix.texi:155 #, no-wrap msgid "Top" msgstr "" #. type: top #: doc/guix.texi:156 #, no-wrap msgid "GNU Guix" msgstr "" #. type: Plain text #: doc/guix.texi:160 msgid "" "This document describes GNU Guix version @value{VERSION}, a functional " "package management tool written for the GNU system." msgstr "" #. You can replace the following paragraph with information on #. type: Plain text #: doc/guix.texi:173 msgid "" "This manual is also available in Simplified Chinese (@pxref{Top,,, guix." "zh_CN, GNU Guix参考手册}), French (@pxref{Top,,, guix.fr, Manuel de " "référence de GNU Guix}), German (@pxref{Top,,, guix.de, Referenzhandbuch zu " "GNU Guix}), Spanish (@pxref{Top,,, guix.es, Manual de referencia de GNU " "Guix}), Brazilian Portuguese (@pxref{Top,,, guix.pt_BR, Manual de referência " "do GNU Guix}), and Russian (@pxref{Top,,, guix.ru, Руководство GNU Guix}). " "If you would like to translate it in your native language, consider joining " "@uref{https://translate.fedoraproject.org/projects/guix/documentation-" "manual, Weblate} (@pxref{Translating Guix})." msgstr "" #. type: chapter #: doc/guix.texi:197 doc/guix.texi:207 doc/guix.texi:441 doc/guix.texi:442 #, no-wrap msgid "Introduction" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "What is Guix about?" msgstr "" #. type: chapter #: doc/guix.texi:197 doc/guix.texi:212 doc/guix.texi:638 doc/guix.texi:639 #, no-wrap msgid "Installation" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "Installing Guix." msgstr "" #. type: chapter #: doc/guix.texi:197 doc/guix.texi:228 doc/guix.texi:2153 doc/guix.texi:2154 #, no-wrap msgid "System Installation" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "Installing the whole operating system." msgstr "" #. type: chapter #: doc/guix.texi:197 doc/guix.texi:240 doc/guix.texi:2887 doc/guix.texi:2888 #, no-wrap msgid "System Troubleshooting Tips" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "When things don't go as planned." msgstr "" #. type: chapter #: doc/guix.texi:197 doc/guix.texi:2999 doc/guix.texi:3000 #, no-wrap msgid "Getting Started" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "Your first steps." msgstr "" #. type: chapter #: doc/guix.texi:197 doc/guix.texi:249 doc/guix.texi:3207 doc/guix.texi:3208 #, no-wrap msgid "Package Management" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "Package installation, upgrade, etc." msgstr "" #. type: chapter #: doc/guix.texi:197 doc/guix.texi:272 doc/guix.texi:5308 doc/guix.texi:5309 #, no-wrap msgid "Channels" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "Customizing the package collection." msgstr "" #. type: chapter #: doc/guix.texi:197 doc/guix.texi:286 doc/guix.texi:5853 doc/guix.texi:5854 #, no-wrap msgid "Development" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "Guix-aided software development." msgstr "" #. type: chapter #: doc/guix.texi:197 doc/guix.texi:294 doc/guix.texi:7218 doc/guix.texi:7219 #, no-wrap msgid "Programming Interface" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "Using Guix in Scheme." msgstr "" #. type: chapter #: doc/guix.texi:197 doc/guix.texi:316 doc/guix.texi:12178 doc/guix.texi:12179 #, no-wrap msgid "Utilities" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "Package management commands." msgstr "" #. type: chapter #: doc/guix.texi:197 doc/guix.texi:344 doc/guix.texi:15847 doc/guix.texi:15848 #, no-wrap msgid "Foreign Architectures" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "Build for foreign architectures." msgstr "" #. type: chapter #: doc/guix.texi:197 doc/guix.texi:346 doc/guix.texi:16009 doc/guix.texi:16010 #, no-wrap msgid "System Configuration" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "Configuring the operating system." msgstr "" #. type: chapter #: doc/guix.texi:197 doc/guix.texi:40476 doc/guix.texi:40477 #, no-wrap msgid "Home Configuration" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "Configuring the home environment." msgstr "" #. type: chapter #: doc/guix.texi:197 doc/guix.texi:41928 doc/guix.texi:41929 #, no-wrap msgid "Documentation" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "Browsing software user manuals." msgstr "" #. type: chapter #: doc/guix.texi:197 doc/guix.texi:416 doc/guix.texi:41994 doc/guix.texi:41995 #, no-wrap msgid "Platforms" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "Defining platforms." msgstr "" #. type: node #: doc/guix.texi:197 doc/guix.texi:421 doc/guix.texi:42103 #, no-wrap msgid "System Images" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "Creating system images." msgstr "" #. type: chapter #: doc/guix.texi:197 doc/guix.texi:428 doc/guix.texi:42611 doc/guix.texi:42612 #, no-wrap msgid "Installing Debugging Files" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "Feeding the debugger." msgstr "" #. type: node #: doc/guix.texi:197 doc/guix.texi:42766 #, no-wrap msgid "Using TeX and LaTeX" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "Typesetting." msgstr "" #. type: chapter #: doc/guix.texi:197 doc/guix.texi:42917 doc/guix.texi:42918 #, no-wrap msgid "Security Updates" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "Deploying security fixes quickly." msgstr "" #. type: chapter #: doc/guix.texi:197 doc/guix.texi:433 doc/guix.texi:43032 doc/guix.texi:43033 #, no-wrap msgid "Bootstrapping" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "GNU/Linux built from scratch." msgstr "" #. type: node #: doc/guix.texi:197 doc/guix.texi:43324 #, no-wrap msgid "Porting" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "Targeting another platform or kernel." msgstr "" #. #-#-#-#-# guix.pot (guix manual 1.4.0rc1) #-#-#-#-# #. type: menuentry #. #-#-#-#-# contributing.pot (guix manual 1.4.0rc1) #-#-#-#-# #. type: chapter #: doc/guix.texi:197 doc/contributing.texi:1 doc/contributing.texi:2 #, no-wrap msgid "Contributing" msgstr "" #. type: menuentry #: doc/guix.texi:197 msgid "Your help needed!" msgstr "" #. type: chapter #: doc/guix.texi:202 doc/guix.texi:43374 doc/guix.texi:43375 #, no-wrap msgid "Acknowledgments" msgstr "" #. type: menuentry #: doc/guix.texi:202 msgid "Thanks!" msgstr "" #. type: appendix #: doc/guix.texi:202 doc/guix.texi:43396 doc/guix.texi:43397 #, no-wrap msgid "GNU Free Documentation License" msgstr "" #. type: menuentry #: doc/guix.texi:202 msgid "The license of this manual." msgstr "" #. type: unnumbered #: doc/guix.texi:202 doc/guix.texi:43402 doc/guix.texi:43403 #, no-wrap msgid "Concept Index" msgstr "" #. type: menuentry #: doc/guix.texi:202 msgid "Concepts." msgstr "" #. type: unnumbered #: doc/guix.texi:202 doc/guix.texi:43406 doc/guix.texi:43407 #, no-wrap msgid "Programming Index" msgstr "" #. type: menuentry #: doc/guix.texi:202 msgid "Data types, functions, and variables." msgstr "" #. type: menuentry #: doc/guix.texi:205 msgid "--- The Detailed Node Listing ---" msgstr "" #. type: section #: doc/guix.texi:210 doc/guix.texi:468 doc/guix.texi:470 doc/guix.texi:471 #, no-wrap msgid "Managing Software the Guix Way" msgstr "" #. type: menuentry #: doc/guix.texi:210 doc/guix.texi:468 msgid "What's special." msgstr "" #. type: section #: doc/guix.texi:210 doc/guix.texi:468 doc/guix.texi:525 doc/guix.texi:526 #, no-wrap msgid "GNU Distribution" msgstr "" #. type: menuentry #: doc/guix.texi:210 doc/guix.texi:468 msgid "The packages and tools." msgstr "" #. type: section #: doc/guix.texi:220 doc/guix.texi:678 doc/guix.texi:680 doc/guix.texi:681 #, no-wrap msgid "Binary Installation" msgstr "" #. type: menuentry #: doc/guix.texi:220 doc/guix.texi:678 msgid "Getting Guix running in no time!" msgstr "" #. type: section #: doc/guix.texi:220 doc/guix.texi:678 doc/guix.texi:934 doc/guix.texi:935 #, no-wrap msgid "Requirements" msgstr "" #. type: menuentry #: doc/guix.texi:220 doc/guix.texi:678 msgid "Software needed to build and run Guix." msgstr "" #. type: section #: doc/guix.texi:220 doc/guix.texi:678 doc/guix.texi:1023 doc/guix.texi:1024 #, no-wrap msgid "Running the Test Suite" msgstr "" #. type: menuentry #: doc/guix.texi:220 doc/guix.texi:678 msgid "Testing Guix." msgstr "" #. type: section #: doc/guix.texi:220 doc/guix.texi:222 doc/guix.texi:678 doc/guix.texi:1120 #: doc/guix.texi:1121 #, no-wrap msgid "Setting Up the Daemon" msgstr "" #. type: menuentry #: doc/guix.texi:220 doc/guix.texi:678 msgid "Preparing the build daemon's environment." msgstr "" #. type: node #: doc/guix.texi:220 doc/guix.texi:678 doc/guix.texi:1596 #, no-wrap msgid "Invoking guix-daemon" msgstr "" #. type: menuentry #: doc/guix.texi:220 doc/guix.texi:678 msgid "Running the build daemon." msgstr "" #. type: section #: doc/guix.texi:220 doc/guix.texi:678 doc/guix.texi:1902 doc/guix.texi:1903 #, no-wrap msgid "Application Setup" msgstr "" #. type: menuentry #: doc/guix.texi:220 doc/guix.texi:678 msgid "Application-specific setup." msgstr "" #. type: section #: doc/guix.texi:220 doc/guix.texi:678 doc/guix.texi:2116 doc/guix.texi:2117 #, no-wrap msgid "Upgrading Guix" msgstr "" #. type: menuentry #: doc/guix.texi:220 doc/guix.texi:678 msgid "Upgrading Guix and its build daemon." msgstr "" #. type: subsection #: doc/guix.texi:226 doc/guix.texi:1140 doc/guix.texi:1142 doc/guix.texi:1143 #, no-wrap msgid "Build Environment Setup" msgstr "" #. type: menuentry #: doc/guix.texi:226 doc/guix.texi:1140 msgid "Preparing the isolated build environment." msgstr "" #. type: node #: doc/guix.texi:226 doc/guix.texi:1140 doc/guix.texi:1266 #, no-wrap msgid "Daemon Offload Setup" msgstr "" #. type: menuentry #: doc/guix.texi:226 doc/guix.texi:1140 msgid "Offloading builds to remote machines." msgstr "" #. type: subsection #: doc/guix.texi:226 doc/guix.texi:1140 doc/guix.texi:1505 doc/guix.texi:1506 #, no-wrap msgid "SELinux Support" msgstr "" #. type: menuentry #: doc/guix.texi:226 doc/guix.texi:1140 msgid "Using an SELinux policy for the daemon." msgstr "" #. type: section #: doc/guix.texi:238 doc/guix.texi:1541 doc/guix.texi:2187 doc/guix.texi:2189 #: doc/guix.texi:2190 #, no-wrap msgid "Limitations" msgstr "" #. type: menuentry #: doc/guix.texi:238 doc/guix.texi:2187 msgid "What you can expect." msgstr "" #. type: section #: doc/guix.texi:238 doc/guix.texi:2187 doc/guix.texi:2215 doc/guix.texi:2216 #, no-wrap msgid "Hardware Considerations" msgstr "" #. type: menuentry #: doc/guix.texi:238 doc/guix.texi:2187 msgid "Supported hardware." msgstr "" #. type: section #: doc/guix.texi:238 doc/guix.texi:2187 doc/guix.texi:2253 doc/guix.texi:2254 #, no-wrap msgid "USB Stick and DVD Installation" msgstr "" #. type: menuentry #: doc/guix.texi:238 doc/guix.texi:2187 msgid "Preparing the installation medium." msgstr "" #. type: section #: doc/guix.texi:238 doc/guix.texi:2187 doc/guix.texi:2334 doc/guix.texi:2335 #, no-wrap msgid "Preparing for Installation" msgstr "" #. type: menuentry #: doc/guix.texi:238 doc/guix.texi:2187 msgid "Networking, partitioning, etc." msgstr "" #. type: section #: doc/guix.texi:238 doc/guix.texi:2187 doc/guix.texi:2357 doc/guix.texi:2358 #, no-wrap msgid "Guided Graphical Installation" msgstr "" #. type: menuentry #: doc/guix.texi:238 doc/guix.texi:2187 msgid "Easy graphical installation." msgstr "" #. type: section #: doc/guix.texi:238 doc/guix.texi:244 doc/guix.texi:2187 doc/guix.texi:2388 #: doc/guix.texi:2389 #, no-wrap msgid "Manual Installation" msgstr "" #. type: menuentry #: doc/guix.texi:238 doc/guix.texi:2187 msgid "Manual installation for wizards." msgstr "" #. type: section #: doc/guix.texi:238 doc/guix.texi:2187 doc/guix.texi:2768 doc/guix.texi:2769 #, no-wrap msgid "After System Installation" msgstr "" #. type: menuentry #: doc/guix.texi:238 doc/guix.texi:2187 msgid "When installation succeeded." msgstr "" #. type: node #: doc/guix.texi:238 doc/guix.texi:2187 doc/guix.texi:2802 #, no-wrap msgid "Installing Guix in a VM" msgstr "" #. type: menuentry #: doc/guix.texi:238 doc/guix.texi:2187 msgid "Guix System playground." msgstr "" #. type: section #: doc/guix.texi:238 doc/guix.texi:2187 doc/guix.texi:2853 doc/guix.texi:2854 #, no-wrap msgid "Building the Installation Image" msgstr "" #. type: menuentry #: doc/guix.texi:238 doc/guix.texi:2187 msgid "How this comes to be." msgstr "" #. type: section #: doc/guix.texi:242 doc/guix.texi:2902 doc/guix.texi:2903 #, no-wrap msgid "Chrooting into an existing system" msgstr "" #. type: menuentry #: doc/guix.texi:242 msgid "Fixing things from a chroot" msgstr "" #. type: node #: doc/guix.texi:247 doc/guix.texi:2406 doc/guix.texi:2408 #, no-wrap msgid "Keyboard Layout and Networking and Partitioning" msgstr "" #. type: menuentry #: doc/guix.texi:247 doc/guix.texi:2406 msgid "Initial setup." msgstr "" #. type: subsection #: doc/guix.texi:247 doc/guix.texi:2406 doc/guix.texi:2679 doc/guix.texi:2680 #, no-wrap msgid "Proceeding with the Installation" msgstr "" #. type: menuentry #: doc/guix.texi:247 doc/guix.texi:2406 msgid "Installing." msgstr "" #. type: section #: doc/guix.texi:260 doc/guix.texi:3239 doc/guix.texi:3241 doc/guix.texi:3242 #, no-wrap msgid "Features" msgstr "" #. type: menuentry #: doc/guix.texi:260 doc/guix.texi:3239 msgid "How Guix will make your life brighter." msgstr "" #. type: node #: doc/guix.texi:260 doc/guix.texi:3239 doc/guix.texi:3331 #, no-wrap msgid "Invoking guix package" msgstr "" #. type: menuentry #: doc/guix.texi:260 doc/guix.texi:3239 msgid "Package installation, removal, etc." msgstr "" #. type: section #: doc/guix.texi:260 doc/guix.texi:262 doc/guix.texi:3239 doc/guix.texi:3944 #: doc/guix.texi:3945 #, no-wrap msgid "Substitutes" msgstr "" #. type: menuentry #: doc/guix.texi:260 doc/guix.texi:3239 msgid "Downloading pre-built binaries." msgstr "" #. type: section #: doc/guix.texi:260 doc/guix.texi:3239 doc/guix.texi:4280 doc/guix.texi:4281 #, no-wrap msgid "Packages with Multiple Outputs" msgstr "" #. type: menuentry #: doc/guix.texi:260 doc/guix.texi:3239 msgid "Single source package, multiple outputs." msgstr "" #. type: node #: doc/guix.texi:260 doc/guix.texi:3239 doc/guix.texi:4334 #, no-wrap msgid "Invoking guix gc" msgstr "" #. type: menuentry #: doc/guix.texi:260 doc/guix.texi:3239 msgid "Running the garbage collector." msgstr "" #. type: node #: doc/guix.texi:260 doc/guix.texi:3239 doc/guix.texi:4558 #, no-wrap msgid "Invoking guix pull" msgstr "" #. type: menuentry #: doc/guix.texi:260 doc/guix.texi:3239 msgid "Fetching the latest Guix and distribution." msgstr "" #. type: node #: doc/guix.texi:260 doc/guix.texi:3239 doc/guix.texi:4809 #, no-wrap msgid "Invoking guix time-machine" msgstr "" #. type: menuentry #: doc/guix.texi:260 doc/guix.texi:3239 msgid "Running an older revision of Guix." msgstr "" #. type: section #: doc/guix.texi:260 doc/guix.texi:3239 doc/guix.texi:4892 doc/guix.texi:4893 #, no-wrap msgid "Inferiors" msgstr "" #. type: menuentry #: doc/guix.texi:260 doc/guix.texi:3239 msgid "Interacting with another revision of Guix." msgstr "" #. type: node #: doc/guix.texi:260 doc/guix.texi:3239 doc/guix.texi:5020 #, no-wrap msgid "Invoking guix describe" msgstr "" #. type: menuentry #: doc/guix.texi:260 doc/guix.texi:3239 msgid "Display information about your Guix revision." msgstr "" #. type: node #: doc/guix.texi:260 doc/guix.texi:3239 doc/guix.texi:5116 #, no-wrap msgid "Invoking guix archive" msgstr "" #. type: menuentry #: doc/guix.texi:260 doc/guix.texi:3239 msgid "Exporting and importing store files." msgstr "" #. type: subsection #: doc/guix.texi:270 doc/guix.texi:3968 doc/guix.texi:3970 doc/guix.texi:3971 #, no-wrap msgid "Official Substitute Servers" msgstr "" #. type: menuentry #: doc/guix.texi:270 doc/guix.texi:3968 msgid "One particular source of substitutes." msgstr "" #. type: subsection #: doc/guix.texi:270 doc/guix.texi:3968 doc/guix.texi:4000 doc/guix.texi:4001 #, no-wrap msgid "Substitute Server Authorization" msgstr "" #. type: menuentry #: doc/guix.texi:270 doc/guix.texi:3968 msgid "How to enable or disable substitutes." msgstr "" #. type: subsection #: doc/guix.texi:270 doc/guix.texi:3968 doc/guix.texi:4070 doc/guix.texi:4071 #, no-wrap msgid "Getting Substitutes from Other Servers" msgstr "" #. type: menuentry #: doc/guix.texi:270 doc/guix.texi:3968 msgid "Substitute diversity." msgstr "" #. type: subsection #: doc/guix.texi:270 doc/guix.texi:3968 doc/guix.texi:4175 doc/guix.texi:4176 #, no-wrap msgid "Substitute Authentication" msgstr "" #. type: menuentry #: doc/guix.texi:270 doc/guix.texi:3968 msgid "How Guix verifies substitutes." msgstr "" #. type: subsection #: doc/guix.texi:270 doc/guix.texi:3968 doc/guix.texi:4210 doc/guix.texi:4211 #, no-wrap msgid "Proxy Settings" msgstr "" #. type: menuentry #: doc/guix.texi:270 doc/guix.texi:3968 msgid "How to get substitutes via proxy." msgstr "" #. type: subsection #: doc/guix.texi:270 doc/guix.texi:3968 doc/guix.texi:4222 doc/guix.texi:4223 #, no-wrap msgid "Substitution Failure" msgstr "" #. type: menuentry #: doc/guix.texi:270 doc/guix.texi:3968 msgid "What happens when substitution fails." msgstr "" #. type: subsection #: doc/guix.texi:270 doc/guix.texi:3968 doc/guix.texi:4250 doc/guix.texi:4251 #, no-wrap msgid "On Trusting Binaries" msgstr "" #. type: menuentry #: doc/guix.texi:270 doc/guix.texi:3968 msgid "How can you trust that binary blob?" msgstr "" #. type: section #: doc/guix.texi:284 doc/guix.texi:5339 doc/guix.texi:5341 doc/guix.texi:5342 #, no-wrap msgid "Specifying Additional Channels" msgstr "" #. type: menuentry #: doc/guix.texi:284 doc/guix.texi:5339 msgid "Extending the package collection." msgstr "" #. type: section #: doc/guix.texi:284 doc/guix.texi:5339 doc/guix.texi:5387 doc/guix.texi:5388 #, no-wrap msgid "Using a Custom Guix Channel" msgstr "" #. type: menuentry #: doc/guix.texi:284 doc/guix.texi:5339 msgid "Using a customized Guix." msgstr "" #. type: section #: doc/guix.texi:284 doc/guix.texi:5339 doc/guix.texi:5409 doc/guix.texi:5410 #, no-wrap msgid "Replicating Guix" msgstr "" #. type: menuentry #: doc/guix.texi:284 doc/guix.texi:5339 msgid "Running the @emph{exact same} Guix." msgstr "" #. type: section #: doc/guix.texi:284 doc/guix.texi:5339 doc/guix.texi:5469 doc/guix.texi:5470 #, no-wrap msgid "Channel Authentication" msgstr "" #. type: menuentry #: doc/guix.texi:284 doc/guix.texi:5339 msgid "How Guix verifies what it fetches." msgstr "" #. type: section #: doc/guix.texi:284 doc/guix.texi:5339 doc/guix.texi:5509 doc/guix.texi:5510 #, no-wrap msgid "Channels with Substitutes" msgstr "" #. type: menuentry #: doc/guix.texi:284 doc/guix.texi:5339 msgid "Using channels with available substitutes." msgstr "" #. type: section #: doc/guix.texi:284 doc/guix.texi:5339 doc/guix.texi:5534 doc/guix.texi:5535 #, no-wrap msgid "Creating a Channel" msgstr "" #. type: menuentry #: doc/guix.texi:284 doc/guix.texi:5339 msgid "How to write your custom channel." msgstr "" #. type: section #: doc/guix.texi:284 doc/guix.texi:5339 doc/guix.texi:5601 doc/guix.texi:5602 #, no-wrap msgid "Package Modules in a Sub-directory" msgstr "" #. type: menuentry #: doc/guix.texi:284 doc/guix.texi:5339 msgid "Specifying the channel's package modules location." msgstr "" #. type: section #: doc/guix.texi:284 doc/guix.texi:5339 doc/guix.texi:5615 doc/guix.texi:5616 #, no-wrap msgid "Declaring Channel Dependencies" msgstr "" #. type: menuentry #: doc/guix.texi:284 doc/guix.texi:5339 msgid "How to depend on other channels." msgstr "" #. type: section #: doc/guix.texi:284 doc/guix.texi:5339 doc/guix.texi:5657 doc/guix.texi:5658 #, no-wrap msgid "Specifying Channel Authorizations" msgstr "" #. type: menuentry #: doc/guix.texi:284 doc/guix.texi:5339 msgid "Defining channel authors authorizations." msgstr "" #. type: section #: doc/guix.texi:284 doc/guix.texi:5339 doc/guix.texi:5760 doc/guix.texi:5761 #, no-wrap msgid "Primary URL" msgstr "" #. type: menuentry #: doc/guix.texi:284 doc/guix.texi:5339 msgid "Distinguishing mirror to original." msgstr "" #. type: section #: doc/guix.texi:284 doc/guix.texi:5339 doc/guix.texi:5783 doc/guix.texi:5784 #, no-wrap msgid "Writing Channel News" msgstr "" #. type: menuentry #: doc/guix.texi:284 doc/guix.texi:5339 msgid "Communicating information to channel's users." msgstr "" #. type: node #: doc/guix.texi:292 doc/guix.texi:5873 doc/guix.texi:5875 #, no-wrap msgid "Invoking guix shell" msgstr "" #. type: menuentry #: doc/guix.texi:292 doc/guix.texi:5873 msgid "Spawning one-off software environments." msgstr "" #. type: node #: doc/guix.texi:292 doc/guix.texi:5873 doc/guix.texi:6336 #, no-wrap msgid "Invoking guix environment" msgstr "" #. type: menuentry #: doc/guix.texi:292 doc/guix.texi:5873 msgid "Setting up development environments." msgstr "" #. type: node #: doc/guix.texi:292 doc/guix.texi:5873 doc/guix.texi:6733 #, no-wrap msgid "Invoking guix pack" msgstr "" #. type: menuentry #: doc/guix.texi:292 doc/guix.texi:5873 msgid "Creating software bundles." msgstr "" #. type: section #: doc/guix.texi:292 doc/guix.texi:5873 doc/guix.texi:7128 doc/guix.texi:7129 #, no-wrap msgid "The GCC toolchain" msgstr "" #. type: menuentry #: doc/guix.texi:292 doc/guix.texi:5873 msgid "Working with languages supported by GCC." msgstr "" #. type: node #: doc/guix.texi:292 doc/guix.texi:5873 doc/guix.texi:7154 #, no-wrap msgid "Invoking guix git authenticate" msgstr "" #. type: menuentry #: doc/guix.texi:292 doc/guix.texi:5873 msgid "Authenticating Git repositories." msgstr "" #. type: section #: doc/guix.texi:309 doc/guix.texi:7261 doc/guix.texi:7263 doc/guix.texi:7264 #, no-wrap msgid "Package Modules" msgstr "" #. type: menuentry #: doc/guix.texi:309 doc/guix.texi:7261 msgid "Packages from the programmer's viewpoint." msgstr "" #. type: section #: doc/guix.texi:309 doc/guix.texi:311 doc/guix.texi:7261 doc/guix.texi:7325 #: doc/guix.texi:7326 #, no-wrap msgid "Defining Packages" msgstr "" #. type: menuentry #: doc/guix.texi:309 doc/guix.texi:7261 msgid "Defining new packages." msgstr "" #. type: section #: doc/guix.texi:309 doc/guix.texi:7261 doc/guix.texi:8016 doc/guix.texi:8017 #, no-wrap msgid "Defining Package Variants" msgstr "" #. type: menuentry #: doc/guix.texi:309 doc/guix.texi:7261 msgid "Customizing packages." msgstr "" #. type: section #: doc/guix.texi:309 doc/guix.texi:7261 doc/guix.texi:8282 doc/guix.texi:8283 #, no-wrap msgid "Writing Manifests" msgstr "" #. type: menuentry #: doc/guix.texi:309 doc/guix.texi:7261 msgid "The bill of materials of your environment." msgstr "" #. type: section #: doc/guix.texi:309 doc/guix.texi:7261 doc/guix.texi:8589 doc/guix.texi:8590 #, no-wrap msgid "Build Systems" msgstr "" #. type: menuentry #: doc/guix.texi:309 doc/guix.texi:7261 msgid "Specifying how packages are built." msgstr "" #. type: subsection #: doc/guix.texi:309 doc/guix.texi:7261 doc/guix.texi:9762 doc/guix.texi:9763 #: doc/guix.texi:10285 #, no-wrap msgid "Build Phases" msgstr "" #. type: menuentry #: doc/guix.texi:309 doc/guix.texi:7261 msgid "Phases of the build process of a package." msgstr "" #. type: section #: doc/guix.texi:309 doc/guix.texi:7261 doc/guix.texi:9974 doc/guix.texi:9975 #, no-wrap msgid "Build Utilities" msgstr "" #. type: menuentry #: doc/guix.texi:309 doc/guix.texi:7261 msgid "Helpers for your package definitions and more." msgstr "" #. type: section #: doc/guix.texi:309 doc/guix.texi:7261 doc/guix.texi:10444 doc/guix.texi:10445 #, no-wrap msgid "Search Paths" msgstr "" #. type: menuentry #: doc/guix.texi:309 doc/guix.texi:7261 msgid "Declaring search path environment variables." msgstr "" #. type: section #: doc/guix.texi:309 doc/guix.texi:7261 doc/guix.texi:10642 doc/guix.texi:10643 #, no-wrap msgid "The Store" msgstr "" #. type: menuentry #: doc/guix.texi:309 doc/guix.texi:7261 msgid "Manipulating the package store." msgstr "" #. type: section #: doc/guix.texi:309 doc/guix.texi:7261 doc/guix.texi:10795 doc/guix.texi:10796 #, no-wrap msgid "Derivations" msgstr "" #. type: menuentry #: doc/guix.texi:309 doc/guix.texi:7261 msgid "Low-level interface to package derivations." msgstr "" #. type: section #: doc/guix.texi:309 doc/guix.texi:7261 doc/guix.texi:10989 doc/guix.texi:10990 #, no-wrap msgid "The Store Monad" msgstr "" #. type: menuentry #: doc/guix.texi:309 doc/guix.texi:7261 msgid "Purely functional interface to the store." msgstr "" #. type: section #: doc/guix.texi:309 doc/guix.texi:7261 doc/guix.texi:11312 doc/guix.texi:11313 #, no-wrap msgid "G-Expressions" msgstr "" #. type: menuentry #: doc/guix.texi:309 doc/guix.texi:7261 msgid "Manipulating build expressions." msgstr "" #. type: node #: doc/guix.texi:309 doc/guix.texi:7261 doc/guix.texi:11950 #, no-wrap msgid "Invoking guix repl" msgstr "" #. type: menuentry #: doc/guix.texi:309 msgid "Programming Guix in Guile." msgstr "" #. type: section #: doc/guix.texi:309 doc/guix.texi:7261 doc/guix.texi:12051 doc/guix.texi:12052 #, no-wrap msgid "Using Guix Interactively" msgstr "" #. type: menuentry #: doc/guix.texi:309 doc/guix.texi:7261 msgid "Fine-grain interaction at the REPL." msgstr "" #. type: node #: doc/guix.texi:314 doc/guix.texi:7530 doc/guix.texi:7533 #, no-wrap msgid "package Reference" msgstr "" #. type: menuentry #: doc/guix.texi:314 doc/guix.texi:7530 msgid "The package data type." msgstr "" #. type: node #: doc/guix.texi:314 doc/guix.texi:7530 doc/guix.texi:7824 #, no-wrap msgid "origin Reference" msgstr "" #. type: menuentry #: doc/guix.texi:314 doc/guix.texi:7530 msgid "The origin data type." msgstr "" #. type: node #: doc/guix.texi:333 doc/guix.texi:12203 doc/guix.texi:12205 #, no-wrap msgid "Invoking guix build" msgstr "" #. type: menuentry #: doc/guix.texi:333 doc/guix.texi:12203 msgid "Building packages from the command line." msgstr "" #. type: node #: doc/guix.texi:333 doc/guix.texi:12203 doc/guix.texi:13112 #, no-wrap msgid "Invoking guix edit" msgstr "" #. type: menuentry #: doc/guix.texi:333 doc/guix.texi:12203 msgid "Editing package definitions." msgstr "" #. type: node #: doc/guix.texi:333 doc/guix.texi:12203 doc/guix.texi:13142 #, no-wrap msgid "Invoking guix download" msgstr "" #. type: menuentry #: doc/guix.texi:333 doc/guix.texi:12203 msgid "Downloading a file and printing its hash." msgstr "" #. type: node #: doc/guix.texi:333 doc/guix.texi:12203 doc/guix.texi:13200 #, no-wrap msgid "Invoking guix hash" msgstr "" #. type: menuentry #: doc/guix.texi:333 doc/guix.texi:12203 msgid "Computing the cryptographic hash of a file." msgstr "" #. type: node #: doc/guix.texi:333 doc/guix.texi:12203 doc/guix.texi:13291 #, no-wrap msgid "Invoking guix import" msgstr "" #. type: menuentry #: doc/guix.texi:333 doc/guix.texi:12203 msgid "Importing package definitions." msgstr "" #. type: node #: doc/guix.texi:333 doc/guix.texi:12203 doc/guix.texi:13884 #, no-wrap msgid "Invoking guix refresh" msgstr "" #. type: menuentry #: doc/guix.texi:333 doc/guix.texi:12203 msgid "Updating package definitions." msgstr "" #. type: node #: doc/guix.texi:333 doc/guix.texi:12203 doc/guix.texi:14256 #, no-wrap msgid "Invoking guix style" msgstr "" #. type: menuentry #: doc/guix.texi:333 doc/guix.texi:12203 msgid "Styling package definitions." msgstr "" #. type: node #: doc/guix.texi:333 doc/guix.texi:12203 doc/guix.texi:14425 #, no-wrap msgid "Invoking guix lint" msgstr "" #. type: menuentry #: doc/guix.texi:333 doc/guix.texi:12203 msgid "Finding errors in package definitions." msgstr "" #. type: node #: doc/guix.texi:333 doc/guix.texi:12203 doc/guix.texi:14611 #, no-wrap msgid "Invoking guix size" msgstr "" #. type: menuentry #: doc/guix.texi:333 doc/guix.texi:12203 msgid "Profiling disk usage." msgstr "" #. type: node #: doc/guix.texi:333 doc/guix.texi:12203 doc/guix.texi:14755 #, no-wrap msgid "Invoking guix graph" msgstr "" #. type: menuentry #: doc/guix.texi:333 doc/guix.texi:12203 msgid "Visualizing the graph of packages." msgstr "" #. type: node #: doc/guix.texi:333 doc/guix.texi:12203 doc/guix.texi:15036 #, no-wrap msgid "Invoking guix publish" msgstr "" #. type: menuentry #: doc/guix.texi:333 doc/guix.texi:12203 msgid "Sharing substitutes." msgstr "" #. type: node #: doc/guix.texi:333 doc/guix.texi:12203 doc/guix.texi:15310 #, no-wrap msgid "Invoking guix challenge" msgstr "" #. type: menuentry #: doc/guix.texi:333 doc/guix.texi:12203 msgid "Challenging substitute servers." msgstr "" #. type: node #: doc/guix.texi:333 doc/guix.texi:12203 doc/guix.texi:15499 #, no-wrap msgid "Invoking guix copy" msgstr "" #. type: menuentry #: doc/guix.texi:333 doc/guix.texi:12203 msgid "Copying to and from a remote store." msgstr "" #. type: node #: doc/guix.texi:333 doc/guix.texi:12203 doc/guix.texi:15563 #, no-wrap msgid "Invoking guix container" msgstr "" #. type: menuentry #: doc/guix.texi:333 doc/guix.texi:12203 msgid "Process isolation." msgstr "" #. type: node #: doc/guix.texi:333 doc/guix.texi:12203 doc/guix.texi:15617 #, no-wrap msgid "Invoking guix weather" msgstr "" #. type: menuentry #: doc/guix.texi:333 doc/guix.texi:12203 msgid "Assessing substitute availability." msgstr "" #. type: node #: doc/guix.texi:333 doc/guix.texi:12203 doc/guix.texi:15748 #, no-wrap msgid "Invoking guix processes" msgstr "" #. type: menuentry #: doc/guix.texi:333 doc/guix.texi:12203 msgid "Listing client processes." msgstr "" #. type: section #: doc/guix.texi:335 doc/guix.texi:12206 #, no-wrap msgid "Invoking @command{guix build}" msgstr "" #. type: subsection #: doc/guix.texi:340 doc/guix.texi:12257 doc/guix.texi:12259 #: doc/guix.texi:12260 #, no-wrap msgid "Common Build Options" msgstr "" #. type: menuentry #: doc/guix.texi:340 doc/guix.texi:12257 msgid "Build options for most commands." msgstr "" #. type: subsection #: doc/guix.texi:340 doc/guix.texi:12257 doc/guix.texi:12414 #: doc/guix.texi:12415 #, no-wrap msgid "Package Transformation Options" msgstr "" #. type: menuentry #: doc/guix.texi:340 doc/guix.texi:12257 msgid "Creating variants of packages." msgstr "" #. type: subsection #: doc/guix.texi:340 doc/guix.texi:12257 doc/guix.texi:12786 #: doc/guix.texi:12787 #, no-wrap msgid "Additional Build Options" msgstr "" #. type: menuentry #: doc/guix.texi:340 doc/guix.texi:12257 msgid "Options specific to 'guix build'." msgstr "" #. type: subsection #: doc/guix.texi:340 doc/guix.texi:12257 doc/guix.texi:13032 #: doc/guix.texi:13033 #, no-wrap msgid "Debugging Build Failures" msgstr "" #. type: menuentry #: doc/guix.texi:340 doc/guix.texi:12257 msgid "Real life packaging experience." msgstr "" #. type: section #: doc/guix.texi:344 doc/guix.texi:15871 doc/guix.texi:15873 #: doc/guix.texi:15874 #, no-wrap msgid "Cross-Compilation" msgstr "" #. type: menuentry #: doc/guix.texi:344 doc/guix.texi:15871 msgid "Cross-compiling for another architecture." msgstr "" #. type: section #: doc/guix.texi:344 doc/guix.texi:15871 doc/guix.texi:15921 #: doc/guix.texi:15922 #, no-wrap msgid "Native Builds" msgstr "" #. type: menuentry #: doc/guix.texi:344 doc/guix.texi:15871 msgid "Targeting another architecture through native builds." msgstr "" #. type: section #: doc/guix.texi:365 doc/guix.texi:16053 doc/guix.texi:16055 #: doc/guix.texi:16056 #, no-wrap msgid "Using the Configuration System" msgstr "" #. type: menuentry #: doc/guix.texi:365 doc/guix.texi:16053 msgid "Customizing your GNU system." msgstr "" #. type: node #: doc/guix.texi:365 doc/guix.texi:16053 doc/guix.texi:16311 #, no-wrap msgid "operating-system Reference" msgstr "" #. type: menuentry #: doc/guix.texi:365 doc/guix.texi:16053 msgid "Detail of operating-system declarations." msgstr "" #. type: section #: doc/guix.texi:365 doc/guix.texi:16053 doc/guix.texi:16534 #: doc/guix.texi:16535 #, no-wrap msgid "File Systems" msgstr "" #. type: menuentry #: doc/guix.texi:365 doc/guix.texi:16053 msgid "Configuring file system mounts." msgstr "" #. type: section #: doc/guix.texi:365 doc/guix.texi:16053 doc/guix.texi:16893 #: doc/guix.texi:16894 #, no-wrap msgid "Mapped Devices" msgstr "" #. type: menuentry #: doc/guix.texi:365 doc/guix.texi:16053 msgid "Block device extra processing." msgstr "" #. type: section #: doc/guix.texi:365 doc/guix.texi:16053 doc/guix.texi:17042 #: doc/guix.texi:17043 #, no-wrap msgid "Swap Space" msgstr "" #. type: menuentry #: doc/guix.texi:365 doc/guix.texi:16053 msgid "Backing RAM with disk space." msgstr "" #. type: section #: doc/guix.texi:365 doc/guix.texi:16053 doc/guix.texi:17159 #: doc/guix.texi:17160 #, no-wrap msgid "User Accounts" msgstr "" #. type: menuentry #: doc/guix.texi:365 doc/guix.texi:16053 msgid "Specifying user accounts." msgstr "" #. type: section #: doc/guix.texi:365 doc/guix.texi:2415 doc/guix.texi:16053 doc/guix.texi:17340 #: doc/guix.texi:17341 #, no-wrap msgid "Keyboard Layout" msgstr "" #. type: menuentry #: doc/guix.texi:365 doc/guix.texi:16053 msgid "How the system interprets key strokes." msgstr "" #. type: section #: doc/guix.texi:365 doc/guix.texi:1910 doc/guix.texi:16053 doc/guix.texi:17486 #: doc/guix.texi:17487 #, no-wrap msgid "Locales" msgstr "" #. type: menuentry #: doc/guix.texi:365 doc/guix.texi:16053 msgid "Language and cultural convention settings." msgstr "" #. type: node #: doc/guix.texi:365 doc/guix.texi:371 doc/guix.texi:16053 doc/guix.texi:17626 #: doc/guix.texi:17627 doc/guix.texi:31784 #, no-wrap msgid "Services" msgstr "" #. type: menuentry #: doc/guix.texi:365 doc/guix.texi:16053 msgid "Specifying system services." msgstr "" #. type: section #: doc/guix.texi:365 doc/guix.texi:16053 doc/guix.texi:37470 #: doc/guix.texi:37471 #, no-wrap msgid "Setuid Programs" msgstr "" #. type: menuentry #: doc/guix.texi:365 doc/guix.texi:16053 msgid "Programs running with elevated privileges." msgstr "" #. type: section #: doc/guix.texi:365 doc/guix.texi:2075 doc/guix.texi:16053 doc/guix.texi:37557 #: doc/guix.texi:37558 #, no-wrap msgid "X.509 Certificates" msgstr "" #. type: menuentry #: doc/guix.texi:365 doc/guix.texi:16053 msgid "Authenticating HTTPS servers." msgstr "" #. type: section #: doc/guix.texi:365 doc/guix.texi:1969 doc/guix.texi:16053 doc/guix.texi:37620 #: doc/guix.texi:37621 #, no-wrap msgid "Name Service Switch" msgstr "" #. type: menuentry #: doc/guix.texi:365 doc/guix.texi:16053 msgid "Configuring libc's name service switch." msgstr "" #. type: section #: doc/guix.texi:365 doc/guix.texi:16053 doc/guix.texi:37758 #: doc/guix.texi:37759 #, no-wrap msgid "Initial RAM Disk" msgstr "" #. type: menuentry #: doc/guix.texi:365 doc/guix.texi:16053 msgid "Linux-Libre bootstrapping." msgstr "" #. type: section #: doc/guix.texi:365 doc/guix.texi:16053 doc/guix.texi:37965 #: doc/guix.texi:37966 #, no-wrap msgid "Bootloader Configuration" msgstr "" #. type: menuentry #: doc/guix.texi:365 doc/guix.texi:16053 msgid "Configuring the boot loader." msgstr "" #. type: node #: doc/guix.texi:365 doc/guix.texi:16053 doc/guix.texi:38305 #, no-wrap msgid "Invoking guix system" msgstr "" #. type: menuentry #: doc/guix.texi:365 doc/guix.texi:16053 msgid "Instantiating a system configuration." msgstr "" #. type: node #: doc/guix.texi:365 doc/guix.texi:16053 doc/guix.texi:38952 #, no-wrap msgid "Invoking guix deploy" msgstr "" #. type: menuentry #: doc/guix.texi:365 doc/guix.texi:16053 msgid "Deploying a system configuration to a remote host." msgstr "" #. type: node #: doc/guix.texi:365 doc/guix.texi:16053 doc/guix.texi:39193 #, no-wrap msgid "Running Guix in a VM" msgstr "" #. type: menuentry #: doc/guix.texi:365 doc/guix.texi:16053 msgid "How to run Guix System in a virtual machine." msgstr "" #. type: section #: doc/guix.texi:365 doc/guix.texi:408 doc/guix.texi:16053 doc/guix.texi:39328 #: doc/guix.texi:39329 #, no-wrap msgid "Defining Services" msgstr "" #. type: menuentry #: doc/guix.texi:365 doc/guix.texi:16053 msgid "Adding new service definitions." msgstr "" #. type: menuentry #: doc/guix.texi:367 msgid "Home Environment Configuration" msgstr "" #. type: node #: doc/guix.texi:369 doc/guix.texi:40539 doc/guix.texi:41587 #, no-wrap msgid "Invoking guix home" msgstr "" #. type: menuentry #: doc/guix.texi:369 msgid "Instantiating a home environment configuration." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:17725 #: doc/guix.texi:17726 #, no-wrap msgid "Base Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Essential system services." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:18912 #: doc/guix.texi:18913 #, no-wrap msgid "Scheduled Job Execution" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "The mcron service." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:19075 #: doc/guix.texi:19076 #, no-wrap msgid "Log Rotation" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "The rottlog service." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:19296 #: doc/guix.texi:19297 #, no-wrap msgid "Networking Setup" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Setting up network interfaces." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:19716 #: doc/guix.texi:19717 #, no-wrap msgid "Networking Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Firewall, SSH daemon, etc." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:21156 #: doc/guix.texi:21157 #, no-wrap msgid "Unattended Upgrades" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Automated system upgrades." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:21294 #: doc/guix.texi:21295 #, no-wrap msgid "X Window" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Graphical display." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:21892 #: doc/guix.texi:21893 #, no-wrap msgid "Printing Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Local and remote printer support." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:22747 #: doc/guix.texi:22748 #, no-wrap msgid "Desktop Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "D-Bus and desktop services." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:23780 #: doc/guix.texi:23781 #, no-wrap msgid "Sound Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "ALSA and Pulseaudio services." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:23953 #: doc/guix.texi:23954 #, no-wrap msgid "Database Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "SQL databases, key-value stores, etc." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:24288 #: doc/guix.texi:24289 #, no-wrap msgid "Mail Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "IMAP, POP3, SMTP, and all that." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:26152 #: doc/guix.texi:26153 #, no-wrap msgid "Messaging Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Messaging services." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:26657 #: doc/guix.texi:26658 #, no-wrap msgid "Telephony Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Telephony services." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:27899 #: doc/guix.texi:27900 #, no-wrap msgid "Monitoring Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Monitoring services." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:28320 #: doc/guix.texi:28321 #, no-wrap msgid "Kerberos Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Kerberos services." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:28446 #: doc/guix.texi:28447 #, no-wrap msgid "LDAP Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "LDAP services." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:28925 #: doc/guix.texi:28926 #, no-wrap msgid "Web Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Web servers." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:30147 #: doc/guix.texi:30148 #, no-wrap msgid "Certificate Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "TLS certificates via Let's Encrypt." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:30328 #: doc/guix.texi:30329 #, no-wrap msgid "DNS Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "DNS daemons." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:31237 #: doc/guix.texi:31238 #, no-wrap msgid "VPN Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "VPN daemons." msgstr "" #. type: node #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:31588 #: doc/guix.texi:31589 doc/guix.texi:31784 #, no-wrap msgid "Network File System" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "NFS related services." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:31784 #: doc/guix.texi:31785 #, no-wrap msgid "Samba Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Samba services." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:31784 #: doc/guix.texi:31936 doc/guix.texi:31937 #, no-wrap msgid "Continuous Integration" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Cuirass and Laminar services." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:32222 #: doc/guix.texi:32223 #, no-wrap msgid "Power Management Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Extending battery life." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:32788 #: doc/guix.texi:32789 #, no-wrap msgid "Audio Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "The MPD." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:32907 #: doc/guix.texi:32908 #, no-wrap msgid "Virtualization Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Virtualization services." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:34597 #: doc/guix.texi:34598 #, no-wrap msgid "Version Control Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Providing remote access to Git repositories." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:35956 #: doc/guix.texi:35957 #, no-wrap msgid "Game Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Game servers." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:35988 #: doc/guix.texi:35989 #, no-wrap msgid "PAM Mount Service" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Service to mount volumes when logging in." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:36071 #: doc/guix.texi:36072 #, no-wrap msgid "Guix Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Services relating specifically to Guix." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:36453 #: doc/guix.texi:36454 #, no-wrap msgid "Linux Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Services tied to the Linux kernel." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:36680 #: doc/guix.texi:36681 #, no-wrap msgid "Hurd Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Services specific for a Hurd System." msgstr "" #. type: subsection #: doc/guix.texi:406 doc/guix.texi:17723 doc/guix.texi:36722 #: doc/guix.texi:36723 #, no-wrap msgid "Miscellaneous Services" msgstr "" #. type: menuentry #: doc/guix.texi:406 doc/guix.texi:17723 msgid "Other services." msgstr "" #. type: subsection #: doc/guix.texi:414 doc/guix.texi:39341 doc/guix.texi:39343 #: doc/guix.texi:39344 #, no-wrap msgid "Service Composition" msgstr "" #. type: menuentry #: doc/guix.texi:414 doc/guix.texi:39341 msgid "The model for composing services." msgstr "" #. type: subsection #: doc/guix.texi:414 doc/guix.texi:39341 doc/guix.texi:39399 #: doc/guix.texi:39400 #, no-wrap msgid "Service Types and Services" msgstr "" #. type: menuentry #: doc/guix.texi:414 doc/guix.texi:39341 msgid "Types and services." msgstr "" #. type: subsection #: doc/guix.texi:414 doc/guix.texi:39341 doc/guix.texi:39536 #: doc/guix.texi:39537 #, no-wrap msgid "Service Reference" msgstr "" #. type: menuentry #: doc/guix.texi:414 doc/guix.texi:39341 msgid "API reference." msgstr "" #. type: subsection #: doc/guix.texi:414 doc/guix.texi:39341 doc/guix.texi:39855 #: doc/guix.texi:39856 #, no-wrap msgid "Shepherd Services" msgstr "" #. type: menuentry #: doc/guix.texi:414 doc/guix.texi:39341 msgid "A particular type of service." msgstr "" #. type: subsection #: doc/guix.texi:414 doc/guix.texi:39341 doc/guix.texi:40107 #: doc/guix.texi:40108 #, no-wrap msgid "Complex Configurations" msgstr "" #. type: menuentry #: doc/guix.texi:414 doc/guix.texi:39341 msgid "Defining bindings for complex configurations." msgstr "" #. type: node #: doc/guix.texi:419 doc/guix.texi:42006 doc/guix.texi:42008 #, no-wrap msgid "platform Reference" msgstr "" #. type: menuentry #: doc/guix.texi:419 doc/guix.texi:42006 msgid "Detail of platform declarations." msgstr "" #. type: section #: doc/guix.texi:419 doc/guix.texi:42006 doc/guix.texi:42050 #: doc/guix.texi:42051 #, no-wrap msgid "Supported Platforms" msgstr "" #. type: menuentry #: doc/guix.texi:419 doc/guix.texi:42006 msgid "Description of the supported platforms." msgstr "" #. type: node #: doc/guix.texi:426 doc/guix.texi:42136 doc/guix.texi:42138 #, no-wrap msgid "image Reference" msgstr "" #. type: menuentry #: doc/guix.texi:426 doc/guix.texi:42136 msgid "Detail of image declarations." msgstr "" #. type: section #: doc/guix.texi:426 doc/guix.texi:42136 doc/guix.texi:42283 #: doc/guix.texi:42284 #, no-wrap msgid "Instantiate an Image" msgstr "" #. type: menuentry #: doc/guix.texi:426 doc/guix.texi:42136 msgid "How to instantiate an image record." msgstr "" #. type: section #: doc/guix.texi:426 doc/guix.texi:42136 doc/guix.texi:42437 #: doc/guix.texi:42438 #, no-wrap msgid "image-type Reference" msgstr "" #. type: menuentry #: doc/guix.texi:426 doc/guix.texi:42136 msgid "Detail of image types declaration." msgstr "" #. type: section #: doc/guix.texi:426 doc/guix.texi:42136 doc/guix.texi:42558 #: doc/guix.texi:42559 #, no-wrap msgid "Image Modules" msgstr "" #. type: menuentry #: doc/guix.texi:426 doc/guix.texi:42136 msgid "Definition of image modules." msgstr "" #. type: section #: doc/guix.texi:431 doc/guix.texi:42628 doc/guix.texi:42630 #: doc/guix.texi:42631 #, no-wrap msgid "Separate Debug Info" msgstr "" #. type: menuentry #: doc/guix.texi:431 doc/guix.texi:42628 msgid "Installing 'debug' outputs." msgstr "" #. type: section #: doc/guix.texi:431 doc/guix.texi:42628 doc/guix.texi:42703 #: doc/guix.texi:42704 #, no-wrap msgid "Rebuilding Debug Info" msgstr "" #. type: menuentry #: doc/guix.texi:431 doc/guix.texi:42628 msgid "Building missing debug info." msgstr "" #. type: node #: doc/guix.texi:436 doc/guix.texi:43071 doc/guix.texi:43073 #, no-wrap msgid "Reduced Binary Seed Bootstrap" msgstr "" #. type: menuentry #: doc/guix.texi:436 doc/guix.texi:43071 msgid "A Bootstrap worthy of GNU." msgstr "" #. type: section #: doc/guix.texi:436 doc/guix.texi:43071 doc/guix.texi:43148 #: doc/guix.texi:43149 #, no-wrap msgid "Preparing to Use the Bootstrap Binaries" msgstr "" #. type: menuentry #: doc/guix.texi:436 doc/guix.texi:43071 msgid "Building that what matters most." msgstr "" #. type: cindex #: doc/guix.texi:444 #, no-wrap msgid "purpose" msgstr "" #. type: Plain text #: doc/guix.texi:452 msgid "" "GNU Guix@footnote{``Guix'' is pronounced like ``geeks'', or ``ɡiːks'' using " "the international phonetic alphabet (IPA).} is a package management tool for " "and distribution of the GNU system. Guix makes it easy for unprivileged " "users to install, upgrade, or remove software packages, to roll back to a " "previous package set, to build packages from source, and generally assists " "with the creation and maintenance of software environments." msgstr "" #. type: cindex #: doc/guix.texi:453 doc/guix.texi:528 #, no-wrap msgid "Guix System" msgstr "" #. type: cindex #: doc/guix.texi:454 #, no-wrap msgid "GuixSD, now Guix System" msgstr "" #. type: cindex #: doc/guix.texi:455 #, no-wrap msgid "Guix System Distribution, now Guix System" msgstr "" #. type: Plain text #: doc/guix.texi:464 msgid "" "You can install GNU@tie{}Guix on top of an existing GNU/Linux system where " "it complements the available tools without interference " "(@pxref{Installation}), or you can use it as a standalone operating system " "distribution, @dfn{Guix@tie{}System}@footnote{We used to refer to Guix " "System as ``Guix System Distribution'' or ``GuixSD''. We now consider it " "makes more sense to group everything under the ``Guix'' banner since, after " "all, Guix System is readily available through the @command{guix system} " "command, even if you're using a different distro underneath!}. @xref{GNU " "Distribution}." msgstr "" #. type: cindex #: doc/guix.texi:473 #, no-wrap msgid "user interfaces" msgstr "" #. type: Plain text #: doc/guix.texi:479 msgid "" "Guix provides a command-line package management interface (@pxref{Package " "Management}), tools to help with software development (@pxref{Development}), " "command-line utilities for more advanced usage (@pxref{Utilities}), as well " "as Scheme programming interfaces (@pxref{Programming Interface})." msgstr "" #. type: cindex #: doc/guix.texi:479 #, no-wrap msgid "build daemon" msgstr "" #. type: Plain text #: doc/guix.texi:483 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 "" #. type: cindex #: doc/guix.texi:484 #, no-wrap msgid "extensibility of the distribution" msgstr "" #. type: cindex #: doc/guix.texi:485 doc/guix.texi:7285 #, no-wrap msgid "customization, of packages" msgstr "" #. type: Plain text #: doc/guix.texi:494 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 "" #. type: cindex #: doc/guix.texi:495 #, no-wrap msgid "functional package management" msgstr "" #. type: cindex #: doc/guix.texi:496 #, no-wrap msgid "isolation" msgstr "" #. type: Plain text #: doc/guix.texi:511 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 "" #. type: cindex #: doc/guix.texi:512 doc/guix.texi:10645 #, no-wrap msgid "store" msgstr "" #. type: Plain text #: doc/guix.texi:519 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 "" #. type: Plain text #: doc/guix.texi:523 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 "" #. type: Plain text #: doc/guix.texi:538 msgid "" "Guix comes with a distribution of the GNU system consisting entirely of free " "software@footnote{The term ``free'' here refers to the @url{https://www.gnu." "org/philosophy/free-sw.html,freedom provided to users of that software}.}. " "The distribution can be installed on its own (@pxref{System Installation}), " "but it is also possible to install Guix as a package manager on top of an " "installed GNU/Linux system (@pxref{Installation}). When we need to " "distinguish between the two, we refer to the standalone distribution as " "Guix@tie{}System." msgstr "" #. type: Plain text #: doc/guix.texi:544 msgid "" "The distribution provides core GNU packages such as GNU libc, GCC, and " "Binutils, as well as many GNU and non-GNU applications. The complete list " "of available packages can be browsed @url{https://www.gnu.org/software/guix/" "packages,on-line} or by running @command{guix package} (@pxref{Invoking guix " "package}):" msgstr "" #. type: example #: doc/guix.texi:547 #, no-wrap msgid "guix package --list-available\n" msgstr "" #. type: Plain text #: doc/guix.texi:553 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:555 msgid "Packages are currently available on the following platforms:" msgstr "" #. type: item #: doc/guix.texi:558 doc/guix.texi:2262 #, no-wrap msgid "x86_64-linux" msgstr "" #. type: table #: doc/guix.texi:560 msgid "Intel/AMD @code{x86_64} architecture, Linux-Libre kernel." msgstr "" #. type: item #: doc/guix.texi:561 doc/guix.texi:2265 #, no-wrap msgid "i686-linux" msgstr "" #. type: table #: doc/guix.texi:563 msgid "Intel 32-bit architecture (IA32), Linux-Libre kernel." msgstr "" #. type: item #: doc/guix.texi:564 #, no-wrap msgid "armhf-linux" msgstr "" #. type: table #: doc/guix.texi:568 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:569 #, no-wrap msgid "aarch64-linux" msgstr "" #. type: table #: doc/guix.texi:571 msgid "little-endian 64-bit ARMv8-A processors, Linux-Libre kernel." msgstr "" #. type: item #: doc/guix.texi:572 #, no-wrap msgid "i586-gnu" msgstr "" #. type: table #: doc/guix.texi:575 msgid "" "@uref{https://hurd.gnu.org, GNU/Hurd} on the Intel 32-bit architecture " "(IA32)." msgstr "" #. type: table #: doc/guix.texi:581 msgid "" "This configuration is experimental and under development. The easiest way " "for you to give it a try is by setting up an instance of @code{hurd-vm-" "service-type} on your GNU/Linux machine (@pxref{transparent-emulation-qemu, " "@code{hurd-vm-service-type}}). @xref{Contributing}, on how to help!" msgstr "" #. type: item #: doc/guix.texi:582 #, no-wrap msgid "mips64el-linux (unsupported)" msgstr "" #. type: table #: doc/guix.texi:588 msgid "" "little-endian 64-bit MIPS processors, specifically the Loongson series, n32 " "ABI, and Linux-Libre kernel. This configuration is no longer fully " "supported; in particular, there is no ongoing work to ensure that this " "architecture still works. Should someone decide they wish to revive this " "architecture then the code is still available." msgstr "" #. type: item #: doc/guix.texi:589 #, no-wrap msgid "powerpc-linux (unsupported)" msgstr "" #. type: table #: doc/guix.texi:594 msgid "" "big-endian 32-bit PowerPC processors, specifically the PowerPC G4 with " "AltiVec support, and Linux-Libre kernel. This configuration is not fully " "supported and there is no ongoing work to ensure this architecture works." msgstr "" #. type: item #: doc/guix.texi:595 doc/contributing.texi:1681 #, no-wrap msgid "powerpc64le-linux" msgstr "" #. type: table #: doc/guix.texi:605 msgid "" "little-endian 64-bit Power ISA processors, Linux-Libre kernel. This " "includes POWER9 systems such as the @uref{https://www.fsf.org/news/talos-ii-" "mainboard-and-talos-ii-lite-mainboard-now-fsf-certified-to-respect-your-" "freedom, RYF Talos II mainboard}. This platform is available as a " "\"technology preview\": although it is supported, substitutes are not yet " "available from the build farm (@pxref{Substitutes}), and some packages may " "fail to build (@pxref{Tracking Bugs and Patches}). That said, the Guix " "community is actively working on improving this support, and now is a great " "time to try it and get involved!" msgstr "" #. type: item #: doc/guix.texi:606 #, no-wrap msgid "riscv64-linux" msgstr "" #. type: table #: doc/guix.texi:614 msgid "" "little-endian 64-bit RISC-V processors, specifically RV64GC, and Linux-Libre " "kernel. This platform is available as a \"technology preview\": although it " "is supported, substitutes are not yet available from the build farm " "(@pxref{Substitutes}), and some packages may fail to build (@pxref{Tracking " "Bugs and Patches}). That said, the Guix community is actively working on " "improving this support, and now is a great time to try it and get involved!" msgstr "" #. type: Plain text #: doc/guix.texi:624 msgid "" "With Guix@tie{}System, you @emph{declare} all aspects of the operating " "system configuration and Guix takes care of instantiating the configuration " "in a transactional, reproducible, and stateless fashion (@pxref{System " "Configuration}). Guix System uses the Linux-libre kernel, the Shepherd " "initialization system (@pxref{Introduction,,, shepherd, The GNU Shepherd " "Manual}), the well-known GNU utilities and tool chain, as well as the " "graphical environment or system services of your choice." msgstr "" #. type: Plain text #: doc/guix.texi:628 msgid "" "Guix System is available on all the above platforms except @code{mips64el-" "linux}, @code{powerpc-linux}, @code{powerpc64le-linux} and @code{riscv64-" "linux}." msgstr "" #. type: Plain text #: doc/guix.texi:632 msgid "" "For information on porting to other architectures or kernels, " "@pxref{Porting}." msgstr "" #. type: Plain text #: doc/guix.texi:635 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:641 #, no-wrap msgid "installing Guix" msgstr "" #. type: quotation #: doc/guix.texi:643 doc/guix.texi:692 doc/guix.texi:896 doc/guix.texi:1888 #: doc/guix.texi:2102 doc/guix.texi:2164 doc/guix.texi:2351 doc/guix.texi:2573 #: doc/guix.texi:2785 doc/guix.texi:4013 doc/guix.texi:4772 doc/guix.texi:4786 #: doc/guix.texi:4843 doc/guix.texi:4896 doc/guix.texi:5129 doc/guix.texi:5888 #: doc/guix.texi:6464 doc/guix.texi:6743 doc/guix.texi:6864 doc/guix.texi:6892 #: doc/guix.texi:6945 doc/guix.texi:8353 doc/guix.texi:10521 #: doc/guix.texi:10664 doc/guix.texi:10734 doc/guix.texi:12603 #: doc/guix.texi:12643 doc/guix.texi:12917 doc/guix.texi:12929 #: doc/guix.texi:15567 doc/guix.texi:16261 doc/guix.texi:16367 #: doc/guix.texi:17280 doc/guix.texi:18285 doc/guix.texi:21276 #: doc/guix.texi:21459 doc/guix.texi:21931 doc/guix.texi:26443 #: doc/guix.texi:27052 doc/guix.texi:30015 doc/guix.texi:33932 #: doc/guix.texi:38071 doc/guix.texi:38113 doc/guix.texi:38388 #: doc/guix.texi:38558 doc/guix.texi:38726 doc/guix.texi:38833 #: doc/guix.texi:38879 doc/guix.texi:38936 doc/guix.texi:38963 #: doc/guix.texi:39301 doc/guix.texi:40491 doc/guix.texi:40566 #: doc/guix.texi:40616 doc/guix.texi:40666 doc/guix.texi:40757 #: doc/guix.texi:41714 doc/guix.texi:42912 doc/contributing.texi:174 #: doc/contributing.texi:789 doc/contributing.texi:1426 #: doc/contributing.texi:1785 #, no-wrap msgid "Note" msgstr "" #. type: quotation #: doc/guix.texi:653 msgid "" "We recommend the use of this @uref{https://git.savannah.gnu.org/cgit/guix." "git/plain/etc/guix-install.sh, shell installer script} to install Guix on " "top of a running GNU/Linux system, thereafter called a @dfn{foreign distro}." "@footnote{This section is concerned with the installation of the package " "manager, which can be done on top of a running GNU/Linux system. If, " "instead, you want to install the complete GNU operating system, " "@pxref{System Installation}.} The script automates the download, " "installation, and initial configuration of Guix. It should be run as the " "root user." msgstr "" #. type: cindex #: doc/guix.texi:655 doc/guix.texi:1905 #, no-wrap msgid "foreign distro" msgstr "" #. type: cindex #: doc/guix.texi:656 #, no-wrap msgid "directories related to foreign distro" msgstr "" #. type: Plain text #: doc/guix.texi:661 msgid "" "When installed on a foreign distro, GNU@tie{}Guix complements the available " "tools without interference. Its data lives exclusively in two directories, " "usually @file{/gnu/store} and @file{/var/guix}; other files on your system, " "such as @file{/etc}, are left untouched." msgstr "" #. type: Plain text #: doc/guix.texi:664 msgid "" "Once installed, Guix can be updated by running @command{guix pull} " "(@pxref{Invoking guix pull})." msgstr "" #. type: Plain text #: doc/guix.texi:669 msgid "" "If you prefer to perform the installation steps manually or want to tweak " "them, you may find the following subsections useful. They describe the " "software requirements of Guix, as well as how to install it manually and get " "ready to use it." msgstr "" #. type: cindex #: doc/guix.texi:683 #, no-wrap msgid "installing Guix from binaries" msgstr "" #. type: cindex #: doc/guix.texi:684 #, no-wrap msgid "installer script" msgstr "" #. type: Plain text #: doc/guix.texi:690 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 "" #. type: quotation #: doc/guix.texi:698 msgid "" "We recommend the use of this @uref{https://git.savannah.gnu.org/cgit/guix." "git/plain/etc/guix-install.sh, shell installer script}. The script " "automates the download, installation, and initial configuration steps " "described below. It should be run as the root user. As root, you can thus " "run this:" msgstr "" #. type: example #: doc/guix.texi:704 #, no-wrap msgid "" "cd /tmp\n" "wget https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh\n" "chmod +x guix-install.sh\n" "./guix-install.sh\n" msgstr "" #. type: quotation #: doc/guix.texi:709 msgid "" "If you're running Debian or a derivative such as Ubuntu, you can instead " "install the package (it might be a version older than @value{VERSION} but " "you can update it afterwards by running @samp{guix pull}):" msgstr "" #. type: example #: doc/guix.texi:712 #, no-wrap msgid "sudo apt install guix\n" msgstr "" #. type: quotation #: doc/guix.texi:715 msgid "Likewise on openSUSE:" msgstr "" #. type: example #: doc/guix.texi:718 #, no-wrap msgid "sudo zypper install guix\n" msgstr "" #. type: quotation #: doc/guix.texi:722 msgid "" "When you're done, @pxref{Application Setup} for extra configuration you " "might need, and @ref{Getting Started} for your first steps!" msgstr "" #. type: Plain text #: doc/guix.texi:725 msgid "Installing goes along these lines:" msgstr "" #. type: cindex #: doc/guix.texi:728 #, no-wrap msgid "downloading Guix binary" msgstr "" #. type: enumerate #: doc/guix.texi:734 msgid "" "Download the binary tarball from @indicateurl{@value{BASE-URL}/guix-binary-" "@value{VERSION}.x86_64-linux.tar.xz}, where @code{x86_64-linux} can be " "replaced with @code{i686-linux} for an @code{i686} (32-bits) machine already " "running the kernel Linux, and so on (@pxref{GNU Distribution})." msgstr "" #. type: enumerate #: doc/guix.texi:738 msgid "" "Make sure to download the associated @file{.sig} file and to verify the " "authenticity of the tarball against it, along these lines:" msgstr "" #. type: example #: doc/guix.texi:742 #, no-wrap msgid "" "$ wget @value{BASE-URL}/guix-binary-@value{VERSION}.x86_64-linux.tar.xz.sig\n" "$ gpg --verify guix-binary-@value{VERSION}.x86_64-linux.tar.xz.sig\n" msgstr "" #. type: Plain text #: doc/guix.texi:746 doc/guix.texi:2280 msgid "" "If that command fails because you do not have the required public key, then " "run this command to import it:" msgstr "" #. type: example #: doc/guix.texi:750 #, no-wrap msgid "" "$ wget '@value{OPENPGP-SIGNING-KEY-URL}' \\\n" " -qO - | gpg --import -\n" msgstr "" #. type: Plain text #: doc/guix.texi:754 doc/guix.texi:2288 msgid "and rerun the @code{gpg --verify} command." msgstr "" #. type: Plain text #: doc/guix.texi:757 doc/guix.texi:2291 msgid "" "Take note that a warning like ``This key is not certified with a trusted " "signature!'' is normal." msgstr "" #. type: enumerate #: doc/guix.texi:763 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 "" #. type: example #: doc/guix.texi:769 #, no-wrap msgid "" "# cd /tmp\n" "# tar --warning=no-timestamp -xf \\\n" " /path/to/guix-binary-@value{VERSION}.x86_64-linux.tar.xz\n" "# mv var/guix /var/ && mv gnu /\n" msgstr "" #. type: enumerate #: doc/guix.texi:774 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 "" #. type: enumerate #: doc/guix.texi:777 msgid "" "Do @emph{not} unpack the tarball on a working Guix system since that would " "overwrite its own essential files." msgstr "" #. type: enumerate #: doc/guix.texi:787 msgid "" "The @option{--warning=no-timestamp} option makes sure GNU@tie{}tar does not " "emit warnings about ``implausibly old time stamps'' (such warnings were " "triggered by GNU@tie{}tar 1.26 and older; recent versions are fine). They " "stem from the fact that all the files in the archive have their modification " "time set to 1 (which means January 1st, 1970). This is done on purpose to " "make sure the archive content is independent of its creation time, thus " "making it reproducible." msgstr "" #. type: enumerate #: doc/guix.texi:791 msgid "" "Make the profile available under @file{~root/.config/guix/current}, which is " "where @command{guix pull} will install updates (@pxref{Invoking guix pull}):" msgstr "" #. type: example #: doc/guix.texi:796 #, no-wrap msgid "" "# mkdir -p ~root/.config/guix\n" "# ln -sf /var/guix/profiles/per-user/root/current-guix \\\n" " ~root/.config/guix/current\n" msgstr "" #. type: enumerate #: doc/guix.texi:800 msgid "" "Source @file{etc/profile} to augment @env{PATH} and other relevant " "environment variables:" msgstr "" #. type: example #: doc/guix.texi:804 #, no-wrap msgid "" "# GUIX_PROFILE=\"`echo ~root`/.config/guix/current\" ; \\\n" " source $GUIX_PROFILE/etc/profile\n" msgstr "" #. type: enumerate #: doc/guix.texi:809 msgid "" "Create the group and user accounts for build users as explained below " "(@pxref{Build Environment Setup})." msgstr "" #. type: enumerate #: doc/guix.texi:812 msgid "Run the daemon, and set it to automatically start on boot." msgstr "" #. type: enumerate #: doc/guix.texi:815 msgid "" "If your host distro uses the systemd init system, this can be achieved with " "these commands:" msgstr "" #. type: example #: doc/guix.texi:828 #, no-wrap msgid "" "# cp ~root/.config/guix/current/lib/systemd/system/gnu-store.mount \\\n" " ~root/.config/guix/current/lib/systemd/system/guix-daemon.service \\\n" " /etc/systemd/system/\n" "# systemctl enable --now gnu-store.mount guix-daemon\n" msgstr "" #. type: enumerate #: doc/guix.texi:831 msgid "You may also want to arrange for @command{guix gc} to run periodically:" msgstr "" #. type: example #: doc/guix.texi:837 #, no-wrap msgid "" "# cp ~root/.config/guix/current/lib/systemd/system/guix-gc.service \\\n" " ~root/.config/guix/current/lib/systemd/system/guix-gc.timer \\\n" " /etc/systemd/system/\n" "# systemctl enable --now guix-gc.timer\n" msgstr "" #. type: enumerate #: doc/guix.texi:841 msgid "" "You may want to edit @file{guix-gc.service} to adjust the command line " "options to fit your needs (@pxref{Invoking guix gc})." msgstr "" #. type: itemize #: doc/guix.texi:843 doc/guix.texi:15300 msgid "If your host distro uses the Upstart init system:" msgstr "" #. type: example #: doc/guix.texi:849 #, no-wrap msgid "" "# initctl reload-configuration\n" "# cp ~root/.config/guix/current/lib/upstart/system/guix-daemon.conf \\\n" " /etc/init/\n" "# start guix-daemon\n" msgstr "" #. type: enumerate #: doc/guix.texi:852 msgid "Otherwise, you can still start the daemon manually with:" msgstr "" #. type: example #: doc/guix.texi:856 #, no-wrap msgid "" "# ~root/.config/guix/current/bin/guix-daemon \\\n" " --build-users-group=guixbuild\n" msgstr "" #. type: enumerate #: doc/guix.texi:861 msgid "" "Make the @command{guix} command available to other users on the machine, for " "instance with:" msgstr "" #. type: example #: doc/guix.texi:866 #, no-wrap msgid "" "# mkdir -p /usr/local/bin\n" "# cd /usr/local/bin\n" "# ln -s /var/guix/profiles/per-user/root/current-guix/bin/guix\n" msgstr "" #. type: enumerate #: doc/guix.texi:870 msgid "" "It is also a good idea to make the Info version of this manual available " "there:" msgstr "" #. type: example #: doc/guix.texi:876 #, 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/current-guix/share/info/* ;\n" " do ln -s $i ; done\n" msgstr "" #. type: enumerate #: doc/guix.texi:882 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 "" #. type: cindex #: doc/guix.texi:884 doc/guix.texi:4004 doc/guix.texi:18272 #, no-wrap msgid "substitutes, authorization thereof" msgstr "" #. type: enumerate #: doc/guix.texi:888 msgid "" "To use substitutes from @code{@value{SUBSTITUTE-SERVER-1}}, " "@code{@value{SUBSTITUTE-SERVER-2}} or a mirror (@pxref{Substitutes}), " "authorize them:" msgstr "" #. type: example #: doc/guix.texi:894 #, no-wrap msgid "" "# guix archive --authorize < \\\n" " ~root/.config/guix/current/share/guix/@value{SUBSTITUTE-SERVER-1}.pub\n" "# guix archive --authorize < \\\n" " ~root/.config/guix/current/share/guix/@value{SUBSTITUTE-SERVER-2}.pub\n" msgstr "" #. type: quotation #: doc/guix.texi:901 msgid "" "If you do not enable substitutes, Guix will end up building " "@emph{everything} from source on your machine, making each installation and " "upgrade very expensive. @xref{On Trusting Binaries}, for a discussion of " "reasons why one might want do disable substitutes." msgstr "" #. type: enumerate #: doc/guix.texi:906 msgid "" "Each user may need to perform a few additional steps to make their Guix " "environment ready for use, @pxref{Application Setup}." msgstr "" #. type: Plain text #: doc/guix.texi:909 msgid "Voilà, the installation is complete!" msgstr "" #. type: Plain text #: doc/guix.texi:912 msgid "" "You can confirm that Guix is working by installing a sample package into the " "root profile:" msgstr "" #. type: example #: doc/guix.texi:915 #, no-wrap msgid "# guix install hello\n" msgstr "" #. type: Plain text #: doc/guix.texi:919 msgid "" "The binary installation tarball can be (re)produced and verified simply by " "running the following command in the Guix source tree:" msgstr "" #. type: example #: doc/guix.texi:922 #, no-wrap msgid "make guix-binary.@var{system}.tar.xz\n" msgstr "" #. type: Plain text #: doc/guix.texi:926 msgid "...@: which, in turn, runs:" msgstr "" #. type: example #: doc/guix.texi:930 #, no-wrap msgid "" "guix pack -s @var{system} --localstatedir \\\n" " --profile-name=current-guix guix\n" msgstr "" #. type: Plain text #: doc/guix.texi:933 msgid "@xref{Invoking guix pack}, for more info on this handy tool." msgstr "" #. type: Plain text #: doc/guix.texi:941 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 "" #. type: cindex #: doc/guix.texi:942 #, no-wrap msgid "official website" msgstr "" #. type: Plain text #: doc/guix.texi:945 msgid "" "GNU Guix is available for download from its website at @url{https://www.gnu." "org/software/guix/}." msgstr "" #. type: Plain text #: doc/guix.texi:947 msgid "GNU Guix depends on the following packages:" msgstr "" #. type: item #: doc/guix.texi:949 #, no-wrap msgid "@url{https://gnu.org/software/guile/, GNU Guile}, version 3.0.x," msgstr "" #. type: itemize #: doc/guix.texi:951 msgid "version 3.0.3 or later;" msgstr "" #. type: item #: doc/guix.texi:951 #, no-wrap msgid "@url{https://notabug.org/cwebber/guile-gcrypt, Guile-Gcrypt}, version" msgstr "" #. type: itemize #: doc/guix.texi:953 msgid "0.1.0 or later;" msgstr "" #. type: itemize #: doc/guix.texi:959 msgid "" "@uref{https://gitlab.com/gnutls/guile/, Guile-GnuTLS} (@pxref{Guile " "Preparations, how to install the GnuTLS bindings for Guile,, gnutls-guile, " "GnuTLS-Guile})@footnote{The Guile bindings to @uref{https://gnutls.org/, " "GnuTLS} were distributed as part of GnuTLS until version 3.7.8 included.};" msgstr "" #. type: itemize #: doc/guix.texi:962 msgid "" "@uref{https://notabug.org/guile-sqlite3/guile-sqlite3, Guile-SQLite3}, " "version 0.1.0 or later;" msgstr "" #. type: item #: doc/guix.texi:962 #, no-wrap msgid "@uref{https://notabug.org/guile-zlib/guile-zlib, Guile-zlib}," msgstr "" #. type: itemize #: doc/guix.texi:964 msgid "version 0.1.0 or later;" msgstr "" #. type: item #: doc/guix.texi:964 #, no-wrap msgid "@uref{https://notabug.org/guile-lzlib/guile-lzlib, Guile-lzlib};" msgstr "" #. type: item #: doc/guix.texi:965 #, no-wrap msgid "@uref{https://www.nongnu.org/guile-avahi/, Guile-Avahi};" msgstr "" #. type: itemize #: doc/guix.texi:969 msgid "" "@uref{https://gitlab.com/guile-git/guile-git, Guile-Git}, version 0.5.0 or " "later;" msgstr "" #. type: item #: doc/guix.texi:969 #, no-wrap msgid "@uref{https://savannah.nongnu.org/projects/guile-json/, Guile-JSON}" msgstr "" #. type: itemize #: doc/guix.texi:971 msgid "4.3.0 or later;" msgstr "" #. type: item #: doc/guix.texi:971 #, no-wrap msgid "@url{https://www.gnu.org/software/make/, GNU Make}." msgstr "" #. type: Plain text #: doc/guix.texi:975 msgid "The following dependencies are optional:" msgstr "" #. type: itemize #: doc/guix.texi:983 msgid "" "Support for build offloading (@pxref{Daemon Offload Setup}) and " "@command{guix copy} (@pxref{Invoking guix copy}) depends on @uref{https://" "github.com/artyom-poptsov/guile-ssh, Guile-SSH}, version 0.13.0 or later." msgstr "" #. type: itemize #: doc/guix.texi:988 msgid "" "@uref{https://notabug.org/guile-zstd/guile-zstd, Guile-zstd}, for zstd " "compression and decompression in @command{guix publish} and for substitutes " "(@pxref{Invoking guix publish})." msgstr "" #. type: itemize #: doc/guix.texi:992 msgid "" "@uref{https://ngyro.com/software/guile-semver.html, Guile-Semver} for the " "@code{crate} importer (@pxref{Invoking guix import})." msgstr "" #. type: itemize #: doc/guix.texi:997 msgid "" "@uref{https://www.nongnu.org/guile-lib/doc/ref/htmlprag/, Guile-Lib} for the " "@code{go} importer (@pxref{Invoking guix import}) and for some of the " "``updaters'' (@pxref{Invoking guix refresh})." msgstr "" #. type: itemize #: doc/guix.texi:1001 msgid "" "When @url{http://www.bzip.org, libbz2} is available, @command{guix-daemon} " "can use it to compress build logs." msgstr "" #. type: Plain text #: doc/guix.texi:1005 msgid "" "Unless @option{--disable-daemon} was passed to @command{configure}, the " "following packages are also needed:" msgstr "" #. type: item #: doc/guix.texi:1007 #, no-wrap msgid "@url{https://gnupg.org/, GNU libgcrypt};" msgstr "" #. type: item #: doc/guix.texi:1008 #, no-wrap msgid "@url{https://sqlite.org, SQLite 3};" msgstr "" #. type: item #: doc/guix.texi:1009 #, no-wrap msgid "@url{https://gcc.gnu.org, GCC's g++}, with support for the" msgstr "" #. type: itemize #: doc/guix.texi:1011 msgid "C++11 standard." msgstr "" #. type: cindex #: doc/guix.texi:1013 #, no-wrap msgid "state directory" msgstr "" #. type: Plain text #: doc/guix.texi:1022 msgid "" "When configuring Guix on a system that already has a Guix installation, be " "sure to specify the same state directory as the existing installation using " "the @option{--localstatedir} option of the @command{configure} script " "(@pxref{Directory Variables, @code{localstatedir},, standards, GNU Coding " "Standards}). Usually, this @var{localstatedir} option is set to the value " "@file{/var}. The @command{configure} script protects against unintended " "misconfiguration of @var{localstatedir} so you do not inadvertently corrupt " "your store (@pxref{The Store})." msgstr "" #. type: cindex #: doc/guix.texi:1026 #, no-wrap msgid "test suite" msgstr "" #. type: Plain text #: doc/guix.texi:1032 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 "" #. type: example #: doc/guix.texi:1035 #, no-wrap msgid "make check\n" msgstr "" #. type: Plain text #: doc/guix.texi:1042 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 "" #. type: Plain text #: doc/guix.texi:1045 msgid "" "It is also possible to run a subset of the tests by defining the " "@code{TESTS} makefile variable as in this example:" msgstr "" #. type: example #: doc/guix.texi:1048 #, no-wrap msgid "make check TESTS=\"tests/store.scm tests/cpio.scm\"\n" msgstr "" #. type: Plain text #: doc/guix.texi:1053 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 "" #. type: example #: doc/guix.texi:1056 #, no-wrap msgid "make check TESTS=\"tests/base64.scm\" SCM_LOG_DRIVER_FLAGS=\"--brief=no\"\n" msgstr "" #. type: Plain text #: doc/guix.texi:1064 msgid "" "The underlying SRFI 64 custom Automake test driver used for the 'check' test " "suite (located at @file{build-aux/test-driver.scm}) also allows selecting " "which test cases to run at a finer level, via its @option{--select} and " "@option{--exclude} options. Here's an example, to run all the test cases " "from the @file{tests/packages.scm} test file whose names start with " "``transaction-upgrade-entry'':" msgstr "" #. type: example #: doc/guix.texi:1068 #, no-wrap msgid "" "export SCM_LOG_DRIVER_FLAGS=\"--select=^transaction-upgrade-entry\"\n" "make check TESTS=\"tests/packages.scm\"\n" msgstr "" #. type: Plain text #: doc/guix.texi:1074 msgid "" "Those wishing to inspect the results of failed tests directly from the " "command line can add the @option{--errors-only=yes} option to the " "@code{SCM_LOG_DRIVER_FLAGS} makefile variable and set the @code{VERBOSE} " "Automake makefile variable, as in:" msgstr "" #. type: example #: doc/guix.texi:1077 #, no-wrap msgid "make check SCM_LOG_DRIVER_FLAGS=\"--brief=no --errors-only=yes\" VERBOSE=1\n" msgstr "" #. type: Plain text #: doc/guix.texi:1082 msgid "" "The @option{--show-duration=yes} option can be used to print the duration of " "the individual test cases, when used in combination with @option{--brief=no}:" msgstr "" #. type: example #: doc/guix.texi:1085 #, no-wrap msgid "make check SCM_LOG_DRIVER_FLAGS=\"--brief=no --show-duration=yes\"\n" msgstr "" #. type: Plain text #: doc/guix.texi:1089 msgid "" "@xref{Parallel Test Harness,,,automake,GNU Automake} for more information " "about the Automake Parallel Test Harness." msgstr "" #. type: Plain text #: doc/guix.texi:1094 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 "" #. type: Plain text #: doc/guix.texi:1098 msgid "" "Guix also comes with a whole-system test suite that tests complete Guix " "System instances. It can only run on systems where Guix is already " "installed, using:" msgstr "" #. type: example #: doc/guix.texi:1101 #, no-wrap msgid "make check-system\n" msgstr "" #. type: Plain text #: doc/guix.texi:1105 msgid "or, again, by defining @code{TESTS} to select a subset of tests to run:" msgstr "" #. type: example #: doc/guix.texi:1108 #, no-wrap msgid "make check-system TESTS=\"basic mcron\"\n" msgstr "" #. type: Plain text #: doc/guix.texi:1116 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 "" #. type: Plain text #: doc/guix.texi:1119 msgid "" "Again in case of test failures, please send @email{bug-guix@@gnu.org} all " "the details." msgstr "" #. type: cindex #: doc/guix.texi:1123 #, no-wrap msgid "daemon" msgstr "" #. type: Plain text #: doc/guix.texi:1131 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 "" #. type: Plain text #: doc/guix.texi:1135 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 "" #. type: cindex #: doc/guix.texi:1145 doc/guix.texi:1617 #, no-wrap msgid "build environment" msgstr "" #. type: Plain text #: doc/guix.texi:1153 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 "" #. type: cindex #: doc/guix.texi:1154 #, no-wrap msgid "build users" msgstr "" #. type: Plain text #: doc/guix.texi:1165 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 "" #. type: Plain text #: doc/guix.texi:1168 msgid "" "On a GNU/Linux system, a build user pool may be created like this (using " "Bash syntax and the @code{shadow} commands):" msgstr "" #. type: example #: doc/guix.texi:1180 #, 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 "" #. type: Plain text #: doc/guix.texi:1190 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 "" #. type: Plain text #: doc/guix.texi:1199 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, " "copying the @file{@var{prefix}/lib/systemd/system/guix-daemon.service} file " "to @file{/etc/systemd/system} will ensure that @command{guix-daemon} is " "automatically started. Similarly, if your machine uses the Upstart init " "system, copy the @file{@var{prefix}/lib/upstart/system/guix-daemon.conf} " "file to @file{/etc/init}.}:" msgstr "" #. type: example #: doc/guix.texi:1202 doc/guix.texi:1606 #, no-wrap msgid "# guix-daemon --build-users-group=guixbuild\n" msgstr "" #. type: cindex #: doc/guix.texi:1204 doc/guix.texi:1615 #, no-wrap msgid "chroot" msgstr "" #. type: Plain text #: doc/guix.texi:1209 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 "" #. type: itemize #: doc/guix.texi:1217 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 "" #. type: itemize #: doc/guix.texi:1221 msgid "" "the @code{/proc} directory; it only shows the processes of the container " "since a separate PID name space is used;" msgstr "" #. type: itemize #: doc/guix.texi:1225 msgid "" "@file{/etc/passwd} with an entry for the current user and an entry for user " "@file{nobody};" msgstr "" #. type: itemize #: doc/guix.texi:1228 msgid "@file{/etc/group} with an entry for the user's group;" msgstr "" #. type: itemize #: doc/guix.texi:1232 msgid "" "@file{/etc/hosts} with an entry that maps @code{localhost} to " "@code{127.0.0.1};" msgstr "" #. type: itemize #: doc/guix.texi:1235 msgid "a writable @file{/tmp} directory." msgstr "" #. type: Plain text #: doc/guix.texi:1241 msgid "" "The chroot does not contain a @file{/home} directory, and the @env{HOME} " "environment variable is set to the non-existent @file{/homeless-shelter}. " "This helps to highlight inappropriate uses of @env{HOME} in the build " "scripts of packages." msgstr "" #. type: Plain text #: doc/guix.texi:1249 msgid "" "You can influence the directory where the daemon stores build trees @i{via} " "the @env{TMPDIR} environment variable. However, the build tree within the " "chroot is always called @file{/tmp/guix-build-@var{name}.drv-0}, where " "@var{name} is the derivation name---e.g., @code{coreutils-8.24}. This way, " "the value of @env{TMPDIR} does not leak inside build environments, which " "avoids discrepancies in cases where build processes capture the name of " "their build tree." msgstr "" #. type: vindex #: doc/guix.texi:1250 doc/guix.texi:4213 #, no-wrap msgid "http_proxy" msgstr "" #. type: vindex #: doc/guix.texi:1251 doc/guix.texi:4214 #, no-wrap msgid "https_proxy" msgstr "" #. type: Plain text #: doc/guix.texi:1256 msgid "" "The daemon also honors the @env{http_proxy} and @env{https_proxy} " "environment variables for HTTP and HTTPS downloads it performs, be it for " "fixed-output derivations (@pxref{Derivations}) or for substitutes " "(@pxref{Substitutes})." msgstr "" #. type: Plain text #: doc/guix.texi:1264 msgid "" "If you are installing Guix as an unprivileged user, it is still possible to " "run @command{guix-daemon} provided you pass @option{--disable-chroot}. " "However, build processes will not be isolated from one another, and not from " "the rest of the system. Thus, build processes may interfere with each " "other, and may access programs, libraries, and other files available on the " "system---making it much harder to view them as @emph{pure} functions." msgstr "" #. type: subsection #: doc/guix.texi:1267 #, no-wrap msgid "Using the Offload Facility" msgstr "" #. type: cindex #: doc/guix.texi:1269 doc/guix.texi:1676 #, no-wrap msgid "offloading" msgstr "" #. type: cindex #: doc/guix.texi:1270 #, no-wrap msgid "build hook" msgstr "" #. type: Plain text #: doc/guix.texi:1289 msgid "" "When desired, the build daemon can @dfn{offload} derivation builds to other " "machines running Guix, using the @code{offload} @dfn{build hook}" "@footnote{This feature is available only when @uref{https://github.com/" "artyom-poptsov/guile-ssh, Guile-SSH} is present.}. When that feature is " "enabled, a list of user-specified build machines is read from @file{/etc/" "guix/machines.scm}; every time a build is requested, for instance via " "@code{guix build}, the daemon attempts to offload it to one of the machines " "that satisfy the constraints of the derivation, in particular its system " "types---e.g., @code{x86_64-linux}. A single machine can have multiple " "system types, either because its architecture natively supports it, via " "emulation (@pxref{transparent-emulation-qemu, Transparent Emulation with " "QEMU}), or both. Missing prerequisites for the build are copied over SSH to " "the target machine, which then proceeds with the build; upon success the " "output(s) of the build are copied back to the initial machine. The offload " "facility comes with a basic scheduler that attempts to select the best " "machine. The best machine is chosen among the available machines based on " "criteria such as:" msgstr "" #. type: enumerate #: doc/guix.texi:1295 msgid "" "The availability of a build slot. A build machine can have as many build " "slots (connections) as the value of the @code{parallel-builds} field of its " "@code{build-machine} object." msgstr "" #. type: enumerate #: doc/guix.texi:1299 msgid "" "Its relative speed, as defined via the @code{speed} field of its @code{build-" "machine} object." msgstr "" #. type: enumerate #: doc/guix.texi:1304 msgid "" "Its load. The normalized machine load must be lower than a threshold value, " "configurable via the @code{overload-threshold} field of its @code{build-" "machine} object." msgstr "" #. type: enumerate #: doc/guix.texi:1307 msgid "Disk space availability. More than a 100 MiB must be available." msgstr "" #. type: Plain text #: doc/guix.texi:1310 msgid "The @file{/etc/guix/machines.scm} file typically looks like this:" msgstr "" #. type: lisp #: doc/guix.texi:1318 #, no-wrap msgid "" "(list (build-machine\n" " (name \"eightysix.example.org\")\n" " (systems (list \"x86_64-linux\" \"i686-linux\"))\n" " (host-key \"ssh-ed25519 AAAAC3Nza@dots{}\")\n" " (user \"bob\")\n" " (speed 2.)) ;incredibly fast!\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:1324 #, no-wrap msgid "" " (build-machine\n" " (name \"armeight.example.org\")\n" " (systems (list \"aarch64-linux\"))\n" " (host-key \"ssh-rsa AAAAB3Nza@dots{}\")\n" " (user \"alice\")\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:1328 #, no-wrap msgid "" " ;; Remember 'guix offload' is spawned by\n" " ;; 'guix-daemon' as root.\n" " (private-key \"/root/.ssh/identity-for-guix\")))\n" msgstr "" #. type: Plain text #: doc/guix.texi:1334 msgid "" "In the example above we specify a list of two build machines, one for the " "@code{x86_64} and @code{i686} architectures and one for the @code{aarch64} " "architecture." msgstr "" #. type: Plain text #: doc/guix.texi:1343 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 "" #. type: deftp #: doc/guix.texi:1344 #, no-wrap msgid "{Data Type} build-machine" msgstr "" #. type: deftp #: doc/guix.texi:1347 msgid "" "This data type represents build machines to which the daemon may offload " "builds. The important fields are:" msgstr "" #. type: code{#1} #: doc/guix.texi:1350 doc/guix.texi:7543 doc/guix.texi:8445 doc/guix.texi:17205 #: doc/guix.texi:17304 doc/guix.texi:17545 doc/guix.texi:19467 #: doc/guix.texi:20090 doc/guix.texi:20336 doc/guix.texi:24154 #: doc/guix.texi:27077 doc/guix.texi:28381 doc/guix.texi:28993 #: doc/guix.texi:29355 doc/guix.texi:29399 doc/guix.texi:31565 #: doc/guix.texi:34090 doc/guix.texi:34128 doc/guix.texi:36929 #: doc/guix.texi:36946 doc/guix.texi:37737 doc/guix.texi:39658 #: doc/guix.texi:39985 doc/guix.texi:42454 #, no-wrap msgid "name" msgstr "" #. type: table #: doc/guix.texi:1352 msgid "The host name of the remote machine." msgstr "" #. type: item #: doc/guix.texi:1353 #, no-wrap msgid "systems" msgstr "" #. type: table #: doc/guix.texi:1356 msgid "" "The system types the remote machine supports---e.g., @code{(list \"x86_64-" "linux\" \"i686-linux\")}." msgstr "" #. type: code{#1} #: doc/guix.texi:1357 doc/guix.texi:20100 #, no-wrap msgid "user" msgstr "" #. type: table #: doc/guix.texi:1361 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 "" #. type: item #: doc/guix.texi:1362 #, no-wrap msgid "host-key" msgstr "" #. type: table #: doc/guix.texi:1366 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 "" #. type: example #: doc/guix.texi:1369 #, no-wrap msgid "ssh-ed25519 AAAAC3NzaC@dots{}mde+UhL hint@@example.org\n" msgstr "" #. type: table #: doc/guix.texi:1374 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 "" #. type: table #: doc/guix.texi:1379 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 "" #. type: example #: doc/guix.texi:1383 #, no-wrap msgid "" "$ lsh-export-key --openssh < /etc/lsh/host-key.pub\n" "ssh-rsa AAAAB3NzaC1yc2EAAAAEOp8FoQAAAQEAs1eB46LV@dots{}\n" msgstr "" #. type: deftp #: doc/guix.texi:1388 msgid "A number of optional fields may be specified:" msgstr "" #. type: item #: doc/guix.texi:1391 doc/guix.texi:39133 #, no-wrap msgid "@code{port} (default: @code{22})" msgstr "" #. type: table #: doc/guix.texi:1393 msgid "Port number of SSH server on the machine." msgstr "" #. type: item #: doc/guix.texi:1394 #, no-wrap msgid "@code{private-key} (default: @file{~root/.ssh/id_rsa})" msgstr "" #. type: table #: doc/guix.texi:1397 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." msgstr "" #. type: table #: doc/guix.texi:1400 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 "" #. type: item #: doc/guix.texi:1401 #, no-wrap msgid "@code{compression} (default: @code{\"zlib@@openssh.com,zlib\"})" msgstr "" #. type: itemx #: doc/guix.texi:1402 #, no-wrap msgid "@code{compression-level} (default: @code{3})" msgstr "" #. type: table #: doc/guix.texi:1404 msgid "The SSH-level compression methods and compression level requested." msgstr "" #. type: table #: doc/guix.texi:1407 msgid "" "Note that offloading relies on SSH compression to reduce bandwidth usage " "when transferring files to and from build machines." msgstr "" #. type: item #: doc/guix.texi:1408 #, no-wrap msgid "@code{daemon-socket} (default: @code{\"/var/guix/daemon-socket/socket\"})" msgstr "" #. type: table #: doc/guix.texi:1411 msgid "" "File name of the Unix-domain socket @command{guix-daemon} is listening to on " "that machine." msgstr "" #. type: item #: doc/guix.texi:1412 #, no-wrap msgid "@code{overload-threshold} (default: @code{0.8})" msgstr "" #. type: table #: doc/guix.texi:1418 msgid "" "The load threshold above which a potential offload machine is disregarded by " "the offload scheduler. The value roughly translates to the total processor " "usage of the build machine, ranging from 0.0 (0%) to 1.0 (100%). It can " "also be disabled by setting @code{overload-threshold} to @code{#f}." msgstr "" #. type: item #: doc/guix.texi:1419 #, no-wrap msgid "@code{parallel-builds} (default: @code{1})" msgstr "" #. type: table #: doc/guix.texi:1421 msgid "The number of builds that may run in parallel on the machine." msgstr "" #. type: item #: doc/guix.texi:1422 #, no-wrap msgid "@code{speed} (default: @code{1.0})" msgstr "" #. type: table #: doc/guix.texi:1425 msgid "" "A ``relative speed factor''. The offload scheduler will tend to prefer " "machines with a higher speed factor." msgstr "" #. type: item #: doc/guix.texi:1426 #, no-wrap msgid "@code{features} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:1431 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 "" #. type: Plain text #: doc/guix.texi:1437 msgid "" "The @command{guix} command must be in the search path on the build " "machines. You can check whether this is the case by running:" msgstr "" #. type: example #: doc/guix.texi:1440 #, no-wrap msgid "ssh build-machine guix repl --version\n" msgstr "" #. type: Plain text #: doc/guix.texi:1447 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 "" #. type: example #: doc/guix.texi:1450 doc/guix.texi:39037 #, no-wrap msgid "# guix archive --generate-key\n" msgstr "" #. type: Plain text #: doc/guix.texi:1455 msgid "" "Each build machine must authorize the key of the master machine so that it " "accepts store items it receives from the master:" msgstr "" #. type: example #: doc/guix.texi:1458 #, no-wrap msgid "# guix archive --authorize < master-public-key.txt\n" msgstr "" #. type: Plain text #: doc/guix.texi:1462 msgid "" "Likewise, the master machine must authorize the key of each build machine." msgstr "" #. type: Plain text #: doc/guix.texi:1468 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 "" #. type: cindex #: doc/guix.texi:1469 #, no-wrap msgid "offload test" msgstr "" #. type: Plain text #: doc/guix.texi:1472 msgid "" "To test whether your setup is operational, run this command on the master " "node:" msgstr "" #. type: example #: doc/guix.texi:1475 #, no-wrap msgid "# guix offload test\n" msgstr "" #. type: Plain text #: doc/guix.texi:1481 msgid "" "This will attempt to connect to each of the build machines specified in " "@file{/etc/guix/machines.scm}, make sure Guix is available on each machine, " "attempt to export to the machine and import from it, and report any error in " "the process." msgstr "" #. type: Plain text #: doc/guix.texi:1484 msgid "" "If you want to test a different machine file, just specify it on the command " "line:" msgstr "" #. type: example #: doc/guix.texi:1487 #, no-wrap msgid "# guix offload test machines-qualif.scm\n" msgstr "" #. type: Plain text #: doc/guix.texi:1491 msgid "" "Last, you can test the subset of the machines whose name matches a regular " "expression like this:" msgstr "" #. type: example #: doc/guix.texi:1494 #, no-wrap msgid "# guix offload test machines.scm '\\.gnu\\.org$'\n" msgstr "" #. type: cindex #: doc/guix.texi:1496 #, no-wrap msgid "offload status" msgstr "" #. type: Plain text #: doc/guix.texi:1499 msgid "" "To display the current load of all build hosts, run this command on the main " "node:" msgstr "" #. type: example #: doc/guix.texi:1502 #, no-wrap msgid "# guix offload status\n" msgstr "" #. type: cindex #: doc/guix.texi:1508 #, no-wrap msgid "SELinux, daemon policy" msgstr "" #. type: cindex #: doc/guix.texi:1509 #, no-wrap msgid "mandatory access control, SELinux" msgstr "" #. type: cindex #: doc/guix.texi:1510 #, no-wrap msgid "security, guix-daemon" msgstr "" #. type: Plain text #: doc/guix.texi:1516 msgid "" "Guix includes an SELinux policy file at @file{etc/guix-daemon.cil} that can " "be installed on a system where SELinux is enabled, in order to label Guix " "files and to specify the expected behavior of the daemon. Since Guix System " "does not provide an SELinux base policy, the daemon policy cannot be used on " "Guix System." msgstr "" #. type: subsubsection #: doc/guix.texi:1517 #, no-wrap msgid "Installing the SELinux policy" msgstr "" #. type: cindex #: doc/guix.texi:1518 #, no-wrap msgid "SELinux, policy installation" msgstr "" #. type: Plain text #: doc/guix.texi:1520 msgid "To install the policy run this command as root:" msgstr "" #. type: example #: doc/guix.texi:1523 #, no-wrap msgid "semodule -i etc/guix-daemon.cil\n" msgstr "" #. type: Plain text #: doc/guix.texi:1527 msgid "" "Then relabel the file system with @code{restorecon} or by a different " "mechanism provided by your system." msgstr "" #. type: Plain text #: doc/guix.texi:1532 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 "" #. type: example #: doc/guix.texi:1535 #, no-wrap msgid "ps -Zax | grep guix-daemon\n" msgstr "" #. type: Plain text #: doc/guix.texi:1540 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 "" #. type: cindex #: doc/guix.texi:1542 #, no-wrap msgid "SELinux, limitations" msgstr "" #. type: Plain text #: doc/guix.texi:1547 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 "" #. type: enumerate #: doc/guix.texi:1554 msgid "" "@code{guix_daemon_socket_t} isn’t actually used. None of the socket " "operations involve contexts that have anything to do with " "@code{guix_daemon_socket_t}. It doesn’t hurt to have this unused label, but " "it would be preferable to define socket rules for only this label." msgstr "" #. type: enumerate #: doc/guix.texi:1565 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 "" #. type: enumerate #: doc/guix.texi:1570 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 "" #. type: enumerate #: doc/guix.texi:1581 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 "" #. type: enumerate #: doc/guix.texi:1586 msgid "" "You will need to relabel the store directory after all upgrades to " "@file{guix-daemon}, such as after running @code{guix pull}. Assuming the " "store is in @file{/gnu}, you can do this with @code{restorecon -vR /gnu}, or " "by other means provided by your operating system." msgstr "" #. type: enumerate #: doc/guix.texi:1594 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 "" #. type: section #: doc/guix.texi:1597 #, no-wrap msgid "Invoking @command{guix-daemon}" msgstr "" #. type: command{#1} #: doc/guix.texi:1598 #, no-wrap msgid "guix-daemon" msgstr "" #. type: Plain text #: doc/guix.texi:1603 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 "" #. type: cindex #: doc/guix.texi:1608 #, no-wrap msgid "socket activation, for @command{guix-daemon}" msgstr "" #. type: Plain text #: doc/guix.texi:1612 msgid "" "This daemon can also be started following the systemd ``socket activation'' " "protocol (@pxref{Service De- and Constructors, @code{make-systemd-" "constructor},, shepherd, The GNU Shepherd Manual})." msgstr "" #. type: Plain text #: doc/guix.texi:1614 msgid "For details on how to set it up, @pxref{Setting Up the Daemon}." msgstr "" #. type: cindex #: doc/guix.texi:1616 #, no-wrap msgid "container, build environment" msgstr "" #. type: cindex #: doc/guix.texi:1618 doc/guix.texi:3293 doc/guix.texi:4194 doc/guix.texi:15313 #, no-wrap msgid "reproducible builds" msgstr "" #. type: Plain text #: doc/guix.texi:1630 msgid "" "By default, @command{guix-daemon} launches build processes under different " "UIDs, taken from the build group specified with @option{--build-users-" "group}. In addition, each build process is run in a chroot environment that " "only contains the subset of the store that the build process depends on, as " "specified by its derivation (@pxref{Programming Interface, derivation}), " "plus a set of specific system directories. By default, the latter contains " "@file{/dev} and @file{/dev/pts}. Furthermore, on GNU/Linux, the build " "environment is a @dfn{container}: in addition to having its own file system " "tree, it has a separate mount name space, its own PID name space, network " "name space, etc. This helps achieve reproducible builds (@pxref{Features})." msgstr "" #. type: Plain text #: doc/guix.texi:1636 msgid "" "When the daemon performs a build on behalf of the user, it creates a build " "directory under @file{/tmp} or under the directory specified by its " "@env{TMPDIR} environment variable. This directory is shared with the " "container for the duration of the build, though within the container, the " "build tree is always called @file{/tmp/guix-build-@var{name}.drv-0}." msgstr "" #. type: Plain text #: doc/guix.texi:1640 msgid "" "The build directory is automatically deleted upon completion, unless the " "build failed and the client specified @option{--keep-failed} (@pxref{Common " "Build Options, @option{--keep-failed}})." msgstr "" #. type: Plain text #: doc/guix.texi:1646 msgid "" "The daemon listens for connections and spawns one sub-process for each " "session started by a client (one of the @command{guix} sub-commands). The " "@command{guix processes} command allows you to get an overview of the " "activity on your system by viewing each of the active sessions and clients. " "@xref{Invoking guix processes}, for more information." msgstr "" #. type: Plain text #: doc/guix.texi:1648 msgid "The following command-line options are supported:" msgstr "" #. type: item #: doc/guix.texi:1650 #, no-wrap msgid "--build-users-group=@var{group}" msgstr "" #. type: table #: doc/guix.texi:1653 msgid "" "Take users from @var{group} to run build processes (@pxref{Setting Up the " "Daemon, build users})." msgstr "" #. type: item #: doc/guix.texi:1654 doc/guix.texi:12319 #, no-wrap msgid "--no-substitutes" msgstr "" #. type: cindex #: doc/guix.texi:1655 doc/guix.texi:3305 doc/guix.texi:3947 #, no-wrap msgid "substitutes" msgstr "" #. type: table #: doc/guix.texi:1659 doc/guix.texi:12323 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 "" #. type: table #: doc/guix.texi:1663 msgid "" "When the daemon runs with @option{--no-substitutes}, clients can still " "explicitly enable substitution @i{via} the @code{set-build-options} remote " "procedure call (@pxref{The Store})." msgstr "" #. type: anchor{#1} #: doc/guix.texi:1665 msgid "daemon-substitute-urls" msgstr "" #. type: item #: doc/guix.texi:1665 doc/guix.texi:12306 doc/guix.texi:14715 #: doc/guix.texi:15465 doc/guix.texi:15692 #, no-wrap msgid "--substitute-urls=@var{urls}" msgstr "" #. type: table #: doc/guix.texi:1669 msgid "" "Consider @var{urls} the default whitespace-separated list of substitute " "source URLs. When this option is omitted, @indicateurl{@value{SUBSTITUTE-" "URLS}} is used." msgstr "" #. type: table #: doc/guix.texi:1672 msgid "" "This means that substitutes may be downloaded from @var{urls}, as long as " "they are signed by a trusted signature (@pxref{Substitutes})." msgstr "" #. type: table #: doc/guix.texi:1675 msgid "" "@xref{Getting Substitutes from Other Servers}, for more information on how " "to configure the daemon to get substitutes from other servers." msgstr "" #. type: item #: doc/guix.texi:1677 doc/guix.texi:12342 #, no-wrap msgid "--no-offload" msgstr "" #. type: table #: doc/guix.texi:1681 doc/guix.texi:12346 msgid "" "Do not use offload builds to other machines (@pxref{Daemon Offload Setup}). " "That is, always build things locally instead of offloading builds to remote " "machines." msgstr "" #. type: item #: doc/guix.texi:1682 #, no-wrap msgid "--cache-failures" msgstr "" #. type: table #: doc/guix.texi:1684 msgid "Cache build failures. By default, only successful builds are cached." msgstr "" #. type: table #: doc/guix.texi:1689 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 "" #. type: item #: doc/guix.texi:1690 doc/guix.texi:12372 #, no-wrap msgid "--cores=@var{n}" msgstr "" #. type: itemx #: doc/guix.texi:1691 doc/guix.texi:12373 #, no-wrap msgid "-c @var{n}" msgstr "" #. type: table #: doc/guix.texi:1694 msgid "" "Use @var{n} CPU cores to build each derivation; @code{0} means as many as " "available." msgstr "" #. type: table #: doc/guix.texi:1698 msgid "" "The default value is @code{0}, but it may be overridden by clients, such as " "the @option{--cores} option of @command{guix build} (@pxref{Invoking guix " "build})." msgstr "" #. type: table #: doc/guix.texi:1702 msgid "" "The effect is to define the @env{NIX_BUILD_CORES} environment variable in " "the build process, which can then use it to exploit internal parallelism---" "for instance, by running @code{make -j$NIX_BUILD_CORES}." msgstr "" #. type: item #: doc/guix.texi:1703 doc/guix.texi:12377 #, no-wrap msgid "--max-jobs=@var{n}" msgstr "" #. type: itemx #: doc/guix.texi:1704 doc/guix.texi:12378 #, no-wrap msgid "-M @var{n}" msgstr "" #. type: table #: doc/guix.texi:1709 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 "" #. type: item #: doc/guix.texi:1710 doc/guix.texi:12347 #, no-wrap msgid "--max-silent-time=@var{seconds}" msgstr "" #. type: table #: doc/guix.texi:1713 doc/guix.texi:12350 msgid "" "When the build or substitution process remains silent for more than " "@var{seconds}, terminate it and report a build failure." msgstr "" #. type: table #: doc/guix.texi:1715 doc/guix.texi:1724 msgid "The default value is @code{0}, which disables the timeout." msgstr "" #. type: table #: doc/guix.texi:1718 msgid "" "The value specified here can be overridden by clients (@pxref{Common Build " "Options, @option{--max-silent-time}})." msgstr "" #. type: item #: doc/guix.texi:1719 doc/guix.texi:12354 #, no-wrap msgid "--timeout=@var{seconds}" msgstr "" #. type: table #: doc/guix.texi:1722 doc/guix.texi:12357 msgid "" "Likewise, when the build or substitution process lasts for more than " "@var{seconds}, terminate it and report a build failure." msgstr "" #. type: table #: doc/guix.texi:1727 msgid "" "The value specified here can be overridden by clients (@pxref{Common Build " "Options, @option{--timeout}})." msgstr "" #. type: item #: doc/guix.texi:1728 #, no-wrap msgid "--rounds=@var{N}" msgstr "" #. type: table #: doc/guix.texi:1733 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 "" #. type: table #: doc/guix.texi:1737 doc/guix.texi:12341 doc/guix.texi:12974 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 "" #. type: item #: doc/guix.texi:1738 #, no-wrap msgid "--debug" msgstr "" #. type: table #: doc/guix.texi:1740 msgid "Produce debugging output." msgstr "" #. type: table #: doc/guix.texi:1744 msgid "" "This is useful to debug daemon start-up issues, but then it may be " "overridden by clients, for example the @option{--verbosity} option of " "@command{guix build} (@pxref{Invoking guix build})." msgstr "" #. type: item #: doc/guix.texi:1745 #, no-wrap msgid "--chroot-directory=@var{dir}" msgstr "" #. type: table #: doc/guix.texi:1747 msgid "Add @var{dir} to the build chroot." msgstr "" #. type: table #: doc/guix.texi:1753 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 "" #. type: item #: doc/guix.texi:1754 #, no-wrap msgid "--disable-chroot" msgstr "" #. type: table #: doc/guix.texi:1756 msgid "Disable chroot builds." msgstr "" #. type: table #: doc/guix.texi:1761 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 "" #. type: item #: doc/guix.texi:1762 #, no-wrap msgid "--log-compression=@var{type}" msgstr "" #. type: table #: doc/guix.texi:1765 msgid "" "Compress build logs according to @var{type}, one of @code{gzip}, " "@code{bzip2}, or @code{none}." msgstr "" #. type: table #: doc/guix.texi:1769 msgid "" "Unless @option{--lose-logs} is used, all the build logs are kept in the " "@var{localstatedir}. To save space, the daemon automatically compresses " "them with gzip by default." msgstr "" #. type: item #: doc/guix.texi:1770 #, no-wrap msgid "--discover[=yes|no]" msgstr "" #. type: table #: doc/guix.texi:1773 doc/guix.texi:18353 msgid "" "Whether to discover substitute servers on the local network using mDNS and " "DNS-SD." msgstr "" #. type: table #: doc/guix.texi:1776 msgid "" "This feature is still experimental. However, here are a few considerations." msgstr "" #. type: enumerate #: doc/guix.texi:1780 msgid "It might be faster/less expensive than fetching from remote servers;" msgstr "" #. type: enumerate #: doc/guix.texi:1783 msgid "" "There are no security risks, only genuine substitutes will be used " "(@pxref{Substitute Authentication});" msgstr "" #. type: enumerate #: doc/guix.texi:1787 msgid "" "An attacker advertising @command{guix publish} on your LAN cannot serve you " "malicious binaries, but they can learn what software you’re installing;" msgstr "" #. type: enumerate #: doc/guix.texi:1790 msgid "" "Servers may serve substitute over HTTP, unencrypted, so anyone on the LAN " "can see what software you’re installing." msgstr "" #. type: table #: doc/guix.texi:1794 msgid "" "It is also possible to enable or disable substitute server discovery at run-" "time by running:" msgstr "" #. type: example #: doc/guix.texi:1798 #, no-wrap msgid "" "herd discover guix-daemon on\n" "herd discover guix-daemon off\n" msgstr "" #. type: item #: doc/guix.texi:1800 #, no-wrap msgid "--disable-deduplication" msgstr "" #. type: cindex #: doc/guix.texi:1801 doc/guix.texi:4534 #, no-wrap msgid "deduplication" msgstr "" #. type: table #: doc/guix.texi:1803 msgid "Disable automatic file ``deduplication'' in the store." msgstr "" #. type: table #: doc/guix.texi:1810 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 "" #. type: item #: doc/guix.texi:1811 #, no-wrap msgid "--gc-keep-outputs[=yes|no]" msgstr "" #. type: table #: doc/guix.texi:1814 msgid "" "Tell whether the garbage collector (GC) must keep outputs of live " "derivations." msgstr "" #. type: cindex #: doc/guix.texi:1815 doc/guix.texi:4346 #, no-wrap msgid "GC roots" msgstr "" #. type: cindex #: doc/guix.texi:1816 doc/guix.texi:4347 #, no-wrap msgid "garbage collector roots" msgstr "" #. type: table #: doc/guix.texi:1822 msgid "" "When set to @code{yes}, the GC will keep the outputs of any live derivation " "available in the store---the @file{.drv} files. The default is @code{no}, " "meaning that derivation outputs are kept only if they are reachable from a " "GC root. @xref{Invoking guix gc}, for more on GC roots." msgstr "" #. type: item #: doc/guix.texi:1823 #, no-wrap msgid "--gc-keep-derivations[=yes|no]" msgstr "" #. type: table #: doc/guix.texi:1826 msgid "" "Tell whether the garbage collector (GC) must keep derivations corresponding " "to live outputs." msgstr "" #. type: table #: doc/guix.texi:1832 msgid "" "When set to @code{yes}, as is the case by default, the GC keeps " "derivations---i.e., @file{.drv} files---as long as at least one of their " "outputs is live. This allows users to keep track of the origins of items in " "their store. Setting it to @code{no} saves a bit of disk space." msgstr "" #. type: table #: doc/guix.texi:1841 msgid "" "In this way, setting @option{--gc-keep-derivations} to @code{yes} causes " "liveness to flow from outputs to derivations, and setting @option{--gc-keep-" "outputs} to @code{yes} causes liveness to flow from derivations to outputs. " "When both are set to @code{yes}, the effect is to keep all the build " "prerequisites (the sources, compiler, libraries, and other build-time tools) " "of live objects in the store, regardless of whether these prerequisites are " "reachable from a GC root. This is convenient for developers since it saves " "rebuilds or downloads." msgstr "" #. type: item #: doc/guix.texi:1842 #, no-wrap msgid "--impersonate-linux-2.6" msgstr "" #. type: table #: doc/guix.texi:1845 msgid "" "On Linux-based systems, impersonate Linux 2.6. This means that the kernel's " "@command{uname} system call will report 2.6 as the release number." msgstr "" #. type: table #: doc/guix.texi:1848 msgid "" "This might be helpful to build programs that (usually wrongfully) depend on " "the kernel version number." msgstr "" #. type: item #: doc/guix.texi:1849 #, no-wrap msgid "--lose-logs" msgstr "" #. type: table #: doc/guix.texi:1852 msgid "" "Do not keep build logs. By default they are kept under " "@file{@var{localstatedir}/guix/log}." msgstr "" #. type: item #: doc/guix.texi:1853 doc/guix.texi:4791 doc/guix.texi:6175 doc/guix.texi:6621 #: doc/guix.texi:7045 doc/guix.texi:12910 doc/guix.texi:14742 #: doc/guix.texi:15007 doc/guix.texi:15697 doc/guix.texi:38745 #, no-wrap msgid "--system=@var{system}" msgstr "" #. type: table #: doc/guix.texi:1857 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 "" #. type: item #: doc/guix.texi:1858 doc/guix.texi:12025 #, no-wrap msgid "--listen=@var{endpoint}" msgstr "" #. type: table #: doc/guix.texi:1863 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 "" #. type: item #: doc/guix.texi:1865 #, no-wrap msgid "--listen=/gnu/var/daemon" msgstr "" #. type: table #: doc/guix.texi:1868 msgid "" "Listen for connections on the @file{/gnu/var/daemon} Unix-domain socket, " "creating it if needed." msgstr "" #. type: item #: doc/guix.texi:1869 #, no-wrap msgid "--listen=localhost" msgstr "" #. type: cindex #: doc/guix.texi:1870 doc/guix.texi:10694 #, no-wrap msgid "daemon, remote access" msgstr "" #. type: cindex #: doc/guix.texi:1871 doc/guix.texi:10695 #, no-wrap msgid "remote access to the daemon" msgstr "" #. type: cindex #: doc/guix.texi:1872 doc/guix.texi:10696 #, no-wrap msgid "daemon, cluster setup" msgstr "" #. type: cindex #: doc/guix.texi:1873 doc/guix.texi:10697 #, no-wrap msgid "clusters, daemon setup" msgstr "" #. type: table #: doc/guix.texi:1876 msgid "" "Listen for TCP connections on the network interface corresponding to " "@code{localhost}, on port 44146." msgstr "" #. type: item #: doc/guix.texi:1877 #, no-wrap msgid "--listen=128.0.0.42:1234" msgstr "" #. type: table #: doc/guix.texi:1880 msgid "" "Listen for TCP connections on the network interface corresponding to " "@code{128.0.0.42}, on port 1234." msgstr "" #. type: table #: doc/guix.texi:1887 msgid "" "This option can be repeated multiple times, in which case @command{guix-" "daemon} accepts connections on all the specified endpoints. Users can tell " "client commands what endpoint to connect to by setting the " "@env{GUIX_DAEMON_SOCKET} environment variable (@pxref{The Store, " "@env{GUIX_DAEMON_SOCKET}})." msgstr "" #. type: quotation #: doc/guix.texi:1894 msgid "" "The daemon protocol is @emph{unauthenticated and unencrypted}. Using " "@option{--listen=@var{host}} is suitable on local networks, such as " "clusters, where only trusted nodes may connect to the build daemon. In " "other cases where remote access to the daemon is needed, we recommend using " "Unix-domain sockets along with SSH." msgstr "" #. type: table #: doc/guix.texi:1899 msgid "" "When @option{--listen} is omitted, @command{guix-daemon} listens for " "connections on the Unix-domain socket located at @file{@var{localstatedir}/" "guix/daemon-socket/socket}." msgstr "" #. type: Plain text #: doc/guix.texi:1909 msgid "" "When using Guix on top of GNU/Linux distribution other than Guix System---a " "so-called @dfn{foreign distro}---a few additional steps are needed to get " "everything in place. Here are some of them." msgstr "" #. type: anchor{#1} #: doc/guix.texi:1913 msgid "locales-and-locpath" msgstr "" #. type: cindex #: doc/guix.texi:1913 #, no-wrap msgid "locales, when not on Guix System" msgstr "" #. type: vindex #: doc/guix.texi:1914 doc/guix.texi:17529 #, no-wrap msgid "LOCPATH" msgstr "" #. type: vindex #: doc/guix.texi:1915 #, no-wrap msgid "GUIX_LOCPATH" msgstr "" #. type: Plain text #: doc/guix.texi:1920 msgid "" "Packages installed @i{via} Guix will not use the locale data of the host " "system. Instead, you must first install one of the locale packages " "available with Guix and then define the @env{GUIX_LOCPATH} environment " "variable:" msgstr "" #. type: example #: doc/guix.texi:1924 #, no-wrap msgid "" "$ guix install glibc-locales\n" "$ export GUIX_LOCPATH=$HOME/.guix-profile/lib/locale\n" msgstr "" #. type: Plain text #: doc/guix.texi:1936 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 930@tie{}" "MiB@footnote{The size of the @code{glibc-locales} package is reduced down to " "about 213@tie{}MiB with store deduplication and further down to about " "67@tie{}MiB when using a zstd-compressed Btrfs file system.}. If you only " "need a few locales, you can define your custom locales package via the " "@code{make-glibc-utf8-locales} procedure from the @code{(gnu packages base)} " "module. The following example defines a package containing the various " "Canadian UTF-8 locales known to the GNU@tie{}libc, that weighs around " "14@tie{}MiB:" msgstr "" #. type: lisp #: doc/guix.texi:1939 #, no-wrap msgid "" "(use-modules (gnu packages base))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:1945 #, no-wrap msgid "" "(define my-glibc-locales\n" " (make-glibc-utf8-locales\n" " glibc\n" " #:locales (list \"en_CA\" \"fr_CA\" \"ik_CA\" \"iu_CA\" \"shs_CA\")\n" " #:name \"glibc-canadian-utf8-locales\"))\n" msgstr "" #. type: Plain text #: doc/guix.texi:1950 msgid "" "The @env{GUIX_LOCPATH} variable plays a role similar to @env{LOCPATH} " "(@pxref{Locale Names, @env{LOCPATH},, libc, The GNU C Library Reference " "Manual}). There are two important differences though:" msgstr "" #. type: enumerate #: doc/guix.texi:1957 msgid "" "@env{GUIX_LOCPATH} is honored only by the libc in Guix, and not by the libc " "provided by foreign distros. Thus, using @env{GUIX_LOCPATH} allows you to " "make sure the programs of the foreign distro will not end up loading " "incompatible locale data." msgstr "" #. type: enumerate #: doc/guix.texi:1964 msgid "" "libc suffixes each entry of @env{GUIX_LOCPATH} with @code{/X.Y}, where " "@code{X.Y} is the libc version---e.g., @code{2.22}. This means that, should " "your Guix profile contain a mixture of programs linked against different " "libc version, each libc version will only try to load locale data in the " "right format." msgstr "" #. type: Plain text #: doc/guix.texi:1968 msgid "" "This is important because the locale data format used by different libc " "versions may be incompatible." msgstr "" #. type: cindex #: doc/guix.texi:1971 #, no-wrap msgid "name service switch, glibc" msgstr "" #. type: cindex #: doc/guix.texi:1972 #, no-wrap msgid "NSS (name service switch), glibc" msgstr "" #. type: cindex #: doc/guix.texi:1973 #, no-wrap msgid "nscd (name service caching daemon)" msgstr "" #. type: cindex #: doc/guix.texi:1974 #, no-wrap msgid "name service caching daemon (nscd)" msgstr "" #. type: Plain text #: doc/guix.texi:1981 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 "" #. type: file{#1} #: doc/guix.texi:1982 #, no-wrap msgid "nsswitch.conf" msgstr "" #. type: Plain text #: doc/guix.texi:1987 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 "" #. type: cindex #: doc/guix.texi:1988 #, no-wrap msgid "Network information service (NIS)" msgstr "" #. type: cindex #: doc/guix.texi:1989 #, no-wrap msgid "NIS (Network information service)" msgstr "" #. type: Plain text #: doc/guix.texi:1998 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 "" #. type: Plain text #: doc/guix.texi:2008 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 "" #. type: Plain text #: doc/guix.texi:2013 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 "" #. type: Plain text #: doc/guix.texi:2018 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 "" #. type: subsection #: doc/guix.texi:2019 #, no-wrap msgid "X11 Fonts" msgstr "" #. type: cindex #: doc/guix.texi:2021 doc/contributing.texi:1016 #, no-wrap msgid "fonts" msgstr "" #. type: Plain text #: doc/guix.texi:2029 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{font-ghostscript}, @code{font-dejavu}, and @code{font-gnu-freefont}." msgstr "" #. type: code{#1} #: doc/guix.texi:2030 #, no-wrap msgid "fc-cache" msgstr "" #. type: cindex #: doc/guix.texi:2031 #, no-wrap msgid "font cache" msgstr "" #. type: Plain text #: doc/guix.texi:2035 msgid "" "Once you have installed or removed fonts, or when you notice an application " "that does not find fonts, you may need to install Fontconfig and to force an " "update of its font cache by running:" msgstr "" #. type: example #: doc/guix.texi:2039 #, no-wrap msgid "" "guix install fontconfig\n" "fc-cache -rv\n" msgstr "" #. type: Plain text #: doc/guix.texi:2047 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 "" #. type: example #: doc/guix.texi:2050 #, no-wrap msgid "guix install font-adobe-source-han-sans:cn\n" msgstr "" #. type: code{#1} #: doc/guix.texi:2052 #, no-wrap msgid "xterm" msgstr "" #. type: Plain text #: doc/guix.texi:2056 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 "" #. type: example #: doc/guix.texi:2059 #, no-wrap msgid "-*-dejavu sans-medium-r-normal-*-*-100-*-*-*-*-*-1\n" msgstr "" #. type: Plain text #: doc/guix.texi:2063 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 "" #. type: example #: doc/guix.texi:2068 #, no-wrap msgid "xset +fp $(dirname $(readlink -f ~/.guix-profile/share/fonts/truetype/fonts.dir))\n" msgstr "" #. type: code{#1} #: doc/guix.texi:2070 #, no-wrap msgid "xlsfonts" msgstr "" #. type: Plain text #: doc/guix.texi:2073 msgid "" "After that, you can run @code{xlsfonts} (from @code{xlsfonts} package) to " "make sure your TrueType fonts are listed there." msgstr "" #. type: code{#1} #: doc/guix.texi:2077 doc/guix.texi:37578 #, no-wrap msgid "nss-certs" msgstr "" #. type: Plain text #: doc/guix.texi:2080 msgid "" "The @code{nss-certs} package provides X.509 certificates, which allow " "programs to authenticate Web servers accessed over HTTPS." msgstr "" #. type: Plain text #: doc/guix.texi:2085 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 "" #. type: subsection #: doc/guix.texi:2086 doc/contributing.texi:462 doc/contributing.texi:726 #: doc/contributing.texi:727 #, no-wrap msgid "Emacs Packages" msgstr "" #. type: code{#1} #: doc/guix.texi:2088 #, no-wrap msgid "emacs" msgstr "" #. type: Plain text #: doc/guix.texi:2094 msgid "" "When you install Emacs packages with Guix, the Elisp files are placed under " "the @file{share/emacs/site-lisp/} directory of the profile in which they are " "installed. The Elisp libraries are made available to Emacs through the " "@env{EMACSLOADPATH} environment variable, which is set when installing Emacs " "itself." msgstr "" #. type: Plain text #: doc/guix.texi:2101 msgid "" "Additionally, autoload definitions are automatically evaluated at the " "initialization of Emacs, by the Guix-specific @code{guix-emacs-autoload-" "packages} procedure. If, for some reason, you want to avoid auto-loading " "the Emacs packages installed with Guix, you can do so by running Emacs with " "the @option{--no-site-file} option (@pxref{Init File,,, emacs, The GNU Emacs " "Manual})." msgstr "" #. type: quotation #: doc/guix.texi:2107 msgid "" "Emacs can now compile packages natively. Under the default configuration, " "this means that Emacs packages will now be just-in-time (JIT) compiled as " "you use them, and the results stored in a subdirectory of your @code{user-" "emacs-directory}." msgstr "" #. type: quotation #: doc/guix.texi:2114 msgid "" "Furthermore, the build system for Emacs packages transparently supports " "native compilation, but note, that @code{emacs-minimal}---the default Emacs " "for building packages---has been configured without native compilation. To " "natively compile your emacs packages ahead of time, use a transformation " "like @option{--with-input=emacs-minimal=emacs}." msgstr "" #. type: cindex #: doc/guix.texi:2119 #, no-wrap msgid "Upgrading Guix, on a foreign distro" msgstr "" #. type: Plain text #: doc/guix.texi:2122 msgid "To upgrade Guix, run:" msgstr "" #. type: example #: doc/guix.texi:2125 doc/guix.texi:3101 #, no-wrap msgid "guix pull\n" msgstr "" #. type: Plain text #: doc/guix.texi:2128 msgid "@xref{Invoking guix pull}, for more information." msgstr "" #. type: cindex #: doc/guix.texi:2129 #, no-wrap msgid "upgrading Guix for the root user, on a foreign distro" msgstr "" #. type: cindex #: doc/guix.texi:2130 #, no-wrap msgid "upgrading the Guix daemon, on a foreign distro" msgstr "" #. type: cindex #: doc/guix.texi:2131 #, no-wrap msgid "@command{guix pull} for the root user, on a foreign distro" msgstr "" #. type: Plain text #: doc/guix.texi:2134 msgid "On a foreign distro, you can upgrade the build daemon by running:" msgstr "" #. type: example #: doc/guix.texi:2137 #, no-wrap msgid "sudo -i guix pull\n" msgstr "" #. type: Plain text #: doc/guix.texi:2142 msgid "" "followed by (assuming your distro uses the systemd service management tool):" msgstr "" #. type: example #: doc/guix.texi:2145 #, no-wrap msgid "systemctl restart guix-daemon.service\n" msgstr "" #. type: Plain text #: doc/guix.texi:2149 msgid "" "On Guix System, upgrading the daemon is achieved by reconfiguring the system " "(@pxref{Invoking guix system, @code{guix system reconfigure}})." msgstr "" #. type: cindex #: doc/guix.texi:2156 #, no-wrap msgid "installing Guix System" msgstr "" #. type: cindex #: doc/guix.texi:2157 #, no-wrap msgid "Guix System, installation" msgstr "" #. type: Plain text #: doc/guix.texi:2162 msgid "" "This section explains how to install Guix System on a machine. Guix, as a " "package manager, can also be installed on top of a running GNU/Linux system, " "@pxref{Installation}." msgstr "" #. type: quotation #: doc/guix.texi:2171 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:2174 msgid "" "Alternatively, run @command{info info} in another tty to keep the manual " "available." msgstr "" #. type: Plain text #: doc/guix.texi:2195 msgid "" "We consider Guix System to be ready for a wide range of ``desktop'' and " "server use cases. The reliability guarantees it provides---transactional " "upgrades and rollbacks, reproducibility---make it a solid foundation." msgstr "" #. type: Plain text #: doc/guix.texi:2198 msgid "" "Nevertheless, before you proceed with the installation, be aware of the " "following noteworthy limitations applicable to version @value{VERSION}:" msgstr "" #. type: itemize #: doc/guix.texi:2203 msgid "" "More and more system services are provided (@pxref{Services}), but some may " "be missing." msgstr "" #. type: itemize #: doc/guix.texi:2208 msgid "" "GNOME, Xfce, LXDE, and Enlightenment are available (@pxref{Desktop " "Services}), as well as a number of X11 window managers. However, KDE is " "currently missing." msgstr "" #. type: Plain text #: doc/guix.texi:2213 msgid "" "More than a disclaimer, this is an invitation to report issues (and success " "stories!), and to join us in improving it. @xref{Contributing}, for more " "info." msgstr "" #. type: cindex #: doc/guix.texi:2218 #, no-wrap msgid "hardware support on Guix System" msgstr "" #. type: Plain text #: doc/guix.texi:2227 msgid "" "GNU@tie{}Guix focuses on respecting the user's computing freedom. It builds " "around the kernel Linux-libre, which means that only hardware for which free " "software drivers and firmware exist is supported. Nowadays, a wide range of " "off-the-shelf hardware is supported on GNU/Linux-libre---from keyboards to " "graphics cards to scanners and Ethernet controllers. Unfortunately, there " "are still areas where hardware vendors deny users control over their own " "computing, and such hardware is not supported on Guix System." msgstr "" #. type: cindex #: doc/guix.texi:2228 #, no-wrap msgid "WiFi, hardware support" msgstr "" #. type: Plain text #: doc/guix.texi:2237 msgid "" "One of the main areas where free drivers or firmware are lacking is WiFi " "devices. WiFi devices known to work include those using Atheros chips " "(AR9271 and AR7010), which corresponds to the @code{ath9k} Linux-libre " "driver, and those using Broadcom/AirForce chips (BCM43xx with Wireless-Core " "Revision 5), which corresponds to the @code{b43-open} Linux-libre driver. " "Free firmware exists for both and is available out-of-the-box on Guix " "System, as part of @code{%base-firmware} (@pxref{operating-system Reference, " "@code{firmware}})." msgstr "" #. type: Plain text #: doc/guix.texi:2240 msgid "" "The installer warns you early on if it detects devices that are known " "@emph{not} to work due to the lack of free firmware or free drivers." msgstr "" #. type: cindex #: doc/guix.texi:2241 #, no-wrap msgid "RYF, Respects Your Freedom" msgstr "" #. type: Plain text #: doc/guix.texi:2247 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:2251 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:2260 msgid "" "An ISO-9660 installation image that can be written to a USB stick or burnt " "to a DVD can be downloaded from @indicateurl{@value{BASE-URL}/guix-system-" "install-@value{VERSION}.x86_64-linux.iso}, where you can replace " "@code{x86_64-linux} with one of:" msgstr "" #. type: table #: doc/guix.texi:2264 msgid "for a GNU/Linux system on Intel/AMD-compatible 64-bit CPUs;" msgstr "" #. type: table #: doc/guix.texi:2267 msgid "for a 32-bit GNU/Linux system on Intel-compatible CPUs." msgstr "" #. type: Plain text #: doc/guix.texi:2272 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:2276 #, no-wrap msgid "" "$ wget @value{BASE-URL}/guix-system-install-@value{VERSION}.x86_64-linux.iso.sig\n" "$ gpg --verify guix-system-install-@value{VERSION}.x86_64-linux.iso.sig\n" msgstr "" #. type: example #: doc/guix.texi:2284 #, no-wrap msgid "" "$ wget @value{OPENPGP-SIGNING-KEY-URL} \\\n" " -qO - | gpg --import -\n" msgstr "" #. type: Plain text #: doc/guix.texi:2296 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: unnumberedsubsec #: doc/guix.texi:2297 #, no-wrap msgid "Copying to a USB Stick" msgstr "" #. type: Plain text #: doc/guix.texi:2302 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:2306 #, no-wrap msgid "" "dd if=guix-system-install-@value{VERSION}.x86_64-linux.iso of=/dev/sdX status=progress\n" "sync\n" msgstr "" #. type: Plain text #: doc/guix.texi:2309 msgid "Access to @file{/dev/sdX} usually requires root privileges." msgstr "" #. type: unnumberedsubsec #: doc/guix.texi:2310 #, no-wrap msgid "Burning on a DVD" msgstr "" #. type: Plain text #: doc/guix.texi:2315 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:2318 #, no-wrap msgid "growisofs -dvd-compat -Z /dev/srX=guix-system-install-@value{VERSION}.x86_64-linux.iso\n" msgstr "" #. type: Plain text #: doc/guix.texi:2321 msgid "Access to @file{/dev/srX} usually requires root privileges." msgstr "" #. type: unnumberedsubsec #: doc/guix.texi:2322 #, no-wrap msgid "Booting" msgstr "" #. type: Plain text #: doc/guix.texi:2329 msgid "" "Once this is done, you should be able to reboot the system and boot from the " "USB stick or DVD@. The latter usually requires you to get in the BIOS or " "UEFI boot menu, where you can choose to boot from the USB stick. In order " "to boot from Libreboot, switch to the command mode by pressing the @kbd{c} " "key and type @command{search_grub usb}." msgstr "" #. type: Plain text #: doc/guix.texi:2332 msgid "" "@xref{Installing Guix in a VM}, if, instead, you would like to install Guix " "System in a virtual machine (VM)." msgstr "" #. type: Plain text #: doc/guix.texi:2342 msgid "" "Once you have booted, you can use the guided graphical installer, which " "makes it easy to get started (@pxref{Guided Graphical Installation}). " "Alternatively, if you are already familiar with GNU/Linux and if you want " "more control than what the graphical installer provides, you can choose the " "``manual'' installation process (@pxref{Manual Installation})." msgstr "" #. type: Plain text #: doc/guix.texi:2350 msgid "" "The graphical installer is available on TTY1. You can obtain root shells on " "TTYs 3 to 6 by hitting @kbd{ctrl-alt-f3}, @kbd{ctrl-alt-f4}, etc. TTY2 " "shows this documentation and you can reach it with @kbd{ctrl-alt-f2}. " "Documentation is browsable using the Info reader commands (@pxref{Top,,, " "info-stnd, Stand-alone GNU Info}). The installation system runs the GPM " "mouse daemon, which allows you to select text with the left mouse button and " "to paste it with the middle button." msgstr "" #. type: quotation #: doc/guix.texi:2355 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:2362 msgid "" "The graphical installer is a text-based user interface. It will guide you, " "with dialog boxes, through the steps needed to install GNU@tie{}Guix System." msgstr "" #. type: Plain text #: doc/guix.texi:2367 msgid "" "The first dialog boxes allow you to set up the system as you use it during " "the installation: you can choose the language, keyboard layout, and set up " "networking, which will be used during the installation. The image below " "shows the networking dialog." msgstr "" #. type: Plain text #: doc/guix.texi:2369 msgid "" "@image{images/installer-network,5in,, networking setup with the graphical " "installer}" msgstr "" #. type: Plain text #: doc/guix.texi:2374 msgid "" "Later steps allow you to partition your hard disk, as shown in the image " "below, to choose whether or not to use encrypted file systems, to enter the " "host name and root password, and to create an additional account, among " "other things." msgstr "" #. type: Plain text #: doc/guix.texi:2376 msgid "" "@image{images/installer-partitions,5in,, partitioning with the graphical " "installer}" msgstr "" #. type: Plain text #: doc/guix.texi:2379 msgid "" "Note that, at any time, the installer allows you to exit the current " "installation step and resume at a previous step, as show in the image below." msgstr "" #. type: Plain text #: doc/guix.texi:2381 msgid "@image{images/installer-resume,5in,, resuming the installation process}" msgstr "" #. type: Plain text #: doc/guix.texi:2386 msgid "" "Once you're done, the installer produces an operating system configuration " "and displays it (@pxref{Using the Configuration System}). At that point you " "can hit ``OK'' and installation will proceed. On success, you can reboot " "into the new system and enjoy. @xref{After System Installation}, for what's " "next!" msgstr "" #. type: Plain text #: doc/guix.texi:2396 msgid "" "This section describes how you would ``manually'' install GNU@tie{}Guix " "System on your machine. This option requires familiarity with GNU/Linux, " "with the shell, and with common administration tools. If you think this is " "not for you, consider using the guided graphical installer (@pxref{Guided " "Graphical Installation})." msgstr "" #. type: Plain text #: doc/guix.texi:2402 msgid "" "The installation system provides root shells on TTYs 3 to 6; press @kbd{ctrl-" "alt-f3}, @kbd{ctrl-alt-f4}, and so on to reach them. It includes many " "common tools needed to install the system, but is also a full-blown Guix " "System. This means that you can install additional packages, should you " "need it, using @command{guix package} (@pxref{Invoking guix package})." msgstr "" #. type: subsection #: doc/guix.texi:2409 #, no-wrap msgid "Keyboard Layout, Networking, and Partitioning" msgstr "" #. type: Plain text #: doc/guix.texi:2414 msgid "" "Before you can install the system, you may want to adjust the keyboard " "layout, set up networking, and partition your target hard disk. This " "section will guide you through this." msgstr "" #. type: cindex #: doc/guix.texi:2417 doc/guix.texi:17343 #, no-wrap msgid "keyboard layout" msgstr "" #. type: Plain text #: doc/guix.texi:2421 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:2424 #, no-wrap msgid "loadkeys dvorak\n" msgstr "" #. type: Plain text #: doc/guix.texi:2429 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: anchor{#1} #: doc/guix.texi:2431 msgid "manual-installation-networking" msgstr "" #. type: subsubsection #: doc/guix.texi:2431 #, no-wrap msgid "Networking" msgstr "" #. type: Plain text #: doc/guix.texi:2434 msgid "" "Run the following command to see what your network interfaces are called:" msgstr "" #. type: example #: doc/guix.texi:2437 #, no-wrap msgid "ifconfig -a\n" msgstr "" #. type: table #: doc/guix.texi:2441 doc/guix.texi:2463 msgid "@dots{} or, using the GNU/Linux-specific @command{ip} command:" msgstr "" #. type: example #: doc/guix.texi:2444 #, no-wrap msgid "ip address\n" msgstr "" #. type: Plain text #: doc/guix.texi:2451 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:2453 #, no-wrap msgid "Wired connection" msgstr "" #. type: table #: doc/guix.texi:2456 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:2459 #, no-wrap msgid "ifconfig @var{interface} up\n" msgstr "" #. type: example #: doc/guix.texi:2466 #, no-wrap msgid "ip link set @var{interface} up\n" msgstr "" #. type: item #: doc/guix.texi:2468 #, no-wrap msgid "Wireless connection" msgstr "" #. type: cindex #: doc/guix.texi:2469 #, no-wrap msgid "wireless" msgstr "" #. type: cindex #: doc/guix.texi:2470 #, no-wrap msgid "WiFi" msgstr "" #. type: table #: doc/guix.texi:2475 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:2478 #, no-wrap msgid "nano wpa_supplicant.conf\n" msgstr "" #. type: table #: doc/guix.texi:2483 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:2490 #, 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:2495 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:2498 #, no-wrap msgid "wpa_supplicant -c wpa_supplicant.conf -i @var{interface} -B\n" msgstr "" #. type: table #: doc/guix.texi:2501 msgid "Run @command{man wpa_supplicant} for more information." msgstr "" #. type: cindex #: doc/guix.texi:2503 #, no-wrap msgid "DHCP" msgstr "" #. type: Plain text #: doc/guix.texi:2506 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:2509 #, no-wrap msgid "dhclient -v @var{interface}\n" msgstr "" #. type: Plain text #: doc/guix.texi:2512 msgid "Try to ping a server to see if networking is up and running:" msgstr "" #. type: example #: doc/guix.texi:2515 #, no-wrap msgid "ping -c 3 gnu.org\n" msgstr "" #. type: Plain text #: doc/guix.texi:2519 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:2520 #, no-wrap msgid "proxy, during system installation" msgstr "" #. type: Plain text #: doc/guix.texi:2523 msgid "" "If you need HTTP and HTTPS access to go through a proxy, run the following " "command:" msgstr "" #. type: example #: doc/guix.texi:2526 #, no-wrap msgid "herd set-http-proxy guix-daemon @var{URL}\n" msgstr "" #. type: Plain text #: doc/guix.texi:2531 msgid "" "where @var{URL} is the proxy URL, for example @code{http://example.org:8118}." msgstr "" #. type: cindex #: doc/guix.texi:2532 #, no-wrap msgid "installing over SSH" msgstr "" #. type: Plain text #: doc/guix.texi:2535 msgid "" "If you want to, you can continue the installation remotely by starting an " "SSH server:" msgstr "" #. type: example #: doc/guix.texi:2538 #, no-wrap msgid "herd start ssh-daemon\n" msgstr "" #. type: Plain text #: doc/guix.texi:2542 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:2543 #, no-wrap msgid "Disk Partitioning" msgstr "" #. type: Plain text #: doc/guix.texi:2547 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:2552 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:2555 #, no-wrap msgid "cfdisk\n" msgstr "" #. type: Plain text #: doc/guix.texi:2561 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:2562 #, no-wrap msgid "EFI, installation" msgstr "" #. type: cindex #: doc/guix.texi:2563 #, no-wrap msgid "UEFI, installation" msgstr "" #. type: cindex #: doc/guix.texi:2564 #, no-wrap msgid "ESP, EFI system partition" msgstr "" #. type: Plain text #: doc/guix.texi:2568 msgid "" "If you instead wish to use EFI-based GRUB, a FAT32 @dfn{EFI System " "Partition} (ESP) is required. This partition can be mounted at @file{/boot/" "efi} for instance and must have the @code{esp} flag set. E.g., for " "@command{parted}:" msgstr "" #. type: example #: doc/guix.texi:2571 #, no-wrap msgid "parted /dev/sda set 1 esp on\n" msgstr "" #. type: vindex #: doc/guix.texi:2574 doc/guix.texi:38009 #, no-wrap msgid "grub-bootloader" msgstr "" #. type: vindex #: doc/guix.texi:2575 doc/guix.texi:38003 #, no-wrap msgid "grub-efi-bootloader" msgstr "" #. type: quotation #: doc/guix.texi:2582 msgid "" "Unsure whether to use EFI- or BIOS-based GRUB? If the directory @file{/sys/" "firmware/efi} exists in the installation image, then you should probably " "perform an EFI installation, using @code{grub-efi-bootloader}. Otherwise " "you should use the BIOS-based GRUB, known as @code{grub-bootloader}. " "@xref{Bootloader Configuration}, for more info on bootloaders." msgstr "" #. type: Plain text #: doc/guix.texi:2590 msgid "" "Once you are done partitioning the target hard disk drive, you have to " "create a file system on the relevant partition(s)@footnote{Currently Guix " "System only supports ext4, btrfs, JFS, F2FS, and XFS 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:" msgstr "" #. type: example #: doc/guix.texi:2593 #, no-wrap msgid "mkfs.fat -F32 /dev/sda1\n" msgstr "" #. type: Plain text #: doc/guix.texi:2600 msgid "" "For the root file system, ext4 is the most widely used format. Other file " "systems, such as Btrfs, support compression, which is reported to nicely " "complement file deduplication that the daemon performs independently of the " "file system (@pxref{Invoking guix-daemon, deduplication})." msgstr "" #. type: Plain text #: doc/guix.texi:2607 msgid "" "Preferably, assign file systems a label so that you can easily and reliably " "refer to them in @code{file-system} declarations (@pxref{File Systems}). " "This is typically done using the @code{-L} option of @command{mkfs.ext4} and " "related commands. So, assuming the target root partition lives at @file{/" "dev/sda2}, a file system with the label @code{my-root} can be created with:" msgstr "" #. type: example #: doc/guix.texi:2610 #, no-wrap msgid "mkfs.ext4 -L my-root /dev/sda2\n" msgstr "" #. type: cindex #: doc/guix.texi:2612 doc/guix.texi:16206 #, no-wrap msgid "encrypted disk" msgstr "" #. type: Plain text #: doc/guix.texi:2617 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)." msgstr "" #. type: quotation #: doc/guix.texi:2618 doc/guix.texi:5550 doc/guix.texi:6899 doc/guix.texi:16337 #: doc/guix.texi:23865 doc/guix.texi:23872 doc/guix.texi:31154 #, no-wrap msgid "Warning" msgstr "" #. type: quotation #: doc/guix.texi:2625 msgid "" "Note that GRUB can unlock LUKS2 devices since version 2.06, but only " "supports the PBKDF2 key derivation function, which is not the default for " "@command{cryptsetup luksFormat}. You can check which key derivation " "function is being used by a device by running @command{cryptsetup luksDump " "@var{device}}, and looking for the PBKDF field of your keyslots." msgstr "" #. type: Plain text #: doc/guix.texi:2630 msgid "" "Assuming you want to store the root partition on @file{/dev/sda2}, the " "command sequence to format it as a LUKS2 partition would be along these " "lines:" msgstr "" #. type: example #: doc/guix.texi:2635 #, no-wrap msgid "" "cryptsetup luksFormat --type luks2 --pbkdf pbkdf2 /dev/sda2\n" "cryptsetup open /dev/sda2 my-partition\n" "mkfs.ext4 -L my-root /dev/mapper/my-partition\n" msgstr "" #. type: Plain text #: doc/guix.texi:2640 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:2643 #, no-wrap msgid "mount LABEL=my-root /mnt\n" msgstr "" #. type: Plain text #: doc/guix.texi:2649 msgid "" "Also mount any other file systems you would like to use on the target system " "relative to this path. If you have opted for @file{/boot/efi} as an EFI " "mount point for example, mount it at @file{/mnt/boot/efi} now so it is found " "by @code{guix system init} afterwards." msgstr "" #. type: Plain text #: doc/guix.texi:2653 msgid "" "Finally, if you plan to use one or more swap partitions (@pxref{Swap " "Space}), make sure to initialize them with @command{mkswap}. Assuming you " "have one swap partition on @file{/dev/sda3}, you would run:" msgstr "" #. type: example #: doc/guix.texi:2657 #, no-wrap msgid "" "mkswap /dev/sda3\n" "swapon /dev/sda3\n" msgstr "" #. type: Plain text #: doc/guix.texi:2665 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:2673 #, 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:2678 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:2684 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:2687 #, no-wrap msgid "herd start cow-store /mnt\n" msgstr "" #. type: Plain text #: doc/guix.texi:2694 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:2705 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 mg (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:2712 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:2717 #, 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:2721 msgid "" "You should pay attention to what your configuration file contains, and in " "particular:" msgstr "" #. type: itemize #: doc/guix.texi:2733 msgid "" "Make sure the @code{bootloader-configuration} form refers to the targets 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{targets} field contain " "the names of the devices, like @code{(list \"/dev/sda\")}; for UEFI systems " "it names the paths to mounted EFI partitions, like @code{(list \"/boot/efi" "\")}; do make sure the paths are currently mounted and a @code{file-system} " "entry is specified in your configuration." msgstr "" #. type: itemize #: doc/guix.texi:2739 msgid "" "Be sure that your file system labels match the value of their respective " "@code{device} fields in your @code{file-system} configuration, assuming your " "@code{file-system} configuration uses the @code{file-system-label} procedure " "in its @code{device} field." msgstr "" #. type: itemize #: doc/guix.texi:2743 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:2748 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:2751 #, no-wrap msgid "guix system init /mnt/etc/config.scm /mnt\n" msgstr "" #. type: Plain text #: doc/guix.texi:2758 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:2766 msgid "" "Once that command has completed---and hopefully succeeded!---you can run " "@command{reboot} and boot into the new system. The @code{root} password in " "the new system is initially empty; other users' passwords need to be " "initialized by running the @command{passwd} command as @code{root}, unless " "your configuration specifies otherwise (@pxref{user-account-password, user " "account passwords}). @xref{After System Installation}, for what's next!" msgstr "" #. type: Plain text #: doc/guix.texi:2773 msgid "" "Success, you've now booted into Guix System! From then on, you can update " "the system whenever you want by running, say:" msgstr "" #. type: example #: doc/guix.texi:2777 #, no-wrap msgid "" "guix pull\n" "sudo guix system reconfigure /etc/config.scm\n" msgstr "" #. type: Plain text #: doc/guix.texi:2783 msgid "" "This builds a new system generation with the latest packages and services " "(@pxref{Invoking guix system}). We recommend doing that regularly so that " "your system includes the latest security updates (@pxref{Security Updates})." msgstr "" #. type: cindex #: doc/guix.texi:2786 #, no-wrap msgid "sudo vs. @command{guix pull}" msgstr "" #. type: quotation #: doc/guix.texi:2790 msgid "" "Note that @command{sudo guix} runs your user's @command{guix} command and " "@emph{not} root's, because @command{sudo} leaves @env{PATH} unchanged. To " "explicitly run root's @command{guix}, type @command{sudo -i guix @dots{}}." msgstr "" #. type: quotation #: doc/guix.texi:2795 msgid "" "The difference matters here, because @command{guix pull} updates the " "@command{guix} command and package definitions only for the user it is run " "as. This means that if you choose to use @command{guix system reconfigure} " "in root's login shell, you'll need to @command{guix pull} separately." msgstr "" #. type: Plain text #: doc/guix.texi:2800 msgid "" "Now, @pxref{Getting Started}, and join us on @code{#guix} on the Libera Chat " "IRC network or on @email{guix-devel@@gnu.org} to share your experience!" msgstr "" #. type: section #: doc/guix.texi:2803 #, no-wrap msgid "Installing Guix in a Virtual Machine" msgstr "" #. type: cindex #: doc/guix.texi:2805 #, no-wrap msgid "virtual machine, Guix System installation" msgstr "" #. type: cindex #: doc/guix.texi:2806 #, no-wrap msgid "virtual private server (VPS)" msgstr "" #. type: cindex #: doc/guix.texi:2807 #, no-wrap msgid "VPS (virtual private server)" msgstr "" #. type: Plain text #: doc/guix.texi:2811 msgid "" "If you'd like to install Guix System in a virtual machine (VM) or on a " "virtual private server (VPS) rather than on your beloved machine, this " "section is for you." msgstr "" #. type: Plain text #: doc/guix.texi:2814 msgid "" "To boot a @uref{https://qemu.org/,QEMU} VM for installing Guix System in a " "disk image, follow these steps:" msgstr "" #. type: enumerate #: doc/guix.texi:2819 msgid "" "First, retrieve and decompress the Guix system installation image as " "described previously (@pxref{USB Stick and DVD Installation})." msgstr "" #. type: enumerate #: doc/guix.texi:2823 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:2826 #, no-wrap msgid "qemu-img create -f qcow2 guix-system.img 50G\n" msgstr "" #. type: enumerate #: doc/guix.texi:2830 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:2833 msgid "Boot the USB installation image in an VM:" msgstr "" #. type: example #: doc/guix.texi:2839 #, no-wrap msgid "" "qemu-system-x86_64 -m 1024 -smp 1 -enable-kvm \\\n" " -nic user,model=virtio-net-pci -boot menu=on,order=d \\\n" " -drive file=guix-system.img \\\n" " -drive media=cdrom,file=guix-system-install-@value{VERSION}.@var{system}.iso\n" msgstr "" #. type: enumerate #: doc/guix.texi:2843 msgid "" "@code{-enable-kvm} is optional, but significantly improves performance, " "@pxref{Running Guix in a VM}." msgstr "" #. type: enumerate #: doc/guix.texi:2847 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:2852 msgid "" "Once installation is complete, you can boot the system that's on your " "@file{guix-system.img} image. @xref{Running Guix in a VM}, for how to do " "that." msgstr "" #. type: cindex #: doc/guix.texi:2856 #, no-wrap msgid "installation image" msgstr "" #. type: Plain text #: doc/guix.texi:2859 msgid "" "The installation image described above was built using the @command{guix " "system} command, specifically:" msgstr "" #. type: example #: doc/guix.texi:2862 #, no-wrap msgid "guix system image -t iso9660 gnu/system/install.scm\n" msgstr "" #. type: Plain text #: doc/guix.texi:2867 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: section #: doc/guix.texi:2868 #, no-wrap msgid "Building the Installation Image for ARM Boards" msgstr "" #. type: Plain text #: doc/guix.texi:2872 msgid "" "Many ARM boards require a specific variant of the @uref{https://www.denx.de/" "wiki/U-Boot/, U-Boot} bootloader." msgstr "" #. type: Plain text #: doc/guix.texi:2876 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:2879 #, no-wrap msgid "guix system 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:2883 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:2885 #, no-wrap msgid "troubleshooting, guix system" msgstr "" #. type: cindex #: doc/guix.texi:2886 #, no-wrap msgid "guix system troubleshooting" msgstr "" #. type: Plain text #: doc/guix.texi:2898 msgid "" "Guix System allows rebooting into a previous generation should the last one " "be malfunctioning, which makes it quite robust against being broken " "irreversibly. This feature depends on GRUB being correctly functioning " "though, which means that if for whatever reasons your GRUB installation " "becomes corrupted during a system reconfiguration, you may not be able to " "easily boot into a previous generation. A technique that can be used in " "this case is to @i{chroot} into your broken system and reconfigure it from " "there. Such technique is explained below." msgstr "" #. type: cindex #: doc/guix.texi:2899 #, no-wrap msgid "chroot, guix system" msgstr "" #. type: cindex #: doc/guix.texi:2900 #, no-wrap msgid "chrooting, guix system" msgstr "" #. type: cindex #: doc/guix.texi:2901 #, no-wrap msgid "repairing GRUB, via chroot" msgstr "" #. type: Plain text #: doc/guix.texi:2910 msgid "" "This section details how to @i{chroot} to an already installed Guix System " "with the aim of reconfiguring it, for example to fix a broken GRUB " "installation. The process is similar to how it would be done on other GNU/" "Linux systems, but there are some Guix System particularities such as the " "daemon and profiles that make it worthy of explaining here." msgstr "" #. type: enumerate #: doc/guix.texi:2919 msgid "" "Obtain a bootable image of Guix System. It is recommended the latest " "development snapshot so the kernel and the tools used are at least as as new " "as those of your installed system; it can be retrieved from the @url{https://" "ci.guix.gnu.org/search/latest/ISO-9660?query=spec:images+status:success" "+system:x86_64-linux+image.iso, https://ci.guix.gnu.org} URL. Follow the " "@pxref{USB Stick and DVD Installation} section for copying it to a bootable " "media." msgstr "" #. type: enumerate #: doc/guix.texi:2928 msgid "" "Boot the image, and proceed with the graphical text-based installer until " "your network is configured. Alternatively, you could configure the network " "manually by following the @ref{manual-installation-networking} section. If " "you get the error @samp{RTNETLINK answers: Operation not possible due to RF-" "kill}, try @samp{rfkill list} followed by @samp{rfkill unblock 0}, where " "@samp{0} is your device identifier (ID)." msgstr "" #. type: enumerate #: doc/guix.texi:2934 msgid "" "Switch to a virtual console (tty) if you haven't already by pressing " "simultaneously the @kbd{Control + Alt + F4} keys. Mount your file system at " "@file{/mnt}. Assuming your root partition is @file{/dev/sda2}, you would do:" msgstr "" #. type: example #: doc/guix.texi:2937 #, no-wrap msgid "mount /dev/sda2 /mnt\n" msgstr "" #. type: enumerate #: doc/guix.texi:2941 msgid "Mount special block devices and Linux-specific directories:" msgstr "" #. type: example #: doc/guix.texi:2946 #, no-wrap msgid "" "mount --bind /proc /mnt/proc\n" "mount --bind /sys /mnt/sys\n" "mount --bind /dev /mnt/dev\n" msgstr "" #. type: enumerate #: doc/guix.texi:2950 msgid "" "If your system is EFI-based, you must also mount the ESP partition. " "Assuming it is @file{/dev/sda1}, you can do so with:" msgstr "" #. type: example #: doc/guix.texi:2953 #, no-wrap msgid "mount /dev/sda1 /mnt/boot/efi\n" msgstr "" #. type: enumerate #: doc/guix.texi:2957 msgid "Enter your system via chroot:" msgstr "" #. type: example #: doc/guix.texi:2960 #, no-wrap msgid "chroot /mnt /bin/sh\n" msgstr "" #. type: enumerate #: doc/guix.texi:2966 msgid "" "Source the system profile as well as your @var{user} profile to setup the " "environment, where @var{user} is the user name used for the Guix System you " "are attempting to repair:" msgstr "" #. type: example #: doc/guix.texi:2970 #, no-wrap msgid "" "source /var/guix/profiles/system/profile/etc/profile\n" "source /home/@var{user}/.guix-profile/etc/profile\n" msgstr "" #. type: enumerate #: doc/guix.texi:2974 msgid "" "To ensure you are working with the Guix revision you normally would as your " "normal user, also source your current Guix profile:" msgstr "" #. type: example #: doc/guix.texi:2977 #, no-wrap msgid "source /home/@var{user}/.config/guix/current/etc/profile\n" msgstr "" #. type: enumerate #: doc/guix.texi:2981 msgid "Start a minimal @command{guix-daemon} in the background:" msgstr "" #. type: example #: doc/guix.texi:2984 #, no-wrap msgid "guix-daemon --build-users-group=guixbuild --disable-chroot &\n" msgstr "" #. type: enumerate #: doc/guix.texi:2988 msgid "Edit your Guix System configuration if needed, then reconfigure with:" msgstr "" #. type: example #: doc/guix.texi:2991 #, no-wrap msgid "guix system reconfigure your-config.scm\n" msgstr "" #. type: enumerate #: doc/guix.texi:2995 msgid "Finally, you should be good to reboot the system to test your fix." msgstr "" #. type: Plain text #: doc/guix.texi:3007 msgid "" "Presumably, you've reached this section because either you have installed " "Guix on top of another distribution (@pxref{Installation}), or you've " "installed the standalone Guix System (@pxref{System Installation}). It's " "time for you to get started using Guix and this section aims to help you do " "that and give you a feel of what it's like." msgstr "" #. type: Plain text #: doc/guix.texi:3011 msgid "" "Guix is about installing software, so probably the first thing you'll want " "to do is to actually look for software. Let's say you're looking for a text " "editor, you can run:" msgstr "" #. type: example #: doc/guix.texi:3014 #, no-wrap msgid "guix search text editor\n" msgstr "" #. type: Plain text #: doc/guix.texi:3021 msgid "" "This command shows you a number of matching @dfn{packages}, each time " "showing the package's name, version, a description, and additional info. " "Once you've found out the one you want to use, let's say Emacs (ah ha!), you " "can go ahead and install it (run this command as a regular user, @emph{no " "need for root privileges}!):" msgstr "" #. type: example #: doc/guix.texi:3024 #, no-wrap msgid "guix install emacs\n" msgstr "" #. type: cindex #: doc/guix.texi:3026 doc/guix.texi:3338 doc/guix.texi:3391 #, no-wrap msgid "profile" msgstr "" #. type: Plain text #: doc/guix.texi:3034 msgid "" "You've installed your first package, congrats! The package is now visible in " "your default @dfn{profile}, @file{$HOME/.guix-profile}---a profile is a " "directory containing installed packages. In the process, you've probably " "noticed that Guix downloaded pre-built binaries; or, if you explicitly chose " "to @emph{not} use pre-built binaries, then probably Guix is still building " "software (@pxref{Substitutes}, for more info)." msgstr "" #. type: Plain text #: doc/guix.texi:3037 msgid "" "Unless you're using Guix System, the @command{guix install} command must " "have printed this hint:" msgstr "" #. type: example #: doc/guix.texi:3040 #, no-wrap msgid "" "hint: Consider setting the necessary environment variables by running:\n" "\n" msgstr "" #. type: example #: doc/guix.texi:3043 #, no-wrap msgid "" " GUIX_PROFILE=\"$HOME/.guix-profile\"\n" " . \"$GUIX_PROFILE/etc/profile\"\n" "\n" msgstr "" #. type: example #: doc/guix.texi:3045 #, no-wrap msgid "Alternately, see `guix package --search-paths -p \"$HOME/.guix-profile\"'.\n" msgstr "" #. type: Plain text #: doc/guix.texi:3059 msgid "" "Indeed, you must now tell your shell where @command{emacs} and other " "programs installed with Guix are to be found. Pasting the two lines above " "will do just that: it will add @code{$HOME/.guix-profile/bin}---which is " "where the installed package is---to the @code{PATH} environment variable. " "You can paste these two lines in your shell so they take effect right away, " "but more importantly you should add them to @file{~/.bash_profile} (or " "equivalent file if you do not use Bash) so that environment variables are " "set next time you spawn a shell. You only need to do this once and other " "search paths environment variables will be taken care of similarly---e.g., " "if you eventually install @code{python} and Python libraries, " "@env{GUIX_PYTHONPATH} will be defined." msgstr "" #. type: Plain text #: doc/guix.texi:3062 msgid "" "You can go on installing packages at your will. To list installed packages, " "run:" msgstr "" #. type: example #: doc/guix.texi:3065 #, no-wrap msgid "guix package --list-installed\n" msgstr "" #. type: Plain text #: doc/guix.texi:3070 msgid "" "To remove a package, you would unsurprisingly run @command{guix remove}. A " "distinguishing feature is the ability to @dfn{roll back} any operation you " "made---installation, removal, upgrade---by simply typing:" msgstr "" #. type: example #: doc/guix.texi:3073 #, no-wrap msgid "guix package --roll-back\n" msgstr "" #. type: Plain text #: doc/guix.texi:3078 msgid "" "This is because each operation is in fact a @dfn{transaction} that creates a " "new @dfn{generation}. These generations and the difference between them can " "be displayed by running:" msgstr "" #. type: example #: doc/guix.texi:3081 #, no-wrap msgid "guix package --list-generations\n" msgstr "" #. type: Plain text #: doc/guix.texi:3084 msgid "Now you know the basics of package management!" msgstr "" #. type: quotation #: doc/guix.texi:3085 doc/guix.texi:3144 doc/guix.texi:7465 #, no-wrap msgid "Going further" msgstr "" #. type: quotation #: doc/guix.texi:3093 msgid "" "@xref{Package Management}, for more about package management. You may like " "@dfn{declarative} package management with @command{guix package --manifest}, " "managing separate @dfn{profiles} with @option{--profile}, deleting old " "generations, collecting garbage, and other nifty features that will come in " "handy as you become more familiar with Guix. If you are a developer, " "@pxref{Development} for additional tools. And if you're curious, " "@pxref{Features}, to peek under the hood." msgstr "" #. type: Plain text #: doc/guix.texi:3098 msgid "" "Once you've installed a set of packages, you will want to periodically " "@emph{upgrade} them to the latest and greatest version. To do that, you " "will first pull the latest revision of Guix and its package collection:" msgstr "" #. type: Plain text #: doc/guix.texi:3108 msgid "" "The end result is a new @command{guix} command, under @file{~/.config/guix/" "current/bin}. Unless you're on Guix System, the first time you run " "@command{guix pull}, be sure to follow the hint that the command prints and, " "similar to what we saw above, paste these two lines in your terminal and " "@file{.bash_profile}:" msgstr "" #. type: example #: doc/guix.texi:3112 #, no-wrap msgid "" "GUIX_PROFILE=\"$HOME/.config/guix/current\"\n" ". \"$GUIX_PROFILE/etc/profile\"\n" msgstr "" #. type: Plain text #: doc/guix.texi:3116 msgid "You must also instruct your shell to point to this new @command{guix}:" msgstr "" #. type: example #: doc/guix.texi:3119 #, no-wrap msgid "hash guix\n" msgstr "" #. type: Plain text #: doc/guix.texi:3123 msgid "" "At this point, you're running a brand new Guix. You can thus go ahead and " "actually upgrade all the packages you previously installed:" msgstr "" #. type: example #: doc/guix.texi:3126 #, no-wrap msgid "guix upgrade\n" msgstr "" #. type: Plain text #: doc/guix.texi:3132 msgid "" "As you run this command, you will see that binaries are downloaded (or " "perhaps some packages are built), and eventually you end up with the " "upgraded packages. Should one of these upgraded packages not be to your " "liking, remember you can always roll back!" msgstr "" #. type: Plain text #: doc/guix.texi:3135 msgid "" "You can display the exact revision of Guix you're currently using by running:" msgstr "" #. type: example #: doc/guix.texi:3138 #, no-wrap msgid "guix describe\n" msgstr "" #. type: Plain text #: doc/guix.texi:3143 msgid "" "The information it displays is @emph{all it takes to reproduce the exact " "same Guix}, be it at a different point in time or on a different machine." msgstr "" #. type: quotation #: doc/guix.texi:3149 msgid "" "@xref{Invoking guix pull}, for more information. @xref{Channels}, on how to " "specify additional @dfn{channels} to pull packages from, how to replicate " "Guix, and more. You may also find @command{time-machine} handy " "(@pxref{Invoking guix time-machine})." msgstr "" #. type: Plain text #: doc/guix.texi:3154 msgid "" "If you installed Guix System, one of the first things you'll want to do is " "to upgrade your system. Once you've run @command{guix pull} to get the " "latest Guix, you can upgrade the system like this:" msgstr "" #. type: example #: doc/guix.texi:3157 #, no-wrap msgid "sudo guix system reconfigure /etc/config.scm\n" msgstr "" #. type: Plain text #: doc/guix.texi:3166 msgid "" "Upon completion, the system runs the latest versions of its software " "packages. When you eventually reboot, you'll notice a sub-menu in the " "bootloader that reads ``Old system generations'': it's what allows you to " "boot @emph{an older generation of your system}, should the latest generation " "be ``broken'' or otherwise unsatisfying. Just like for packages, you can " "always @emph{roll back} to a previous generation @emph{of the whole system}:" msgstr "" #. type: example #: doc/guix.texi:3169 #, no-wrap msgid "sudo guix system roll-back\n" msgstr "" #. type: Plain text #: doc/guix.texi:3176 msgid "" "There are many things you'll probably want to tweak on your system: adding " "new user accounts, adding new system services, fiddling with the " "configuration of those services, etc. The system configuration is " "@emph{entirely} described in the @file{/etc/config.scm} file. @xref{Using " "the Configuration System}, to learn how to change it." msgstr "" #. type: Plain text #: doc/guix.texi:3178 msgid "Now you know enough to get started!" msgstr "" #. type: quotation #: doc/guix.texi:3179 #, no-wrap msgid "Resources" msgstr "" #. type: quotation #: doc/guix.texi:3182 msgid "" "The rest of this manual provides a reference for all things Guix. Here are " "some additional resources you may find useful:" msgstr "" #. type: itemize #: doc/guix.texi:3187 msgid "" "@xref{Top,,, guix-cookbook, The GNU Guix Cookbook}, for a list of ``how-to'' " "style of recipes for a variety of applications." msgstr "" #. type: itemize #: doc/guix.texi:3192 msgid "" "The @uref{https://guix.gnu.org/guix-refcard.pdf, GNU Guix Reference Card} " "lists in two pages most of the commands and options you'll ever need." msgstr "" #. type: itemize #: doc/guix.texi:3197 msgid "" "The web site contains @uref{https://guix.gnu.org/en/videos/, instructional " "videos} covering topics such as everyday use of Guix, how to get help, and " "how to become a contributor." msgstr "" #. type: itemize #: doc/guix.texi:3201 msgid "" "@xref{Documentation}, to learn how to access documentation on your computer." msgstr "" #. type: quotation #: doc/guix.texi:3204 msgid "" "We hope you will enjoy Guix as much as the community enjoys building it!" msgstr "" #. #-#-#-#-# guix.pot (guix manual 1.4.0rc1) #-#-#-#-# #. type: cindex #. #-#-#-#-# contributing.pot (guix manual 1.4.0rc1) #-#-#-#-# #. type: item #: doc/guix.texi:3210 doc/contributing.texi:2129 #, no-wrap msgid "packages" msgstr "" #. type: Plain text #: doc/guix.texi:3215 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 "" #. type: Plain text #: doc/guix.texi:3223 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 "" #. type: example #: doc/guix.texi:3226 #, no-wrap msgid "guix install emacs-guix\n" msgstr "" #. type: Plain text #: doc/guix.texi:3247 msgid "" "Here we assume you've already made your first steps with Guix " "(@pxref{Getting Started}) and would like to get an overview about what's " "going on under the hood." msgstr "" #. type: Plain text #: doc/guix.texi:3251 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 "" #. type: Plain text #: doc/guix.texi:3256 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 "" #. type: Plain text #: doc/guix.texi:3264 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 "" #. type: Plain text #: doc/guix.texi:3268 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 "" #. type: cindex #: doc/guix.texi:3269 doc/guix.texi:3353 #, no-wrap msgid "transactions" msgstr "" #. type: Plain text #: doc/guix.texi:3276 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 "" #. type: Plain text #: doc/guix.texi:3284 msgid "" "In addition, any package transaction may be @emph{rolled back}. So, if, for " "example, an upgrade installs a new version of a package that turns out to " "have a serious bug, users may roll back to the previous instance of their " "profile, which was known to work well. Similarly, the global system " "configuration on Guix is subject to transactional upgrades and roll-back " "(@pxref{Using the Configuration System})." msgstr "" #. type: Plain text #: doc/guix.texi:3291 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 "" #. #-#-#-#-# guix.pot (guix manual 1.4.0rc1) #-#-#-#-# #. type: cindex #. #-#-#-#-# contributing.pot (guix manual 1.4.0rc1) #-#-#-#-# #. type: item #: doc/guix.texi:3292 doc/guix.texi:5023 doc/contributing.texi:1690 #, no-wrap msgid "reproducibility" msgstr "" #. type: Plain text #: doc/guix.texi:3304 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})." msgstr "" #. type: Plain text #: doc/guix.texi:3315 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 "" #. type: Plain text #: doc/guix.texi:3321 msgid "" "Control over the build environment is a feature that is also useful for " "developers. The @command{guix shell} 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 shell})." msgstr "" #. type: cindex #: doc/guix.texi:3322 #, no-wrap msgid "replication, of software environments" msgstr "" #. type: cindex #: doc/guix.texi:3323 #, no-wrap msgid "provenance tracking, of software artifacts" msgstr "" #. type: Plain text #: doc/guix.texi:3330 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 "" #. type: section #: doc/guix.texi:3332 #, no-wrap msgid "Invoking @command{guix package}" msgstr "" #. type: cindex #: doc/guix.texi:3334 #, no-wrap msgid "installing packages" msgstr "" #. type: cindex #: doc/guix.texi:3335 #, no-wrap msgid "removing packages" msgstr "" #. type: cindex #: doc/guix.texi:3336 #, no-wrap msgid "package installation" msgstr "" #. type: cindex #: doc/guix.texi:3337 #, no-wrap msgid "package removal" msgstr "" #. type: command{#1} #: doc/guix.texi:3339 #, no-wrap msgid "guix package" msgstr "" #. type: Plain text #: doc/guix.texi:3348 msgid "" "The @command{guix package} command is the tool that allows users to install, " "upgrade, and remove packages, as well as rolling back to previous " "configurations. These operations work on a user @dfn{profile}---a directory " "of installed packages. Each user has a default profile in @file{$HOME/.guix-" "profile}. The command operates only on the user's own profile, and works " "with normal user privileges (@pxref{Features}). Its syntax is:" msgstr "" #. type: example #: doc/guix.texi:3351 #, no-wrap msgid "guix package @var{options}\n" msgstr "" #. type: Plain text #: doc/guix.texi:3358 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 "" #. type: Plain text #: doc/guix.texi:3361 msgid "" "For example, to remove @code{lua} and install @code{guile} and @code{guile-" "cairo} in a single transaction:" msgstr "" #. type: example #: doc/guix.texi:3364 #, no-wrap msgid "guix package -r lua -i guile guile-cairo\n" msgstr "" #. type: cindex #: doc/guix.texi:3366 #, no-wrap msgid "aliases, for @command{guix package}" msgstr "" #. type: Plain text #: doc/guix.texi:3368 msgid "For your convenience, we also provide the following aliases:" msgstr "" #. type: itemize #: doc/guix.texi:3372 msgid "@command{guix search} is an alias for @command{guix package -s}," msgstr "" #. type: itemize #: doc/guix.texi:3374 msgid "@command{guix install} is an alias for @command{guix package -i}," msgstr "" #. type: itemize #: doc/guix.texi:3376 msgid "@command{guix remove} is an alias for @command{guix package -r}," msgstr "" #. type: itemize #: doc/guix.texi:3378 msgid "@command{guix upgrade} is an alias for @command{guix package -u}," msgstr "" #. type: itemize #: doc/guix.texi:3380 msgid "and @command{guix show} is an alias for @command{guix package --show=}." msgstr "" #. type: Plain text #: doc/guix.texi:3385 msgid "" "These aliases are less expressive than @command{guix package} and provide " "fewer options, so in some cases you'll probably want to use @command{guix " "package} directly." msgstr "" #. type: Plain text #: doc/guix.texi:3390 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 "" #. type: Plain text #: doc/guix.texi:3397 msgid "" "For each user, a symlink to the user's default profile is automatically " "created in @file{$HOME/.guix-profile}. This symlink always points to the " "current generation of the user's default profile. Thus, users can add " "@file{$HOME/.guix-profile/bin} to their @env{PATH} environment variable, and " "so on." msgstr "" #. type: cindex #: doc/guix.texi:3397 doc/guix.texi:3623 #, no-wrap msgid "search paths" msgstr "" #. type: Plain text #: doc/guix.texi:3402 msgid "" "If you are not using Guix System, consider adding the following lines to " "your @file{~/.bash_profile} (@pxref{Bash Startup Files,,, bash, The GNU Bash " "Reference Manual}) so that newly-spawned shells get all the right " "environment variable definitions:" msgstr "" #. type: example #: doc/guix.texi:3406 #, no-wrap msgid "" "GUIX_PROFILE=\"$HOME/.guix-profile\" ; \\\n" "source \"$GUIX_PROFILE/etc/profile\"\n" msgstr "" #. type: Plain text #: doc/guix.texi:3417 msgid "" "In a multi-user setup, user profiles are stored in a place registered as a " "@dfn{garbage-collector root}, which @file{$HOME/.guix-profile} points to " "(@pxref{Invoking guix gc}). That directory is normally " "@code{@var{localstatedir}/guix/profiles/per-user/@var{user}}, where " "@var{localstatedir} is the value passed to @code{configure} as @option{--" "localstatedir}, and @var{user} is the user name. The @file{per-user} " "directory is created when @command{guix-daemon} is started, and the " "@var{user} sub-directory is created by @command{guix package}." msgstr "" #. type: Plain text #: doc/guix.texi:3419 msgid "The @var{options} can be among the following:" msgstr "" #. type: item #: doc/guix.texi:3422 #, no-wrap msgid "--install=@var{package} @dots{}" msgstr "" #. type: itemx #: doc/guix.texi:3423 #, no-wrap msgid "-i @var{package} @dots{}" msgstr "" #. type: table #: doc/guix.texi:3425 msgid "Install the specified @var{package}s." msgstr "" #. type: table #: doc/guix.texi:3430 msgid "" "Each @var{package} may specify a simple package name, such as @code{guile}, " "optionally followed by an at-sign and version number, such as " "@code{guile@@3.0.7} or simply @code{guile@@3.0}. In the latter case, the " "newest version prefixed by @code{3.0} is selected." msgstr "" #. type: table #: doc/guix.texi:3436 msgid "" "If no version number is specified, the newest available version will be " "selected. In addition, such a @var{package} specification 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})." msgstr "" #. type: table #: doc/guix.texi:3440 msgid "" "Packages with a corresponding name (and optionally version) are searched for " "among the GNU distribution modules (@pxref{Package Modules})." msgstr "" #. type: table #: doc/guix.texi:3444 msgid "" "Alternatively, a @var{package} can directly specify a store file name such " "as @file{/gnu/store/...-guile-3.0.7}, as produced by, e.g., @code{guix " "build}." msgstr "" #. type: cindex #: doc/guix.texi:3445 #, no-wrap msgid "propagated inputs" msgstr "" #. type: table #: doc/guix.texi:3451 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 "" #. type: anchor{#1} #: doc/guix.texi:3458 msgid "package-cmd-propagated-inputs" msgstr "" #. type: table #: doc/guix.texi:3458 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 "" #. type: table #: doc/guix.texi:3463 msgid "" "Besides, packages sometimes rely on the definition of environment variables " "for their search paths (see explanation of @option{--search-paths} below). " "Any missing or possibly incorrect environment variable definitions are " "reported here." msgstr "" #. type: item #: doc/guix.texi:3464 #, no-wrap msgid "--install-from-expression=@var{exp}" msgstr "" #. type: itemx #: doc/guix.texi:3465 #, no-wrap msgid "-e @var{exp}" msgstr "" #. type: table #: doc/guix.texi:3467 msgid "Install the package @var{exp} evaluates to." msgstr "" #. type: table #: doc/guix.texi:3472 msgid "" "@var{exp} must be a Scheme expression that evaluates to a @code{} " "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 "" #. type: table #: doc/guix.texi:3476 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 "" #. type: item #: doc/guix.texi:3477 #, no-wrap msgid "--install-from-file=@var{file}" msgstr "" #. type: itemx #: doc/guix.texi:3478 doc/guix.texi:6064 doc/guix.texi:12801 #, no-wrap msgid "-f @var{file}" msgstr "" #. type: table #: doc/guix.texi:3480 msgid "Install the package that the code within @var{file} evaluates to." msgstr "" #. type: table #: doc/guix.texi:3483 doc/guix.texi:6070 doc/guix.texi:6544 msgid "" "As an example, @var{file} might contain a definition like this " "(@pxref{Defining Packages}):" msgstr "" #. type: include #: doc/guix.texi:3485 doc/guix.texi:12809 #, no-wrap msgid "package-hello.scm" msgstr "" #. type: table #: doc/guix.texi:3492 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 shell})." msgstr "" #. type: table #: doc/guix.texi:3497 msgid "" "The @var{file} may also contain a JSON representation of one or more package " "definitions. Running @code{guix package -f} on @file{hello.json} with the " "following contents would result in installing the package @code{greeter} " "after building @code{myhello}:" msgstr "" #. type: example #: doc/guix.texi:3500 doc/guix.texi:12819 #, no-wrap msgid "@verbatiminclude package-hello.json\n" msgstr "" #. type: item #: doc/guix.texi:3502 #, no-wrap msgid "--remove=@var{package} @dots{}" msgstr "" #. type: itemx #: doc/guix.texi:3503 #, no-wrap msgid "-r @var{package} @dots{}" msgstr "" #. type: table #: doc/guix.texi:3505 msgid "Remove the specified @var{package}s." msgstr "" #. type: table #: doc/guix.texi:3510 msgid "" "As for @option{--install}, each @var{package} may specify a version number " "and/or output name in addition to the package name. For instance, @samp{-r " "glibc:debug} would remove the @code{debug} output of @code{glibc}." msgstr "" #. type: item #: doc/guix.texi:3511 #, no-wrap msgid "--upgrade[=@var{regexp} @dots{}]" msgstr "" #. type: itemx #: doc/guix.texi:3512 #, no-wrap msgid "-u [@var{regexp} @dots{}]" msgstr "" #. type: cindex #: doc/guix.texi:3513 #, no-wrap msgid "upgrading packages" msgstr "" #. type: table #: doc/guix.texi:3517 msgid "" "Upgrade all the installed packages. If one or more @var{regexp}s are " "specified, upgrade only installed packages whose name matches a " "@var{regexp}. Also see the @option{--do-not-upgrade} option below." msgstr "" #. type: table #: doc/guix.texi:3522 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 "" #. type: cindex #: doc/guix.texi:3523 #, no-wrap msgid "package transformations, upgrades" msgstr "" #. type: table #: doc/guix.texi:3528 msgid "" "When upgrading, package transformations that were originally applied when " "creating the profile are automatically re-applied (@pxref{Package " "Transformation Options}). For example, assume you first installed Emacs " "from the tip of its development branch with:" msgstr "" #. type: example #: doc/guix.texi:3531 #, no-wrap msgid "guix install emacs-next --with-branch=emacs-next=master\n" msgstr "" #. type: table #: doc/guix.texi:3536 msgid "" "Next time you run @command{guix upgrade}, Guix will again pull the tip of " "the Emacs development branch and build @code{emacs-next} from that checkout." msgstr "" #. type: table #: doc/guix.texi:3541 msgid "" "Note that transformation options such as @option{--with-branch} and " "@option{--with-source} depend on external state; it is up to you to ensure " "that they work as expected. You can also discard a transformations that " "apply to a package by running:" msgstr "" #. type: example #: doc/guix.texi:3544 #, no-wrap msgid "guix install @var{package}\n" msgstr "" #. type: item #: doc/guix.texi:3546 #, no-wrap msgid "--do-not-upgrade[=@var{regexp} @dots{}]" msgstr "" #. type: table #: doc/guix.texi:3551 msgid "" "When used together with the @option{--upgrade} option, do @emph{not} upgrade " "any packages whose name matches a @var{regexp}. For example, to upgrade all " "packages in the current profile except those containing the substring " "``emacs'':" msgstr "" #. type: example #: doc/guix.texi:3554 #, no-wrap msgid "$ guix package --upgrade . --do-not-upgrade emacs\n" msgstr "" #. type: anchor{#1} #: doc/guix.texi:3556 #, no-wrap msgid "profile-manifest" msgstr "" #. type: item #: doc/guix.texi:3556 doc/guix.texi:6083 doc/guix.texi:6549 doc/guix.texi:7026 #: doc/guix.texi:14007 doc/guix.texi:15703 #, no-wrap msgid "--manifest=@var{file}" msgstr "" #. type: itemx #: doc/guix.texi:3557 doc/guix.texi:6084 doc/guix.texi:6550 doc/guix.texi:7027 #: doc/guix.texi:14008 #, no-wrap msgid "-m @var{file}" msgstr "" #. type: cindex #: doc/guix.texi:3558 #, no-wrap msgid "profile declaration" msgstr "" #. type: cindex #: doc/guix.texi:3559 #, no-wrap msgid "profile manifest" msgstr "" #. type: table #: doc/guix.texi:3563 msgid "" "Create a new generation of the profile from the manifest object returned by " "the Scheme code in @var{file}. This option can be repeated several times, " "in which case the manifests are concatenated." msgstr "" #. type: table #: doc/guix.texi:3569 msgid "" "This allows you to @emph{declare} the profile's contents rather than " "constructing it through a sequence of @option{--install} and similar " "commands. The advantage is that @var{file} can be put under version " "control, copied to different machines to reproduce the same profile, and so " "on." msgstr "" #. type: table #: doc/guix.texi:3572 msgid "" "@var{file} must return a @dfn{manifest} object, which is roughly a list of " "packages:" msgstr "" #. type: findex #: doc/guix.texi:3573 #, no-wrap msgid "packages->manifest" msgstr "" #. type: lisp #: doc/guix.texi:3576 #, no-wrap msgid "" "(use-package-modules guile emacs)\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:3582 #, 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 "" #. type: table #: doc/guix.texi:3587 msgid "" "@xref{Writing Manifests}, for information on how to write a manifest. " "@xref{export-manifest, @option{--export-manifest}}, to learn how to obtain a " "manifest file from an existing profile." msgstr "" #. type: item #: doc/guix.texi:3588 doc/guix.texi:4716 #, no-wrap msgid "--roll-back" msgstr "" #. type: cindex #: doc/guix.texi:3589 doc/guix.texi:4717 doc/guix.texi:38491 #: doc/guix.texi:41791 #, no-wrap msgid "rolling back" msgstr "" #. type: cindex #: doc/guix.texi:3590 doc/guix.texi:4718 #, no-wrap msgid "undoing transactions" msgstr "" #. type: cindex #: doc/guix.texi:3591 doc/guix.texi:4719 #, no-wrap msgid "transactions, undoing" msgstr "" #. type: table #: doc/guix.texi:3594 msgid "" "Roll back to the previous @dfn{generation} of the profile---i.e., undo the " "last transaction." msgstr "" #. type: table #: doc/guix.texi:3597 msgid "" "When combined with options such as @option{--install}, roll back occurs " "before any other actions." msgstr "" #. type: table #: doc/guix.texi:3601 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 "" #. type: table #: doc/guix.texi:3605 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 "" #. type: item #: doc/guix.texi:3606 doc/guix.texi:4723 #, no-wrap msgid "--switch-generation=@var{pattern}" msgstr "" #. type: itemx #: doc/guix.texi:3607 doc/guix.texi:4724 #, no-wrap msgid "-S @var{pattern}" msgstr "" #. type: cindex #: doc/guix.texi:3608 doc/guix.texi:3841 doc/guix.texi:4725 doc/guix.texi:38449 #, no-wrap msgid "generations" msgstr "" #. type: table #: doc/guix.texi:3610 doc/guix.texi:4727 msgid "Switch to a particular generation defined by @var{pattern}." msgstr "" #. type: table #: doc/guix.texi:3616 doc/guix.texi:4733 msgid "" "@var{pattern} may be either a generation number or a number prefixed with ``" "+'' or ``-''. The latter means: move forward/backward by a specified number " "of generations. For example, if you want to return to the latest generation " "after @option{--roll-back}, use @option{--switch-generation=+1}." msgstr "" #. type: table #: doc/guix.texi:3621 msgid "" "The difference between @option{--roll-back} and @option{--switch-" "generation=-1} is that @option{--switch-generation} will not make a zeroth " "generation, so if a specified generation does not exist, the current " "generation will not be changed." msgstr "" #. type: item #: doc/guix.texi:3622 #, no-wrap msgid "--search-paths[=@var{kind}]" msgstr "" #. type: table #: doc/guix.texi:3628 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 "" #. type: table #: doc/guix.texi:3637 msgid "" "For example, GCC needs the @env{CPATH} and @env{LIBRARY_PATH} environment " "variables to be defined so it can look for headers and libraries in the " "user's profile (@pxref{Environment Variables,,, gcc, Using the GNU Compiler " "Collection (GCC)}). If GCC and, say, the C library are installed in the " "profile, then @option{--search-paths} will suggest setting these variables " "to @file{@var{profile}/include} and @file{@var{profile}/lib}, respectively " "(@pxref{Search Paths}, for info on search path specifications associated " "with packages.)" msgstr "" #. type: table #: doc/guix.texi:3640 msgid "" "The typical use case is to define these environment variables in the shell:" msgstr "" #. type: example #: doc/guix.texi:3643 #, no-wrap msgid "$ eval $(guix package --search-paths)\n" msgstr "" #. type: table #: doc/guix.texi:3649 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 "" #. type: table #: doc/guix.texi:3652 msgid "" "This option can also be used to compute the @emph{combined} search paths of " "several profiles. Consider this example:" msgstr "" #. type: example #: doc/guix.texi:3657 #, 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 "" #. type: table #: doc/guix.texi:3662 msgid "" "The last command above reports about the @env{GUILE_LOAD_PATH} variable, " "even though, taken individually, neither @file{foo} nor @file{bar} would " "lead to that recommendation." msgstr "" #. type: cindex #: doc/guix.texi:3664 #, no-wrap msgid "profile, choosing" msgstr "" #. type: item #: doc/guix.texi:3665 doc/guix.texi:4753 doc/guix.texi:5111 doc/guix.texi:6143 #: doc/guix.texi:6589 #, no-wrap msgid "--profile=@var{profile}" msgstr "" #. type: itemx #: doc/guix.texi:3666 doc/guix.texi:4754 doc/guix.texi:5112 doc/guix.texi:6144 #: doc/guix.texi:6590 #, no-wrap msgid "-p @var{profile}" msgstr "" #. type: table #: doc/guix.texi:3668 msgid "Use @var{profile} instead of the user's default profile." msgstr "" #. type: table #: doc/guix.texi:3673 msgid "" "@var{profile} must be the name of a file that will be created upon " "completion. Concretely, @var{profile} will be a mere symbolic link " "(``symlink'') pointing to the actual profile where packages are installed:" msgstr "" #. type: example #: doc/guix.texi:3679 #, no-wrap msgid "" "$ guix install hello -p ~/code/my-profile\n" "@dots{}\n" "$ ~/code/my-profile/bin/hello\n" "Hello, world!\n" msgstr "" #. type: table #: doc/guix.texi:3683 msgid "" "All it takes to get rid of the profile is to remove this symlink and its " "siblings that point to specific generations:" msgstr "" #. type: example #: doc/guix.texi:3686 #, no-wrap msgid "$ rm ~/code/my-profile ~/code/my-profile-*-link\n" msgstr "" #. type: item #: doc/guix.texi:3688 #, no-wrap msgid "--list-profiles" msgstr "" #. type: table #: doc/guix.texi:3690 msgid "List all the user's profiles:" msgstr "" #. type: example #: doc/guix.texi:3697 #, no-wrap msgid "" "$ guix package --list-profiles\n" "/home/charlie/.guix-profile\n" "/home/charlie/code/my-profile\n" "/home/charlie/code/devel-profile\n" "/home/charlie/tmp/test\n" msgstr "" #. type: table #: doc/guix.texi:3700 msgid "When running as root, list all the profiles of all the users." msgstr "" #. type: cindex #: doc/guix.texi:3701 #, no-wrap msgid "collisions, in a profile" msgstr "" #. type: cindex #: doc/guix.texi:3702 #, no-wrap msgid "colliding packages in profiles" msgstr "" #. type: cindex #: doc/guix.texi:3703 #, no-wrap msgid "profile collisions" msgstr "" #. type: item #: doc/guix.texi:3704 #, no-wrap msgid "--allow-collisions" msgstr "" #. type: table #: doc/guix.texi:3706 msgid "Allow colliding packages in the new profile. Use at your own risk!" msgstr "" #. type: table #: doc/guix.texi:3710 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 "" #. type: item #: doc/guix.texi:3711 doc/guix.texi:4796 doc/guix.texi:7118 #, no-wrap msgid "--bootstrap" msgstr "" #. type: table #: doc/guix.texi:3714 msgid "" "Use the bootstrap Guile to build the profile. This option is only useful to " "distribution developers." msgstr "" #. type: Plain text #: doc/guix.texi:3720 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 "" #. type: item #: doc/guix.texi:3723 #, no-wrap msgid "--search=@var{regexp}" msgstr "" #. type: itemx #: doc/guix.texi:3724 #, no-wrap msgid "-s @var{regexp}" msgstr "" #. type: anchor{#1} #: doc/guix.texi:3726 msgid "guix-search" msgstr "" #. type: cindex #: doc/guix.texi:3726 #, no-wrap msgid "searching for packages" msgstr "" #. type: table #: doc/guix.texi:3732 msgid "" "List the available packages whose name, synopsis, or description matches " "@var{regexp} (in a case-insensitive fashion), sorted by relevance. Print " "all the metadata of matching packages in @code{recutils} format (@pxref{Top, " "GNU recutils databases,, recutils, GNU recutils manual})." msgstr "" #. type: table #: doc/guix.texi:3735 msgid "" "This allows specific fields to be extracted using the @command{recsel} " "command, for instance:" msgstr "" #. type: example #: doc/guix.texi:3741 #, 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 "" #. type: example #: doc/guix.texi:3745 #, no-wrap msgid "" "name: glibc\n" "version: 2.25\n" "relevance: 1\n" "\n" msgstr "" #. type: example #: doc/guix.texi:3749 #, no-wrap msgid "" "name: libgc\n" "version: 7.6.0\n" "relevance: 1\n" msgstr "" #. type: table #: doc/guix.texi:3753 msgid "" "Similarly, to show the name of all the packages available under the terms of " "the GNU@tie{}LGPL version 3:" msgstr "" #. type: example #: doc/guix.texi:3757 #, no-wrap msgid "" "$ guix package -s \"\" | recsel -p name -e 'license ~ \"LGPL 3\"'\n" "name: elfutils\n" "\n" msgstr "" #. type: example #: doc/guix.texi:3760 #, no-wrap msgid "" "name: gmp\n" "@dots{}\n" msgstr "" #. type: table #: doc/guix.texi:3766 msgid "" "It is also possible to refine search results using several @code{-s} flags " "to @command{guix package}, or several arguments to @command{guix search}. " "For example, the following command returns a list of board games (this time " "using the @command{guix search} alias):" msgstr "" #. type: example #: doc/guix.texi:3771 #, no-wrap msgid "" "$ guix search '\\' game | recsel -p name\n" "name: gnubg\n" "@dots{}\n" msgstr "" #. type: table #: doc/guix.texi:3777 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 "" #. type: table #: doc/guix.texi:3781 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 "" #. type: example #: doc/guix.texi:3785 #, no-wrap msgid "" "$ guix search crypto library | \\\n" " recsel -e '! (name ~ \"^(ghc|perl|python|ruby)\")' -p name,synopsis\n" msgstr "" #. type: table #: doc/guix.texi:3790 msgid "" "@xref{Selection Expressions,,, recutils, GNU recutils manual}, for more " "information on @dfn{selection expressions} for @code{recsel -e}." msgstr "" #. type: item #: doc/guix.texi:3791 #, no-wrap msgid "--show=@var{package}" msgstr "" #. type: table #: doc/guix.texi:3795 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 "" #. type: example #: doc/guix.texi:3800 #, no-wrap msgid "" "$ guix package --show=guile | recsel -p name,version\n" "name: guile\n" "version: 3.0.5\n" "\n" msgstr "" #. type: example #: doc/guix.texi:3803 #, no-wrap msgid "" "name: guile\n" "version: 3.0.2\n" "\n" msgstr "" #. type: example #: doc/guix.texi:3807 #, no-wrap msgid "" "name: guile\n" "version: 2.2.7\n" "@dots{}\n" msgstr "" #. type: table #: doc/guix.texi:3811 msgid "" "You may also specify the full name of a package to only get details about a " "specific version of it (this time using the @command{guix show} alias):" msgstr "" #. type: example #: doc/guix.texi:3815 #, no-wrap msgid "" "$ guix show guile@@3.0.5 | recsel -p name,version\n" "name: guile\n" "version: 3.0.5\n" msgstr "" #. type: item #: doc/guix.texi:3817 #, no-wrap msgid "--list-installed[=@var{regexp}]" msgstr "" #. type: itemx #: doc/guix.texi:3818 #, no-wrap msgid "-I [@var{regexp}]" msgstr "" #. type: table #: doc/guix.texi:3822 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 "" #. type: table #: doc/guix.texi:3828 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 "" #. type: item #: doc/guix.texi:3829 #, no-wrap msgid "--list-available[=@var{regexp}]" msgstr "" #. type: itemx #: doc/guix.texi:3830 #, no-wrap msgid "-A [@var{regexp}]" msgstr "" #. type: table #: doc/guix.texi:3834 msgid "" "List packages currently available in the distribution for this system " "(@pxref{GNU Distribution}). When @var{regexp} is specified, list only " "available packages whose name matches @var{regexp}." msgstr "" #. type: table #: doc/guix.texi:3838 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 "" #. type: item #: doc/guix.texi:3839 doc/guix.texi:4699 #, no-wrap msgid "--list-generations[=@var{pattern}]" msgstr "" #. type: itemx #: doc/guix.texi:3840 doc/guix.texi:4700 #, no-wrap msgid "-l [@var{pattern}]" msgstr "" #. type: table #: doc/guix.texi:3846 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 "" #. type: table #: doc/guix.texi:3851 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 "" #. type: table #: doc/guix.texi:3854 msgid "" "When @var{pattern} is used, the command returns only matching generations. " "Valid patterns include:" msgstr "" #. type: item #: doc/guix.texi:3856 #, no-wrap msgid "@emph{Integers and comma-separated integers}. Both patterns denote" msgstr "" #. type: itemize #: doc/guix.texi:3859 msgid "" "generation numbers. For instance, @option{--list-generations=1} returns the " "first one." msgstr "" #. type: itemize #: doc/guix.texi:3862 msgid "" "And @option{--list-generations=1,8,2} outputs three generations in the " "specified order. Neither spaces nor trailing commas are allowed." msgstr "" #. type: item #: doc/guix.texi:3863 #, no-wrap msgid "@emph{Ranges}. @option{--list-generations=2..9} prints the" msgstr "" #. type: itemize #: doc/guix.texi:3866 msgid "" "specified generations and everything in between. Note that the start of a " "range must be smaller than its end." msgstr "" #. type: itemize #: doc/guix.texi:3870 msgid "" "It is also possible to omit the endpoint. For example, @option{--list-" "generations=2..}, returns all generations starting from the second one." msgstr "" #. type: item #: doc/guix.texi:3871 #, no-wrap msgid "@emph{Durations}. You can also get the last @emph{N}@tie{}days, weeks," msgstr "" #. type: itemize #: doc/guix.texi:3875 msgid "" "or months by passing an integer along with the first letter of the " "duration. For example, @option{--list-generations=20d} lists generations " "that are up to 20 days old." msgstr "" #. type: item #: doc/guix.texi:3877 doc/guix.texi:4734 #, no-wrap msgid "--delete-generations[=@var{pattern}]" msgstr "" #. type: itemx #: doc/guix.texi:3878 doc/guix.texi:4735 #, no-wrap msgid "-d [@var{pattern}]" msgstr "" #. type: table #: doc/guix.texi:3881 doc/guix.texi:4738 msgid "" "When @var{pattern} is omitted, delete all generations except the current one." msgstr "" #. type: table #: doc/guix.texi:3887 doc/guix.texi:4744 msgid "" "This command accepts the same patterns as @option{--list-generations}. When " "@var{pattern} is specified, delete the matching generations. When " "@var{pattern} specifies a duration, generations @emph{older} than the " "specified duration match. For instance, @option{--delete-generations=1m} " "deletes generations that are more than one month old." msgstr "" #. type: table #: doc/guix.texi:3890 msgid "" "If the current generation matches, it is @emph{not} deleted. Also, the " "zeroth generation is never deleted." msgstr "" #. type: table #: doc/guix.texi:3893 doc/guix.texi:4749 msgid "" "Note that deleting generations prevents rolling back to them. Consequently, " "this command must be used with care." msgstr "" #. type: cindex #: doc/guix.texi:3894 doc/guix.texi:6096 #, no-wrap msgid "manifest, exporting" msgstr "" #. type: anchor{#1} #: doc/guix.texi:3896 msgid "export-manifest" msgstr "" #. type: item #: doc/guix.texi:3896 doc/guix.texi:6098 #, no-wrap msgid "--export-manifest" msgstr "" #. type: table #: doc/guix.texi:3899 msgid "" "Write to standard output a manifest suitable for @option{--manifest} " "corresponding to the chosen profile(s)." msgstr "" #. type: table #: doc/guix.texi:3903 msgid "" "This option is meant to help you migrate from the ``imperative'' operating " "mode---running @command{guix install}, @command{guix upgrade}, etc.---to the " "declarative mode that @option{--manifest} offers." msgstr "" #. type: table #: doc/guix.texi:3908 msgid "" "Be aware that the resulting manifest @emph{approximates} what your profile " "actually contains; for instance, depending on how your profile was created, " "it can refer to packages or package versions that are not exactly what you " "specified." msgstr "" #. type: table #: doc/guix.texi:3913 msgid "" "Keep in mind that a manifest is purely symbolic: it only contains package " "names and possibly versions, and their meaning varies over time. If you " "wish to ``pin'' channels to the revisions that were used to build the " "profile(s), see @option{--export-channels} below." msgstr "" #. type: cindex #: doc/guix.texi:3914 #, no-wrap msgid "pinning, channel revisions of a profile" msgstr "" #. type: item #: doc/guix.texi:3915 #, no-wrap msgid "--export-channels" msgstr "" #. type: table #: doc/guix.texi:3919 msgid "" "Write to standard output the list of channels used by the chosen profile(s), " "in a format suitable for @command{guix pull --channels} or @command{guix " "time-machine --channels} (@pxref{Channels})." msgstr "" #. type: table #: doc/guix.texi:3923 msgid "" "Together with @option{--export-manifest}, this option provides information " "allowing you to replicate the current profile (@pxref{Replicating Guix})." msgstr "" #. type: table #: doc/guix.texi:3931 msgid "" "However, note that the output of this command @emph{approximates} what was " "actually used to build this profile. In particular, a single profile might " "have been built from several different revisions of the same channel. In " "that case, @option{--export-manifest} chooses the last one and writes the " "list of other revisions in a comment. If you really need to pick packages " "from different channel revisions, you can use inferiors in your manifest to " "do so (@pxref{Inferiors})." msgstr "" #. type: table #: doc/guix.texi:3936 msgid "" "Together with @option{--export-manifest}, this is a good starting point if " "you are willing to migrate from the ``imperative'' model to the fully " "declarative model consisting of a manifest file along with a channels file " "pinning the exact channel revision(s) you want." msgstr "" #. type: Plain text #: doc/guix.texi:3943 msgid "" "Finally, since @command{guix package} may actually start build processes, it " "supports all the common build options (@pxref{Common Build Options}). It " "also supports package transformation options, such as @option{--with-" "source}, and preserves them across upgrades (@pxref{Package Transformation " "Options})." msgstr "" #. type: cindex #: doc/guix.texi:3948 #, no-wrap msgid "pre-built binaries" msgstr "" #. type: Plain text #: doc/guix.texi:3954 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 "" #. type: Plain text #: doc/guix.texi:3959 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 "" #. type: cindex #: doc/guix.texi:3973 #, no-wrap msgid "build farm" msgstr "" #. type: Plain text #: doc/guix.texi:3984 msgid "" "@code{@value{SUBSTITUTE-SERVER-1}} and @code{@value{SUBSTITUTE-SERVER-2}} " "are both front-ends to official build farms that build packages from Guix " "continuously for some architectures, and make them available as " "substitutes. These are the default source of substitutes; which 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 "" #. type: Plain text #: doc/guix.texi:3990 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 "" #. type: Plain text #: doc/guix.texi:3999 msgid "" "Substitutes from the official build farms are enabled by default when using " "Guix System (@pxref{GNU Distribution}). However, they are disabled by " "default when using Guix on a foreign distribution, unless you have " "explicitly enabled them via one of the recommended installation steps " "(@pxref{Installation}). The following paragraphs describe how to enable or " "disable substitutes for the official build farm; the same procedure can also " "be used to enable substitutes for any other substitute server." msgstr "" #. type: cindex #: doc/guix.texi:4003 #, no-wrap msgid "security" msgstr "" #. type: cindex #: doc/guix.texi:4005 #, no-wrap msgid "access control list (ACL), for substitutes" msgstr "" #. type: cindex #: doc/guix.texi:4006 #, no-wrap msgid "ACL (access control list), for substitutes" msgstr "" #. type: Plain text #: doc/guix.texi:4012 msgid "" "To allow Guix to download substitutes from @code{@value{SUBSTITUTE-" "SERVER-1}}, @code{@value{SUBSTITUTE-SERVER-2}} or a mirror, you must add the " "relevant 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 the substitute server to not be compromised " "and to serve genuine substitutes." msgstr "" #. type: quotation #: doc/guix.texi:4017 msgid "" "If you are using Guix System, you can skip this section: Guix System " "authorizes substitutes from @code{@value{SUBSTITUTE-SERVER-1}} and " "@code{@value{SUBSTITUTE-SERVER-2}} by default." msgstr "" #. type: Plain text #: doc/guix.texi:4025 msgid "" "The public keys for each of the project maintained substitute servers are " "installed along with Guix, in @code{@var{prefix}/share/guix/}, 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 "" #. type: example #: doc/guix.texi:4029 #, no-wrap msgid "" "# guix archive --authorize < @var{prefix}/share/guix/@value{SUBSTITUTE-SERVER-1}.pub\n" "# guix archive --authorize < @var{prefix}/share/guix/@value{SUBSTITUTE-SERVER-2}.pub\n" msgstr "" #. type: Plain text #: doc/guix.texi:4033 msgid "" "Once this is in place, the output of a command like @code{guix build} should " "change from something like:" msgstr "" #. type: example #: doc/guix.texi:4042 #, 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 "" #. type: Plain text #: doc/guix.texi:4046 msgid "to something like:" msgstr "" #. type: example #: doc/guix.texi:4055 #, 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 "" #. type: Plain text #: doc/guix.texi:4062 msgid "" "The text changed from ``The following derivations would be built'' to " "``112.3 MB would be downloaded''. This indicates that substitutes from the " "configured substitute servers are usable and will be downloaded, when " "possible, for future builds." msgstr "" #. type: cindex #: doc/guix.texi:4063 #, no-wrap msgid "substitutes, how to disable" msgstr "" #. type: Plain text #: doc/guix.texi:4069 msgid "" "The substitute mechanism can be disabled globally by running @code{guix-" "daemon} with @option{--no-substitutes} (@pxref{Invoking guix-daemon}). It " "can also be disabled temporarily by passing the @option{--no-substitutes} " "option to @command{guix package}, @command{guix build}, and other command-" "line tools." msgstr "" #. type: cindex #: doc/guix.texi:4073 #, no-wrap msgid "substitute servers, adding more" msgstr "" #. type: Plain text #: doc/guix.texi:4080 msgid "" "Guix can look up and fetch substitutes from several servers. This is useful " "when you are using packages from additional channels for which the official " "server does not have substitutes but another server provides them. Another " "situation where this is useful is when you would prefer to download from " "your organization's substitute server, resorting to the official server only " "as a fallback or dismissing it altogether." msgstr "" #. type: Plain text #: doc/guix.texi:4085 msgid "" "You can give Guix a list of substitute server URLs and it will check them in " "the specified order. You also need to explicitly authorize the public keys " "of substitute servers to instruct Guix to accept the substitutes they sign." msgstr "" #. type: Plain text #: doc/guix.texi:4092 msgid "" "On Guix System, this is achieved by modifying the configuration of the " "@code{guix} service. Since the @code{guix} service is part of the default " "lists of services, @code{%base-services} and @code{%desktop-services}, you " "can use @code{modify-services} to change its configuration and add the URLs " "and substitute keys that you want (@pxref{Service Reference, @code{modify-" "services}})." msgstr "" #. type: Plain text #: doc/guix.texi:4098 msgid "" "As an example, suppose you want to fetch substitutes from @code{guix.example." "org} and to authorize the signing key of that server, in addition to the " "default @code{@value{SUBSTITUTE-SERVER-1}} and @code{@value{SUBSTITUTE-" "SERVER-2}}. The resulting operating system configuration will look " "something like:" msgstr "" #. type: lisp #: doc/guix.texi:4115 #, no-wrap msgid "" "(operating-system\n" " ;; @dots{}\n" " (services\n" " ;; Assume we're starting from '%desktop-services'. Replace it\n" " ;; with the list of services you're actually using.\n" " (modify-services %desktop-services\n" " (guix-service-type config =>\n" " (guix-configuration\n" " (inherit config)\n" " (substitute-urls\n" " (append (list \"https://guix.example.org\")\n" " %default-substitute-urls))\n" " (authorized-keys\n" " (append (list (local-file \"./key.pub\"))\n" " %default-authorized-guix-keys)))))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:4122 msgid "" "This assumes that the file @file{key.pub} contains the signing key of " "@code{guix.example.org}. With this change in place in your operating system " "configuration file (say @file{/etc/config.scm}), you can reconfigure and " "restart the @code{guix-daemon} service or reboot so the changes take effect:" msgstr "" #. type: example #: doc/guix.texi:4126 #, no-wrap msgid "" "$ sudo guix system reconfigure /etc/config.scm\n" "$ sudo herd restart guix-daemon\n" msgstr "" #. type: Plain text #: doc/guix.texi:4130 msgid "" "If you're running Guix on a ``foreign distro'', you would instead take the " "following steps to get substitutes from additional servers:" msgstr "" #. type: enumerate #: doc/guix.texi:4139 msgid "" "Edit the service configuration file for @code{guix-daemon}; when using " "systemd, this is normally @file{/etc/systemd/system/guix-daemon.service}. " "Add the @option{--substitute-urls} option on the @command{guix-daemon} " "command line and list the URLs of interest (@pxref{daemon-substitute-urls, " "@code{guix-daemon --substitute-urls}}):" msgstr "" #. type: example #: doc/guix.texi:4142 #, no-wrap msgid "@dots{} --substitute-urls='https://guix.example.org @value{SUBSTITUTE-URLS}'\n" msgstr "" #. type: enumerate #: doc/guix.texi:4146 msgid "Restart the daemon. For systemd, it goes like this:" msgstr "" #. type: example #: doc/guix.texi:4150 #, no-wrap msgid "" "systemctl daemon-reload\n" "systemctl restart guix-daemon.service\n" msgstr "" #. type: enumerate #: doc/guix.texi:4154 msgid "Authorize the key of the new server (@pxref{Invoking guix archive}):" msgstr "" #. type: example #: doc/guix.texi:4157 #, no-wrap msgid "guix archive --authorize < key.pub\n" msgstr "" #. type: enumerate #: doc/guix.texi:4161 msgid "" "Again this assumes @file{key.pub} contains the public key that @code{guix." "example.org} uses to sign substitutes." msgstr "" #. type: Plain text #: doc/guix.texi:4170 msgid "" "Now you're all set! Substitutes will be preferably taken from @code{https://" "guix.example.org}, using @code{@value{SUBSTITUTE-SERVER-1}} then " "@code{@value{SUBSTITUTE-SERVER-2}} as fallback options. Of course you can " "list as many substitute servers as you like, with the caveat that substitute " "lookup can be slowed down if too many servers need to be contacted." msgstr "" #. type: Plain text #: doc/guix.texi:4174 msgid "" "Note that there are also situations where one may want to add the URL of a " "substitute server @emph{without} authorizing its key. @xref{Substitute " "Authentication}, to understand this fine point." msgstr "" #. type: cindex #: doc/guix.texi:4178 #, no-wrap msgid "digital signatures" msgstr "" #. type: Plain text #: doc/guix.texi:4182 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 "" #. type: Plain text #: doc/guix.texi:4188 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 "" #. type: example #: doc/guix.texi:4191 #, no-wrap msgid "--substitute-urls=\"https://a.example.org https://b.example.org\"\n" msgstr "" #. type: Plain text #: doc/guix.texi:4202 msgid "" "If the ACL contains only the key for @samp{b.example.org}, and if @samp{a." "example.org} happens to serve the @emph{exact same} substitutes, then Guix " "will download substitutes from @samp{a.example.org} because it comes first " "in the list and can be considered a mirror of @samp{b.example.org}. In " "practice, independent build machines usually produce the same binaries, " "thanks to bit-reproducible builds (see below)." msgstr "" #. type: Plain text #: doc/guix.texi:4209 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 "" #. type: Plain text #: doc/guix.texi:4221 msgid "" "Substitutes are downloaded over HTTP or HTTPS@. The @env{http_proxy} and " "@env{https_proxy} environment variables can be set in the environment of " "@command{guix-daemon} and are honored for downloads of substitutes. Note " "that the value of those environment variables in the environment where " "@command{guix build}, @command{guix package}, and other client commands are " "run has @emph{absolutely no effect}." msgstr "" #. type: Plain text #: doc/guix.texi:4230 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 "" #. type: Plain text #: doc/guix.texi:4244 msgid "" "When substitutes are enabled and a substitute for a derivation is available, " "but the substitution attempt fails, Guix will attempt to build the " "derivation locally depending on whether or not @option{--fallback} was given " "(@pxref{fallback-option,, common build option @option{--fallback}}). " "Specifically, if @option{--fallback} was omitted, then no local build will " "be performed, and the derivation is considered to have failed. However, if " "@option{--fallback} was given, then Guix will attempt to build the " "derivation locally, and the success or failure of the derivation depends on " "the success or failure of the local build. Note that when substitutes are " "disabled or no substitute is available for the derivation in question, a " "local build will @emph{always} be performed, regardless of whether or not " "@option{--fallback} was given." msgstr "" #. type: Plain text #: doc/guix.texi:4249 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 "" #. type: cindex #: doc/guix.texi:4253 #, no-wrap msgid "trust, of pre-built binaries" msgstr "" #. type: Plain text #: doc/guix.texi:4263 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 substitutes can be convenient, we encourage users to also build on " "their own, or even run their own build farm, such that the project run " "substitute servers are 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 "" #. type: Plain text #: doc/guix.texi:4275 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 "" #. type: Plain text #: doc/guix.texi:4279 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 "" #. type: cindex #: doc/guix.texi:4283 #, no-wrap msgid "multiple-output packages" msgstr "" #. type: cindex #: doc/guix.texi:4284 #, no-wrap msgid "package outputs" msgstr "" #. type: cindex #: doc/guix.texi:4285 #, no-wrap msgid "outputs" msgstr "" #. type: Plain text #: doc/guix.texi:4295 msgid "" "Often, packages defined in Guix have a single @dfn{output}---i.e., the " "source package leads to exactly one directory in the store. When running " "@command{guix install glibc}, one installs the default output of the GNU " "libc package; the default output is called @code{out}, but its name can be " "omitted as shown in this command. In this particular case, the default " "output of @code{glibc} contains all the C header files, shared libraries, " "static libraries, Info documentation, and other supporting files." msgstr "" #. type: Plain text #: doc/guix.texi:4303 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 "" #. type: example #: doc/guix.texi:4306 #, no-wrap msgid "guix install glib\n" msgstr "" #. #-#-#-#-# guix.pot (guix manual 1.4.0rc1) #-#-#-#-# #. type: item #. #-#-#-#-# contributing.pot (guix manual 1.4.0rc1) #-#-#-#-# #. type: cindex #: doc/guix.texi:4308 doc/guix.texi:39931 doc/guix.texi:39988 #: doc/contributing.texi:1979 #, no-wrap msgid "documentation" msgstr "" #. type: Plain text #: doc/guix.texi:4310 msgid "The command to install its documentation is:" msgstr "" #. type: example #: doc/guix.texi:4313 #, no-wrap msgid "guix install glib:doc\n" msgstr "" #. type: Plain text #: doc/guix.texi:4324 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 "" #. type: Plain text #: doc/guix.texi:4332 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 "" #. type: section #: doc/guix.texi:4335 #, no-wrap msgid "Invoking @command{guix gc}" msgstr "" #. type: cindex #: doc/guix.texi:4337 #, no-wrap msgid "garbage collector" msgstr "" #. type: cindex #: doc/guix.texi:4338 #, no-wrap msgid "disk space" msgstr "" #. type: command{#1} #: doc/guix.texi:4339 #, no-wrap msgid "guix gc" msgstr "" #. type: Plain text #: doc/guix.texi:4345 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 "" #. type: Plain text #: doc/guix.texi:4356 msgid "" "The garbage collector has a set of known @dfn{roots}: any file under @file{/" "gnu/store} reachable from a root is considered @dfn{live} and cannot be " "deleted; any other file is considered @dfn{dead} and may be deleted. The " "set of garbage collector roots (``GC roots'' for short) includes default " "user profiles; by default, the symlinks under @file{/var/guix/gcroots} " "represent these GC roots. New GC roots can be added with @command{guix " "build --root}, for example (@pxref{Invoking guix build}). The @command{guix " "gc --list-roots} command lists them." msgstr "" #. type: Plain text #: doc/guix.texi:4362 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 "" #. type: Plain text #: doc/guix.texi:4366 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 "" #. type: example #: doc/guix.texi:4369 #, no-wrap msgid "guix gc -F 5G\n" msgstr "" #. type: Plain text #: doc/guix.texi:4378 msgid "" "It is perfectly safe to run as a non-interactive periodic job " "(@pxref{Scheduled Job Execution}, for how to set up such a job). Running " "@command{guix gc} with no arguments will collect as much garbage as it can, " "but that is often inconvenient: you may find yourself having to rebuild or " "re-download software that is ``dead'' from the GC viewpoint but that is " "necessary to build other pieces of software---e.g., the compiler tool chain." msgstr "" #. type: Plain text #: doc/guix.texi:4384 msgid "" "The @command{guix gc} command has three modes of operation: it can be used " "to garbage-collect any dead files (the default), to delete specific files " "(the @option{--delete} option), to print garbage-collector information, or " "for more advanced queries. The garbage collection options are as follows:" msgstr "" #. type: item #: doc/guix.texi:4386 #, no-wrap msgid "--collect-garbage[=@var{min}]" msgstr "" #. type: itemx #: doc/guix.texi:4387 #, no-wrap msgid "-C [@var{min}]" msgstr "" #. type: table #: doc/guix.texi:4391 msgid "" "Collect garbage---i.e., unreachable @file{/gnu/store} files and sub-" "directories. This is the default operation when no option is specified." msgstr "" #. type: table #: doc/guix.texi:4396 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 "" #. type: table #: doc/guix.texi:4398 msgid "When @var{min} is omitted, collect all the garbage." msgstr "" #. type: item #: doc/guix.texi:4399 #, no-wrap msgid "--free-space=@var{free}" msgstr "" #. type: itemx #: doc/guix.texi:4400 #, no-wrap msgid "-F @var{free}" msgstr "" #. type: table #: doc/guix.texi:4404 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 "" #. type: table #: doc/guix.texi:4407 msgid "" "When @var{free} or more is already available in @file{/gnu/store}, do " "nothing and exit immediately." msgstr "" #. type: item #: doc/guix.texi:4408 #, no-wrap msgid "--delete-generations[=@var{duration}]" msgstr "" #. type: itemx #: doc/guix.texi:4409 #, no-wrap msgid "-d [@var{duration}]" msgstr "" #. type: table #: doc/guix.texi:4414 msgid "" "Before starting the garbage collection process, delete all the generations " "older than @var{duration}, for all the user profiles and home environment " "generations; when run as root, this applies to all the profiles @emph{of all " "the users}." msgstr "" #. type: table #: doc/guix.texi:4418 msgid "" "For example, this command deletes all the generations of all your profiles " "that are older than 2 months (except generations that are current), and then " "proceeds to free space until at least 10 GiB are available:" msgstr "" #. type: example #: doc/guix.texi:4421 #, no-wrap msgid "guix gc -d 2m -F 10G\n" msgstr "" #. type: item #: doc/guix.texi:4423 #, no-wrap msgid "--delete" msgstr "" #. type: itemx #: doc/guix.texi:4424 doc/guix.texi:6019 #, no-wrap msgid "-D" msgstr "" #. type: table #: doc/guix.texi:4428 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 "" #. type: item #: doc/guix.texi:4429 #, no-wrap msgid "--list-failures" msgstr "" #. type: table #: doc/guix.texi:4431 msgid "List store items corresponding to cached build failures." msgstr "" #. type: table #: doc/guix.texi:4435 msgid "" "This prints nothing unless the daemon was started with @option{--cache-" "failures} (@pxref{Invoking guix-daemon, @option{--cache-failures}})." msgstr "" #. type: item #: doc/guix.texi:4436 #, no-wrap msgid "--list-roots" msgstr "" #. type: table #: doc/guix.texi:4439 msgid "" "List the GC roots owned by the user; when run as root, list @emph{all} the " "GC roots." msgstr "" #. type: item #: doc/guix.texi:4440 #, no-wrap msgid "--list-busy" msgstr "" #. type: table #: doc/guix.texi:4443 msgid "" "List store items in use by currently running processes. These store items " "are effectively considered GC roots: they cannot be deleted." msgstr "" #. type: item #: doc/guix.texi:4444 #, no-wrap msgid "--clear-failures" msgstr "" #. type: table #: doc/guix.texi:4446 msgid "Remove the specified store items from the failed-build cache." msgstr "" #. type: table #: doc/guix.texi:4449 msgid "" "Again, this option only makes sense when the daemon is started with " "@option{--cache-failures}. Otherwise, it does nothing." msgstr "" #. type: item #: doc/guix.texi:4450 #, no-wrap msgid "--list-dead" msgstr "" #. type: table #: doc/guix.texi:4453 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 "" #. type: item #: doc/guix.texi:4454 #, no-wrap msgid "--list-live" msgstr "" #. type: table #: doc/guix.texi:4456 msgid "Show the list of live store files and directories." msgstr "" #. type: Plain text #: doc/guix.texi:4460 msgid "In addition, the references among existing store files can be queried:" msgstr "" #. type: item #: doc/guix.texi:4463 #, no-wrap msgid "--references" msgstr "" #. type: itemx #: doc/guix.texi:4464 #, no-wrap msgid "--referrers" msgstr "" #. type: cindex #: doc/guix.texi:4465 doc/guix.texi:14760 #, no-wrap msgid "package dependencies" msgstr "" #. type: table #: doc/guix.texi:4468 msgid "" "List the references (respectively, the referrers) of store files given as " "arguments." msgstr "" #. type: item #: doc/guix.texi:4469 #, no-wrap msgid "--requisites" msgstr "" #. type: itemx #: doc/guix.texi:4470 doc/guix.texi:6911 #, no-wrap msgid "-R" msgstr "" #. type: item #: doc/guix.texi:4471 doc/guix.texi:14616 doc/guix.texi:14644 #: doc/guix.texi:14725 #, no-wrap msgid "closure" msgstr "" #. type: table #: doc/guix.texi:4476 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 "" #. type: table #: doc/guix.texi:4480 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 "" #. type: item #: doc/guix.texi:4481 #, no-wrap msgid "--derivers" msgstr "" #. type: item #: doc/guix.texi:4482 doc/guix.texi:7234 doc/guix.texi:14462 #: doc/guix.texi:14869 #, no-wrap msgid "derivation" msgstr "" #. type: table #: doc/guix.texi:4485 msgid "" "Return the derivation(s) leading to the given store items " "(@pxref{Derivations})." msgstr "" #. type: table #: doc/guix.texi:4487 msgid "For example, this command:" msgstr "" #. type: example #: doc/guix.texi:4490 #, no-wrap msgid "guix gc --derivers $(guix package -I ^emacs$ | cut -f4)\n" msgstr "" #. type: table #: doc/guix.texi:4495 msgid "" "returns the @file{.drv} file(s) leading to the @code{emacs} package " "installed in your profile." msgstr "" #. type: table #: doc/guix.texi:4499 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 "" #. type: Plain text #: doc/guix.texi:4503 msgid "" "Lastly, the following options allow you to check the integrity of the store " "and to control disk usage." msgstr "" #. type: item #: doc/guix.texi:4506 #, no-wrap msgid "--verify[=@var{options}]" msgstr "" #. type: cindex #: doc/guix.texi:4507 #, no-wrap msgid "integrity, of the store" msgstr "" #. type: cindex #: doc/guix.texi:4508 #, no-wrap msgid "integrity checking" msgstr "" #. type: table #: doc/guix.texi:4510 msgid "Verify the integrity of the store." msgstr "" #. type: table #: doc/guix.texi:4513 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 "" #. type: table #: doc/guix.texi:4516 msgid "" "When provided, @var{options} must be a comma-separated list containing one " "or more of @code{contents} and @code{repair}." msgstr "" #. type: table #: doc/guix.texi:4522 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 "" #. type: cindex #: doc/guix.texi:4523 #, no-wrap msgid "repairing the store" msgstr "" #. type: cindex #: doc/guix.texi:4524 doc/guix.texi:12977 #, no-wrap msgid "corruption, recovering from" msgstr "" #. type: table #: doc/guix.texi:4532 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 "" #. type: item #: doc/guix.texi:4533 #, no-wrap msgid "--optimize" msgstr "" #. type: table #: doc/guix.texi:4537 msgid "" "Optimize the store by hard-linking identical files---this is " "@dfn{deduplication}." msgstr "" #. type: table #: doc/guix.texi:4543 msgid "" "The daemon performs deduplication after each successful build or archive " "import, unless it was started with @option{--disable-deduplication} " "(@pxref{Invoking guix-daemon, @option{--disable-deduplication}}). Thus, " "this option is primarily useful when the daemon was running with @option{--" "disable-deduplication}." msgstr "" #. type: item #: doc/guix.texi:4544 #, no-wrap msgid "--vacuum-database" msgstr "" #. type: cindex #: doc/guix.texi:4545 #, no-wrap msgid "vacuum the store database" msgstr "" #. type: table #: doc/guix.texi:4555 msgid "" "Guix uses an sqlite database to keep track of the items in (@pxref{The " "Store}). Over time it is possible that the database may grow to a large " "size and become fragmented. As a result, one may wish to clear the freed " "space and join the partially used pages in the database left behind from " "removed packages or after running the garbage collector. Running " "@command{sudo guix gc --vacuum-database} will lock the database and " "@code{VACUUM} the store, defragmenting the database and purging freed pages, " "unlocking the database when it finishes." msgstr "" #. type: section #: doc/guix.texi:4559 #, no-wrap msgid "Invoking @command{guix pull}" msgstr "" #. type: cindex #: doc/guix.texi:4561 #, no-wrap msgid "upgrading Guix" msgstr "" #. type: cindex #: doc/guix.texi:4562 #, no-wrap msgid "updating Guix" msgstr "" #. type: command{#1} #: doc/guix.texi:4563 #, no-wrap msgid "guix pull" msgstr "" #. type: cindex #: doc/guix.texi:4564 #, no-wrap msgid "pull" msgstr "" #. type: cindex #: doc/guix.texi:4565 #, no-wrap msgid "security, @command{guix pull}" msgstr "" #. type: cindex #: doc/guix.texi:4566 #, no-wrap msgid "authenticity, of code obtained with @command{guix pull}" msgstr "" #. type: Plain text #: doc/guix.texi:4576 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/" "book/en/, Git} repository, by default the official GNU@tie{}Guix repository, " "though this can be customized. @command{guix pull} ensures that the code it " "downloads is @emph{authentic} by verifying that commits are signed by Guix " "developers." msgstr "" #. type: Plain text #: doc/guix.texi:4579 msgid "" "Specifically, @command{guix pull} downloads code from the @dfn{channels} " "(@pxref{Channels}) specified by one of the followings, in this order:" msgstr "" #. type: enumerate #: doc/guix.texi:4583 msgid "the @option{--channels} option;" msgstr "" #. type: enumerate #: doc/guix.texi:4585 msgid "the user's @file{~/.config/guix/channels.scm} file;" msgstr "" #. type: enumerate #: doc/guix.texi:4587 msgid "the system-wide @file{/etc/guix/channels.scm} file;" msgstr "" #. type: enumerate #: doc/guix.texi:4590 msgid "" "the built-in default channels specified in the @code{%default-channels} " "variable." msgstr "" #. type: Plain text #: doc/guix.texi:4597 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 "" #. type: Plain text #: doc/guix.texi:4603 msgid "" "Any user can update their Guix copy using @command{guix pull}, and the " "effect is limited to the user who ran @command{guix pull}. For instance, " "when user @code{root} runs @command{guix pull}, this has no effect on the " "version of Guix that user @code{alice} sees, and vice versa." msgstr "" #. type: Plain text #: doc/guix.texi:4609 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 "" #. type: example #: doc/guix.texi:4613 #, no-wrap msgid "" "export PATH=\"$HOME/.config/guix/current/bin:$PATH\"\n" "export INFOPATH=\"$HOME/.config/guix/current/share/info:$INFOPATH\"\n" msgstr "" #. type: Plain text #: doc/guix.texi:4617 msgid "" "The @option{--list-generations} or @option{-l} option lists past generations " "produced by @command{guix pull}, along with details about their provenance:" msgstr "" #. type: example #: doc/guix.texi:4625 #, 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 "" #. type: example #: doc/guix.texi:4631 #, no-wrap 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 "" #. type: example #: doc/guix.texi:4637 #, 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" msgstr "" #. type: Plain text #: doc/guix.texi:4641 msgid "" "@xref{Invoking guix describe, @command{guix describe}}, for other ways to " "describe the current status of Guix." msgstr "" #. type: Plain text #: doc/guix.texi:4646 msgid "" "This @code{~/.config/guix/current} profile works exactly like the profiles " "created by @command{guix package} (@pxref{Invoking guix package}). That is, " "you can list generations, roll back to the previous generation---i.e., the " "previous Guix---and so on:" msgstr "" #. type: example #: doc/guix.texi:4652 #, no-wrap msgid "" "$ guix pull --roll-back\n" "switched from generation 3 to 2\n" "$ guix pull --delete-generations=1\n" "deleting /var/guix/profiles/per-user/charlie/current-guix-1-link\n" msgstr "" #. type: Plain text #: doc/guix.texi:4656 msgid "" "You can also use @command{guix package} (@pxref{Invoking guix package}) to " "manage the profile by naming it explicitly:" msgstr "" #. type: example #: doc/guix.texi:4661 #, 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 /var/guix/profiles/per-user/charlie/current-guix-1-link\n" msgstr "" #. type: Plain text #: doc/guix.texi:4665 msgid "" "The @command{guix pull} command is usually invoked with no arguments, but it " "supports the following options:" msgstr "" #. type: item #: doc/guix.texi:4667 doc/guix.texi:4863 #, no-wrap msgid "--url=@var{url}" msgstr "" #. type: itemx #: doc/guix.texi:4668 doc/guix.texi:4864 #, no-wrap msgid "--commit=@var{commit}" msgstr "" #. type: itemx #: doc/guix.texi:4669 doc/guix.texi:4865 #, no-wrap msgid "--branch=@var{branch}" msgstr "" #. type: table #: doc/guix.texi:4673 msgid "" "Download code for the @code{guix} channel from the specified @var{url}, at " "the given @var{commit} (a valid Git commit ID represented as a hexadecimal " "string or the name of a tag), or @var{branch}." msgstr "" #. type: cindex #: doc/guix.texi:4674 doc/guix.texi:5312 #, no-wrap msgid "@file{channels.scm}, configuration file" msgstr "" #. type: cindex #: doc/guix.texi:4675 doc/guix.texi:5313 #, no-wrap msgid "configuration file for channels" msgstr "" #. type: table #: doc/guix.texi:4679 msgid "" "These options are provided for convenience, but you can also specify your " "configuration in the @file{~/.config/guix/channels.scm} file or using the " "@option{--channels} option (see below)." msgstr "" #. type: item #: doc/guix.texi:4680 doc/guix.texi:4870 #, no-wrap msgid "--channels=@var{file}" msgstr "" #. type: itemx #: doc/guix.texi:4681 doc/guix.texi:4871 #, no-wrap msgid "-C @var{file}" msgstr "" #. type: table #: doc/guix.texi:4687 msgid "" "Read the list of channels from @var{file} instead of @file{~/.config/guix/" "channels.scm} or @file{/etc/guix/channels.scm}. @var{file} must contain " "Scheme code that evaluates to a list of channel objects. @xref{Channels}, " "for more information." msgstr "" #. type: cindex #: doc/guix.texi:4688 #, no-wrap msgid "channel news" msgstr "" #. type: item #: doc/guix.texi:4689 #, no-wrap msgid "--news" msgstr "" #. type: itemx #: doc/guix.texi:4690 doc/guix.texi:6193 doc/guix.texi:6639 doc/guix.texi:38803 #: doc/guix.texi:41669 #, no-wrap msgid "-N" msgstr "" #. type: table #: doc/guix.texi:4695 msgid "" "Display news written by channel authors for their users for changes made " "since the previous generation (@pxref{Channels, Writing Channel News}). " "When @option{--details} is passed, additionally display new and upgraded " "packages." msgstr "" #. type: table #: doc/guix.texi:4698 msgid "" "You can view that information for previous generations with @command{guix " "pull -l}." msgstr "" #. type: table #: doc/guix.texi:4705 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:4710 msgid "" "By default, this prints information about the channels used in each revision " "as well as the corresponding news entries. If you pass @option{--details}, " "it will also print the list of packages added and upgraded in each " "generation compared to the previous one." msgstr "" #. type: item #: doc/guix.texi:4711 #, no-wrap msgid "--details" msgstr "" #. type: table #: doc/guix.texi:4715 msgid "" "Instruct @option{--list-generations} or @option{--news} to display more " "information about the differences between subsequent generations---see above." msgstr "" #. type: table #: doc/guix.texi:4722 msgid "" "Roll back to the previous @dfn{generation} of @file{~/.config/guix/" "current}---i.e., undo the last transaction." msgstr "" #. type: table #: doc/guix.texi:4746 msgid "If the current generation matches, it is @emph{not} deleted." msgstr "" #. type: table #: doc/guix.texi:4752 msgid "" "@xref{Invoking guix describe}, for a way to display information about the " "current generation only." msgstr "" #. type: table #: doc/guix.texi:4756 msgid "Use @var{profile} instead of @file{~/.config/guix/current}." msgstr "" #. type: item #: doc/guix.texi:4757 doc/guix.texi:12297 doc/guix.texi:14333 #, no-wrap msgid "--dry-run" msgstr "" #. type: itemx #: doc/guix.texi:4758 doc/guix.texi:12298 doc/guix.texi:14334 #: doc/guix.texi:14598 #, no-wrap msgid "-n" msgstr "" #. type: table #: doc/guix.texi:4761 msgid "" "Show which channel commit(s) would be used and what would be built or " "substituted but do not actually do it." msgstr "" #. type: item #: doc/guix.texi:4762 doc/guix.texi:38822 doc/guix.texi:41916 #, no-wrap msgid "--allow-downgrades" msgstr "" #. type: table #: doc/guix.texi:4765 msgid "" "Allow pulling older or unrelated revisions of channels than those currently " "in use." msgstr "" #. type: cindex #: doc/guix.texi:4766 #, no-wrap msgid "downgrade attacks, protection against" msgstr "" #. type: table #: doc/guix.texi:4771 msgid "" "By default, @command{guix pull} protects against so-called ``downgrade " "attacks'' whereby the Git repository of a channel would be reset to an " "earlier or unrelated revision of itself, potentially leading you to install " "older, known-vulnerable versions of software packages." msgstr "" #. type: quotation #: doc/guix.texi:4775 doc/guix.texi:38836 msgid "" "Make sure you understand its security implications before using @option{--" "allow-downgrades}." msgstr "" #. type: item #: doc/guix.texi:4777 #, no-wrap msgid "--disable-authentication" msgstr "" #. type: table #: doc/guix.texi:4779 msgid "Allow pulling channel code without authenticating it." msgstr "" #. type: cindex #: doc/guix.texi:4780 doc/guix.texi:5473 #, no-wrap msgid "authentication, of channel code" msgstr "" #. type: table #: doc/guix.texi:4785 msgid "" "By default, @command{guix pull} authenticates code downloaded from channels " "by verifying that its commits are signed by authorized developers, and " "raises an error if this is not the case. This option instructs it to not " "perform any such verification." msgstr "" #. type: quotation #: doc/guix.texi:4789 msgid "" "Make sure you understand its security implications before using @option{--" "disable-authentication}." msgstr "" #. type: itemx #: doc/guix.texi:4792 doc/guix.texi:6176 doc/guix.texi:6622 doc/guix.texi:7046 #: doc/guix.texi:12911 doc/guix.texi:14743 doc/guix.texi:15008 #: doc/guix.texi:15698 doc/guix.texi:38746 #, no-wrap msgid "-s @var{system}" msgstr "" #. type: table #: doc/guix.texi:4795 doc/guix.texi:7049 msgid "" "Attempt to build for @var{system}---e.g., @code{i686-linux}---instead of the " "system type of the build host." msgstr "" #. type: table #: doc/guix.texi:4799 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:4805 msgid "" "The @dfn{channel} mechanism allows you to instruct @command{guix pull} which " "repository and branch to pull from, as well as @emph{additional} " "repositories containing package modules that should be deployed. " "@xref{Channels}, for more information." msgstr "" #. type: Plain text #: doc/guix.texi:4808 msgid "" "In addition, @command{guix pull} supports all the common build options " "(@pxref{Common Build Options})." msgstr "" #. type: section #: doc/guix.texi:4810 #, no-wrap msgid "Invoking @command{guix time-machine}" msgstr "" #. type: command{#1} #: doc/guix.texi:4812 #, no-wrap msgid "guix time-machine" msgstr "" #. type: cindex #: doc/guix.texi:4813 doc/guix.texi:5412 #, no-wrap msgid "pinning, channels" msgstr "" #. type: cindex #: doc/guix.texi:4814 doc/guix.texi:5024 doc/guix.texi:5413 #, no-wrap msgid "replicating Guix" msgstr "" #. type: cindex #: doc/guix.texi:4815 doc/guix.texi:5414 #, no-wrap msgid "reproducibility, of Guix" msgstr "" #. type: Plain text #: doc/guix.texi:4823 msgid "" "The @command{guix time-machine} command provides access to other revisions " "of Guix, for example to install older versions of packages, or to reproduce " "a computation in an identical environment. The revision of Guix to be used " "is defined by a commit or by a channel description file created by " "@command{guix describe} (@pxref{Invoking guix describe})." msgstr "" #. type: Plain text #: doc/guix.texi:4827 msgid "" "Let's assume that you want to travel to those days of November 2020 when " "version 1.2.0 of Guix was released and, once you're there, run the " "@command{guile} of that time:" msgstr "" #. type: example #: doc/guix.texi:4831 #, no-wrap msgid "" "guix time-machine --commit=v1.2.0 -- \\\n" " environment -C --ad-hoc guile -- guile\n" msgstr "" #. type: Plain text #: doc/guix.texi:4842 msgid "" "The command above fetches Guix@tie{}1.2.0 and runs its @command{guix " "environment} command to spawn an environment in a container running " "@command{guile} (@command{guix environment} has since been subsumed by " "@command{guix shell}; @pxref{Invoking guix shell}). It's like driving a " "DeLorean@footnote{If you don't know what a DeLorean is, consider traveling " "back to the 1980's.}! The first @command{guix time-machine} invocation can " "be expensive: it may have to download or even build a large number of " "packages; the result is cached though and subsequent commands targeting the " "same commit are almost instantaneous." msgstr "" #. type: quotation #: doc/guix.texi:4850 msgid "" "The history of Guix is immutable and @command{guix time-machine} provides " "the exact same software as they are in a specific Guix revision. Naturally, " "no security fixes are provided for old versions of Guix or its channels. A " "careless use of @command{guix time-machine} opens the door to security " "vulnerabilities. @xref{Invoking guix pull, @option{--allow-downgrades}}." msgstr "" #. type: Plain text #: doc/guix.texi:4853 doc/guix.texi:5896 doc/guix.texi:6356 doc/guix.texi:7172 #: doc/guix.texi:11966 doc/guix.texi:12217 doc/guix.texi:13210 #: doc/guix.texi:13306 doc/guix.texi:14313 doc/guix.texi:14563 #: doc/guix.texi:15066 doc/guix.texi:15444 doc/guix.texi:15540 #: doc/guix.texi:15579 doc/guix.texi:15677 msgid "The general syntax is:" msgstr "" #. type: example #: doc/guix.texi:4856 #, no-wrap msgid "guix time-machine @var{options}@dots{} -- @var{command} @var {arg}@dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:4861 msgid "" "where @var{command} and @var{arg}@dots{} are passed unmodified to the " "@command{guix} command of the specified revision. The @var{options} that " "define this revision are the same as for @command{guix pull} " "(@pxref{Invoking guix pull}):" msgstr "" #. type: table #: doc/guix.texi:4869 msgid "" "Use the @code{guix} channel from the specified @var{url}, at the given " "@var{commit} (a valid Git commit ID represented as a hexadecimal string or " "the name of a tag), or @var{branch}." msgstr "" #. type: table #: doc/guix.texi:4875 msgid "" "Read the list of channels from @var{file}. @var{file} must contain Scheme " "code that evaluates to a list of channel objects. @xref{Channels} for more " "information." msgstr "" #. type: Plain text #: doc/guix.texi:4879 msgid "" "As for @command{guix pull}, the absence of any options means that the latest " "commit on the master branch will be used. The command" msgstr "" #. type: example #: doc/guix.texi:4882 #, no-wrap msgid "guix time-machine -- build hello\n" msgstr "" #. type: Plain text #: doc/guix.texi:4887 msgid "" "will thus build the package @code{hello} as defined in the master branch, " "which is in general a newer revision of Guix than you have installed. Time " "travel works in both directions!" msgstr "" #. type: Plain text #: doc/guix.texi:4891 msgid "" "Note that @command{guix time-machine} can trigger builds of channels and " "their dependencies, and these are controlled by the standard build options " "(@pxref{Common Build Options})." msgstr "" #. type: quotation #: doc/guix.texi:4899 msgid "" "The functionality described here is a ``technology preview'' as of version " "@value{VERSION}. As such, the interface is subject to change." msgstr "" #. type: cindex #: doc/guix.texi:4901 doc/guix.texi:12004 #, no-wrap msgid "inferiors" msgstr "" #. type: cindex #: doc/guix.texi:4902 #, no-wrap msgid "composition of Guix revisions" msgstr "" #. type: Plain text #: doc/guix.texi:4907 msgid "" "Sometimes you might need to mix packages from the revision of Guix you're " "currently running with packages available in a different revision of Guix. " "Guix @dfn{inferiors} allow you to achieve that by composing different Guix " "revisions in arbitrary ways." msgstr "" #. type: cindex #: doc/guix.texi:4908 doc/guix.texi:4973 #, no-wrap msgid "inferior packages" msgstr "" #. type: Plain text #: doc/guix.texi:4914 msgid "" "Technically, an ``inferior'' is essentially a separate Guix process " "connected to your main Guix process through a REPL (@pxref{Invoking guix " "repl}). The @code{(guix inferior)} module allows you to create inferiors " "and to communicate with them. It also provides a high-level interface to " "browse and manipulate the packages that an inferior provides---@dfn{inferior " "packages}." msgstr "" #. type: Plain text #: doc/guix.texi:4924 msgid "" "When combined with channels (@pxref{Channels}), inferiors provide a simple " "way to interact with a separate revision of Guix. For example, let's assume " "you want to install in your profile the current @code{guile} package, along " "with the @code{guile-json} as it existed in an older revision of Guix---" "perhaps because the newer @code{guile-json} has an incompatible API and you " "want to run your code against the old API@. To do that, you could write a " "manifest for use by @code{guix package --manifest} (@pxref{Writing " "Manifests}); 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:" msgstr "" #. type: lisp #: doc/guix.texi:4928 #, no-wrap msgid "" "(use-modules (guix inferior) (guix channels)\n" " (srfi srfi-1)) ;for 'first'\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:4937 #, no-wrap msgid "" "(define channels\n" " ;; This is the old revision from which we want to\n" " ;; extract guile-json.\n" " (list (channel\n" " (name 'guix)\n" " (url \"https://git.savannah.gnu.org/git/guix.git\")\n" " (commit\n" " \"65956ad3526ba09e1f7a40722c96c6ef7c0936fe\"))))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:4941 #, no-wrap msgid "" "(define inferior\n" " ;; An inferior representing the above revision.\n" " (inferior-for-channels channels))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:4947 #, no-wrap msgid "" ";; Now create a manifest with the current \"guile\" package\n" ";; and the old \"guile-json\" package.\n" "(packages->manifest\n" " (list (first (lookup-inferior-packages inferior \"guile-json\"))\n" " (specification->package \"guile\")))\n" msgstr "" #. type: Plain text #: doc/guix.texi:4952 msgid "" "On its first run, @command{guix package --manifest} might have to build the " "channel you specified before it can create the inferior; subsequent runs " "will be much faster because the Guix revision will be cached." msgstr "" #. type: Plain text #: doc/guix.texi:4955 msgid "" "The @code{(guix inferior)} module provides the following procedures to open " "an inferior:" msgstr "" #. type: deffn #: doc/guix.texi:4956 #, no-wrap msgid "{Scheme Procedure} inferior-for-channels @var{channels} @" msgstr "" #. type: deffn #: doc/guix.texi:4961 msgid "" "[#:cache-directory] [#:ttl] Return an inferior for @var{channels}, a list of " "channels. Use the cache at @var{cache-directory}, where entries can be " "reclaimed after @var{ttl} seconds. This procedure opens a new connection to " "the build daemon." msgstr "" #. type: deffn #: doc/guix.texi:4964 msgid "" "As a side effect, this procedure may build or substitute binaries for " "@var{channels}, which can take time." msgstr "" #. type: deffn #: doc/guix.texi:4966 #, no-wrap msgid "{Scheme Procedure} open-inferior @var{directory} @" msgstr "" #. type: deffn #: doc/guix.texi:4971 msgid "" "[#:command \"bin/guix\"] Open the inferior Guix in @var{directory}, running " "@code{@var{directory}/@var{command} repl} or equivalent. Return @code{#f} " "if the inferior could not be launched." msgstr "" #. type: Plain text #: doc/guix.texi:4976 msgid "" "The procedures listed below allow you to obtain and manipulate inferior " "packages." msgstr "" #. type: deffn #: doc/guix.texi:4977 #, no-wrap msgid "{Scheme Procedure} inferior-packages @var{inferior}" msgstr "" #. type: deffn #: doc/guix.texi:4979 msgid "Return the list of packages known to @var{inferior}." msgstr "" #. type: deffn #: doc/guix.texi:4981 #, no-wrap msgid "{Scheme Procedure} lookup-inferior-packages @var{inferior} @var{name} @" msgstr "" #. type: deffn #: doc/guix.texi:4986 msgid "" "[@var{version}] Return the sorted list of inferior packages matching " "@var{name} in @var{inferior}, with highest version numbers first. If " "@var{version} is true, return only packages with a version number prefixed " "by @var{version}." msgstr "" #. type: deffn #: doc/guix.texi:4988 #, no-wrap msgid "{Scheme Procedure} inferior-package? @var{obj}" msgstr "" #. type: deffn #: doc/guix.texi:4990 msgid "Return true if @var{obj} is an inferior package." msgstr "" #. type: deffn #: doc/guix.texi:4992 #, no-wrap msgid "{Scheme Procedure} inferior-package-name @var{package}" msgstr "" #. type: deffnx #: doc/guix.texi:4993 #, no-wrap msgid "{Scheme Procedure} inferior-package-version @var{package}" msgstr "" #. type: deffnx #: doc/guix.texi:4994 #, no-wrap msgid "{Scheme Procedure} inferior-package-synopsis @var{package}" msgstr "" #. type: deffnx #: doc/guix.texi:4995 #, no-wrap msgid "{Scheme Procedure} inferior-package-description @var{package}" msgstr "" #. type: deffnx #: doc/guix.texi:4996 #, no-wrap msgid "{Scheme Procedure} inferior-package-home-page @var{package}" msgstr "" #. type: deffnx #: doc/guix.texi:4997 #, no-wrap msgid "{Scheme Procedure} inferior-package-location @var{package}" msgstr "" #. type: deffnx #: doc/guix.texi:4998 #, no-wrap msgid "{Scheme Procedure} inferior-package-inputs @var{package}" msgstr "" #. type: deffnx #: doc/guix.texi:4999 #, no-wrap msgid "{Scheme Procedure} inferior-package-native-inputs @var{package}" msgstr "" #. type: deffnx #: doc/guix.texi:5000 #, no-wrap msgid "{Scheme Procedure} inferior-package-propagated-inputs @var{package}" msgstr "" #. type: deffnx #: doc/guix.texi:5001 #, no-wrap msgid "{Scheme Procedure} inferior-package-transitive-propagated-inputs @var{package}" msgstr "" #. type: deffnx #: doc/guix.texi:5002 #, no-wrap msgid "{Scheme Procedure} inferior-package-native-search-paths @var{package}" msgstr "" #. type: deffnx #: doc/guix.texi:5003 #, no-wrap msgid "{Scheme Procedure} inferior-package-transitive-native-search-paths @var{package}" msgstr "" #. type: deffnx #: doc/guix.texi:5004 #, no-wrap msgid "{Scheme Procedure} inferior-package-search-paths @var{package}" msgstr "" #. type: deffn #: doc/guix.texi:5009 msgid "" "These procedures are the counterpart of package record accessors " "(@pxref{package Reference}). Most of them work by querying the inferior " "@var{package} comes from, so the inferior must still be live when you call " "these procedures." msgstr "" #. type: Plain text #: doc/guix.texi:5019 msgid "" "Inferior packages can be used transparently like any other package or file-" "like object in G-expressions (@pxref{G-Expressions}). They are also " "transparently handled by the @code{packages->manifest} procedure, which is " "commonly used in manifests (@pxref{Invoking guix package, the @option{--" "manifest} option of @command{guix package}}). Thus you can insert an " "inferior package pretty much anywhere you would insert a regular package: in " "manifests, in the @code{packages} field of your @code{operating-system} " "declaration, and so on." msgstr "" #. type: section #: doc/guix.texi:5021 #, no-wrap msgid "Invoking @command{guix describe}" msgstr "" #. type: command{#1} #: doc/guix.texi:5025 #, no-wrap msgid "guix describe" msgstr "" #. type: Plain text #: doc/guix.texi:5033 msgid "" "Often you may want to answer questions like: ``Which revision of Guix am I " "using?'' or ``Which channels am I using?'' This is useful information in " "many situations: if you want to @emph{replicate} an environment on a " "different machine or user account, if you want to report a bug or to " "determine what change in the channels you are using caused it, or if you " "want to record your system state for reproducibility purposes. The " "@command{guix describe} command answers these questions." msgstr "" #. type: Plain text #: doc/guix.texi:5037 msgid "" "When run from a @command{guix pull}ed @command{guix}, @command{guix " "describe} displays the channel(s) that it was built from, including their " "repository URL and commit IDs (@pxref{Channels}):" msgstr "" #. type: example #: doc/guix.texi:5045 #, no-wrap msgid "" "$ guix describe\n" "Generation 10\tSep 03 2018 17:32:44\t(current)\n" " guix e0fa68c\n" " repository URL: https://git.savannah.gnu.org/git/guix.git\n" " branch: master\n" " commit: e0fa68c7718fffd33d81af415279d6ddb518f727\n" msgstr "" #. type: Plain text #: doc/guix.texi:5054 msgid "" "If you're familiar with the Git version control system, this is similar in " "spirit to @command{git describe}; the output is also similar to that of " "@command{guix pull --list-generations}, but limited to the current " "generation (@pxref{Invoking guix pull, the @option{--list-generations} " "option}). Because the Git commit ID shown above unambiguously refers to a " "snapshot of Guix, this information is all it takes to describe the revision " "of Guix you're using, and also to replicate it." msgstr "" #. type: Plain text #: doc/guix.texi:5057 msgid "" "To make it easier to replicate Guix, @command{guix describe} can also be " "asked to return a list of channels instead of the human-readable description " "above:" msgstr "" #. type: example #: doc/guix.texi:5070 #, no-wrap msgid "" "$ guix describe -f channels\n" "(list (channel\n" " (name 'guix)\n" " (url \"https://git.savannah.gnu.org/git/guix.git\")\n" " (commit\n" " \"e0fa68c7718fffd33d81af415279d6ddb518f727\")\n" " (introduction\n" " (make-channel-introduction\n" " \"9edb3f66fd807b096b48283debdcddccfea34bad\"\n" " (openpgp-fingerprint\n" " \"BBB0 2DDF 2CEA F6A8 0D1D E643 A2A0 6DF2 A33A 54FA\")))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:5079 msgid "" "You can save this to a file and feed it to @command{guix pull -C} on some " "other machine or at a later point in time, which will instantiate @emph{this " "exact Guix revision} (@pxref{Invoking guix pull, the @option{-C} option}). " "From there on, since you're able to deploy the same revision of Guix, you " "can just as well @emph{replicate a complete software environment}. We " "humbly think that this is @emph{awesome}, and we hope you'll like it too!" msgstr "" #. type: Plain text #: doc/guix.texi:5082 msgid "" "The details of the options supported by @command{guix describe} are as " "follows:" msgstr "" #. type: item #: doc/guix.texi:5084 doc/guix.texi:6841 doc/guix.texi:15811 #, no-wrap msgid "--format=@var{format}" msgstr "" #. type: itemx #: doc/guix.texi:5085 doc/guix.texi:6842 doc/guix.texi:15812 #, no-wrap msgid "-f @var{format}" msgstr "" #. type: table #: doc/guix.texi:5087 doc/guix.texi:15814 msgid "Produce output in the specified @var{format}, one of:" msgstr "" #. type: item #: doc/guix.texi:5089 #, no-wrap msgid "human" msgstr "" #. type: table #: doc/guix.texi:5091 msgid "produce human-readable output;" msgstr "" #. type: cindex #: doc/guix.texi:5091 doc/guix.texi:5311 #, no-wrap msgid "channels" msgstr "" #. type: table #: doc/guix.texi:5095 msgid "" "produce a list of channel specifications that can be passed to @command{guix " "pull -C} or installed as @file{~/.config/guix/channels.scm} (@pxref{Invoking " "guix pull});" msgstr "" #. type: item #: doc/guix.texi:5095 #, no-wrap msgid "channels-sans-intro" msgstr "" #. type: table #: doc/guix.texi:5101 msgid "" "like @code{channels}, but omit the @code{introduction} field; use it to " "produce a channel specification suitable for Guix version 1.1.0 or earlier---" "the @code{introduction} field has to do with channel authentication " "(@pxref{Channels, Channel Authentication}) and is not supported by these " "older versions;" msgstr "" #. type: item #: doc/guix.texi:5101 doc/guix.texi:13529 #, no-wrap msgid "json" msgstr "" #. type: cindex #: doc/guix.texi:5102 #, no-wrap msgid "JSON" msgstr "" #. type: table #: doc/guix.texi:5104 msgid "produce a list of channel specifications in JSON format;" msgstr "" #. type: item #: doc/guix.texi:5104 doc/guix.texi:15816 #, no-wrap msgid "recutils" msgstr "" #. type: table #: doc/guix.texi:5106 msgid "produce a list of channel specifications in Recutils format." msgstr "" #. type: item #: doc/guix.texi:5108 #, no-wrap msgid "--list-formats" msgstr "" #. type: table #: doc/guix.texi:5110 msgid "Display available formats for @option{--format} option." msgstr "" #. type: table #: doc/guix.texi:5114 msgid "Display information about @var{profile}." msgstr "" #. type: section #: doc/guix.texi:5117 #, no-wrap msgid "Invoking @command{guix archive}" msgstr "" #. type: command{#1} #: doc/guix.texi:5119 #, no-wrap msgid "guix archive" msgstr "" #. type: cindex #: doc/guix.texi:5120 #, no-wrap msgid "archive" msgstr "" #. type: cindex #: doc/guix.texi:5121 #, no-wrap msgid "exporting files from the store" msgstr "" #. type: cindex #: doc/guix.texi:5122 #, no-wrap msgid "importing files to the store" msgstr "" #. type: Plain text #: doc/guix.texi:5128 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:5132 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:5134 #, no-wrap msgid "exporting store items" msgstr "" #. type: Plain text #: doc/guix.texi:5136 msgid "To export store files as an archive to standard output, run:" msgstr "" #. type: example #: doc/guix.texi:5139 #, no-wrap msgid "guix archive --export @var{options} @var{specifications}...\n" msgstr "" #. type: Plain text #: doc/guix.texi:5146 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:5149 #, no-wrap msgid "guix archive --export git:gui /gnu/store/...-emacs-24.3 > great.nar\n" msgstr "" #. type: Plain text #: doc/guix.texi:5154 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:5157 msgid "" "To transfer the @code{emacs} package to a machine connected over SSH, one " "would run:" msgstr "" #. type: example #: doc/guix.texi:5160 #, no-wrap msgid "guix archive --export -r emacs | ssh the-machine guix archive --import\n" msgstr "" #. type: Plain text #: doc/guix.texi:5165 msgid "" "Similarly, a complete user profile may be transferred from one machine to " "another like this:" msgstr "" #. type: example #: doc/guix.texi:5169 #, 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:5179 msgid "" "However, note that, in both examples, all of @code{emacs} and the profile as " "well as all of their dependencies are transferred (due to @option{-r}), " "regardless of what is already available in the store on the target machine. " "The @option{--missing} option can help figure out which items are missing " "from the target store. The @command{guix copy} command simplifies and " "optimizes this whole process, so this is probably what you should use in " "this case (@pxref{Invoking guix copy})." msgstr "" #. type: cindex #: doc/guix.texi:5180 #, no-wrap msgid "nar, archive format" msgstr "" #. type: cindex #: doc/guix.texi:5181 #, no-wrap msgid "normalized archive (nar)" msgstr "" #. type: cindex #: doc/guix.texi:5182 #, no-wrap msgid "nar bundle, archive format" msgstr "" #. type: Plain text #: doc/guix.texi:5187 msgid "" "Each store item is written in the @dfn{normalized archive} or @dfn{nar} " "format (described below), and the output of @command{guix archive --export} " "(and input of @command{guix archive --import}) is a @dfn{nar bundle}." msgstr "" #. type: Plain text #: doc/guix.texi:5197 msgid "" "The nar format is comparable in spirit to `tar', but with differences that " "make it more appropriate for our purposes. First, rather than recording all " "Unix metadata for each file, the nar format only mentions the file type " "(regular, directory, or symbolic link); Unix permissions and owner/group are " "dismissed. Second, the order in which directory entries are stored always " "follows the order of file names according to the C locale collation order. " "This makes archive production fully deterministic." msgstr "" #. type: Plain text #: doc/guix.texi:5201 msgid "" "That nar bundle format is essentially the concatenation of zero or more nars " "along with metadata for each store item it contains: its file name, " "references, corresponding derivation, and a digital signature." msgstr "" #. type: Plain text #: doc/guix.texi:5207 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:5209 msgid "The main options are:" msgstr "" #. type: item #: doc/guix.texi:5211 #, no-wrap msgid "--export" msgstr "" #. type: table #: doc/guix.texi:5214 msgid "" "Export the specified store files or packages (see below). Write the " "resulting archive to the standard output." msgstr "" #. type: table #: doc/guix.texi:5217 msgid "" "Dependencies are @emph{not} included in the output, unless @option{--" "recursive} is passed." msgstr "" #. type: itemx #: doc/guix.texi:5218 doc/guix.texi:13243 doc/guix.texi:13370 #: doc/guix.texi:13401 doc/guix.texi:13433 doc/guix.texi:13604 #: doc/guix.texi:13645 doc/guix.texi:13696 doc/guix.texi:13721 #: doc/guix.texi:13746 doc/guix.texi:13762 doc/guix.texi:13810 #: doc/guix.texi:13846 doc/guix.texi:13873 doc/guix.texi:42906 #, no-wrap msgid "-r" msgstr "" #. type: item #: doc/guix.texi:5219 doc/guix.texi:13242 doc/guix.texi:13369 #: doc/guix.texi:13400 doc/guix.texi:13432 doc/guix.texi:13603 #: doc/guix.texi:13644 doc/guix.texi:13695 doc/guix.texi:13720 #: doc/guix.texi:13745 doc/guix.texi:13761 doc/guix.texi:13809 #: doc/guix.texi:13845 doc/guix.texi:13872 doc/guix.texi:13921 #: doc/guix.texi:42905 #, no-wrap msgid "--recursive" msgstr "" #. type: table #: doc/guix.texi:5224 msgid "" "When combined with @option{--export}, this instructs @command{guix archive} " "to include dependencies of the given items in the archive. Thus, the " "resulting archive is self-contained: it contains the closure of the exported " "store items." msgstr "" #. type: item #: doc/guix.texi:5225 #, no-wrap msgid "--import" msgstr "" #. type: table #: doc/guix.texi:5230 msgid "" "Read an archive from the standard input, and import the files listed therein " "into the store. Abort if the archive has an invalid digital signature, or " "if it is signed by a public key not among the authorized keys (see @option{--" "authorize} below)." msgstr "" #. type: item #: doc/guix.texi:5231 #, no-wrap msgid "--missing" msgstr "" #. type: table #: doc/guix.texi:5235 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:5236 #, no-wrap msgid "--generate-key[=@var{parameters}]" msgstr "" #. type: cindex #: doc/guix.texi:5237 #, no-wrap msgid "signing, archives" msgstr "" #. type: table #: doc/guix.texi:5244 msgid "" "Generate a new key pair for the daemon. This is a prerequisite before " "archives can be exported with @option{--export}. This operation is usually " "instantaneous but it can take time if the system's entropy pool needs to be " "refilled. On Guix System, @code{guix-service-type} takes care of generating " "this key pair the first boot." msgstr "" #. type: table #: doc/guix.texi:5254 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:5255 #, no-wrap msgid "--authorize" msgstr "" #. type: cindex #: doc/guix.texi:5256 #, no-wrap msgid "authorizing, archives" msgstr "" #. type: table #: doc/guix.texi:5260 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:5267 msgid "" "The list of authorized keys is kept in the human-editable file @file{/etc/" "guix/acl}. The file contains @url{https://people.csail.mit.edu/rivest/Sexp." "txt, ``advanced-format s-expressions''} and is structured as an access-" "control list in the @url{https://theworld.com/~cme/spki.txt, Simple Public-" "Key Infrastructure (SPKI)}." msgstr "" #. type: item #: doc/guix.texi:5268 #, no-wrap msgid "--extract=@var{directory}" msgstr "" #. type: itemx #: doc/guix.texi:5269 #, no-wrap msgid "-x @var{directory}" msgstr "" #. type: table #: doc/guix.texi:5273 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:5276 msgid "" "For example, the following command extracts the substitute for Emacs served " "by @code{@value{SUBSTITUTE-SERVER-1}} to @file{/tmp/emacs}:" msgstr "" #. type: example #: doc/guix.texi:5281 #, no-wrap msgid "" "$ wget -O - \\\n" " https://@value{SUBSTITUTE-SERVER-1}/nar/gzip/@dots{}-emacs-24.5 \\\n" " | gunzip | guix archive -x /tmp/emacs\n" msgstr "" #. type: table #: doc/guix.texi:5288 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:5292 msgid "" "The primary purpose of this operation is to facilitate inspection of archive " "contents coming from possibly untrusted substitute servers (@pxref{Invoking " "guix challenge})." msgstr "" #. type: item #: doc/guix.texi:5293 #, no-wrap msgid "--list" msgstr "" #. type: itemx #: doc/guix.texi:5294 doc/guix.texi:13591 doc/guix.texi:13638 #, no-wrap msgid "-t" msgstr "" #. type: table #: doc/guix.texi:5298 msgid "" "Read a single-item archive as served by substitute servers " "(@pxref{Substitutes}) and print the list of files it contains, as in this " "example:" msgstr "" #. type: example #: doc/guix.texi:5303 #, no-wrap msgid "" "$ wget -O - \\\n" " https://@value{SUBSTITUTE-SERVER-1}/nar/lzip/@dots{}-emacs-26.3 \\\n" " | lzip -d | guix archive -t\n" msgstr "" #. type: cindex #: doc/guix.texi:5314 #, no-wrap msgid "@command{guix pull}, configuration file" msgstr "" #. type: cindex #: doc/guix.texi:5315 #, no-wrap msgid "configuration of @command{guix pull}" msgstr "" #. type: Plain text #: doc/guix.texi:5326 msgid "" "Guix and its package collection are updated by running @command{guix pull} " "(@pxref{Invoking guix pull}). By default @command{guix pull} downloads and " "deploys Guix itself from the official GNU@tie{}Guix repository. This can be " "customized by defining @dfn{channels} in the @file{~/.config/guix/channels." "scm} file. A channel specifies a URL and branch of a Git repository to be " "deployed, and @command{guix pull} can be instructed to pull from one or more " "channels. In other words, channels can be used to @emph{customize} and to " "@emph{extend} Guix, as we will see below. Guix is able to take into account " "security concerns and deal with authenticated updates." msgstr "" #. type: cindex #: doc/guix.texi:5344 #, no-wrap msgid "extending the package collection (channels)" msgstr "" #. type: cindex #: doc/guix.texi:5345 #, no-wrap msgid "variant packages (channels)" msgstr "" #. type: Plain text #: doc/guix.texi:5349 msgid "" "You can specify @emph{additional channels} to pull from. To use a channel, " "write @code{~/.config/guix/channels.scm} to instruct @command{guix pull} to " "pull from it @emph{in addition} to the default Guix channel(s):" msgstr "" #. type: vindex #: doc/guix.texi:5350 #, no-wrap msgid "%default-channels" msgstr "" #. type: lisp #: doc/guix.texi:5357 #, no-wrap msgid "" ";; Add variant packages to those Guix provides.\n" "(cons (channel\n" " (name 'variant-packages)\n" " (url \"https://example.org/variant-packages.git\"))\n" " %default-channels)\n" msgstr "" #. type: Plain text #: doc/guix.texi:5367 msgid "" "Note that the snippet above is (as always!)@: Scheme code; we use " "@code{cons} to add a channel the list of channels that the variable " "@code{%default-channels} is bound to (@pxref{Pairs, @code{cons} and lists,, " "guile, GNU Guile Reference Manual}). With this file in place, @command{guix " "pull} builds not only Guix but also the package modules from your own " "repository. The result in @file{~/.config/guix/current} is the union of " "Guix with your own package modules:" msgstr "" #. type: example #: doc/guix.texi:5379 #, no-wrap msgid "" "$ guix describe\n" "Generation 19\tAug 27 2018 16:20:48\n" " guix d894ab8\n" " repository URL: https://git.savannah.gnu.org/git/guix.git\n" " branch: master\n" " commit: d894ab8e9bfabcefa6c49d9ba2e834dd5a73a300\n" " variant-packages dd3df5e\n" " repository URL: https://example.org/variant-packages.git\n" " branch: master\n" " commit: dd3df5e2c8818760a8fc0bd699e55d3b69fef2bb\n" msgstr "" #. type: Plain text #: doc/guix.texi:5386 msgid "" "The output of @command{guix describe} above shows that we're now running " "Generation@tie{}19 and that it includes both Guix and packages from the " "@code{variant-personal-packages} channel (@pxref{Invoking guix describe})." msgstr "" #. type: Plain text #: doc/guix.texi:5395 msgid "" "The channel called @code{guix} specifies where Guix itself---its command-" "line tools as well as its package collection---should be downloaded. For " "instance, suppose you want to update from another copy of the Guix " "repository at @code{example.org}, and specifically the @code{super-hacks} " "branch, you can write in @code{~/.config/guix/channels.scm} this " "specification:" msgstr "" #. type: lisp #: doc/guix.texi:5402 #, no-wrap msgid "" ";; Tell 'guix pull' to use another repo.\n" "(list (channel\n" " (name 'guix)\n" " (url \"https://example.org/another-guix.git\")\n" " (branch \"super-hacks\")))\n" msgstr "" #. type: Plain text #: doc/guix.texi:5408 msgid "" "From there on, @command{guix pull} will fetch code from the @code{super-" "hacks} branch of the repository at @code{example.org}. The authentication " "concern is addressed below (@pxref{Channel Authentication})." msgstr "" #. type: Plain text #: doc/guix.texi:5420 msgid "" "The @command{guix describe} command shows precisely which commits were used " "to build the instance of Guix we're using (@pxref{Invoking guix describe}). " "We can replicate this instance on another machine or at a different point in " "time by providing a channel specification ``pinned'' to these commits that " "looks like this:" msgstr "" #. type: lisp #: doc/guix.texi:5431 #, no-wrap msgid "" ";; Deploy specific commits of my channels of interest.\n" "(list (channel\n" " (name 'guix)\n" " (url \"https://git.savannah.gnu.org/git/guix.git\")\n" " (commit \"6298c3ffd9654d3231a6f25390b056483e8f407c\"))\n" " (channel\n" " (name 'variant-packages)\n" " (url \"https://example.org/variant-packages.git\")\n" " (commit \"dd3df5e2c8818760a8fc0bd699e55d3b69fef2bb\")))\n" msgstr "" #. type: Plain text #: doc/guix.texi:5436 msgid "" "To obtain this pinned channel specification, the easiest way is to run " "@command{guix describe} and to save its output in the @code{channels} format " "in a file, like so:" msgstr "" #. type: example #: doc/guix.texi:5439 #, no-wrap msgid "guix describe -f channels > channels.scm\n" msgstr "" #. type: Plain text #: doc/guix.texi:5445 msgid "" "The resulting @file{channels.scm} file can be passed to the @option{-C} " "option of @command{guix pull} (@pxref{Invoking guix pull}) or @command{guix " "time-machine} (@pxref{Invoking guix time-machine}), as in this example:" msgstr "" #. type: example #: doc/guix.texi:5448 #, no-wrap msgid "guix time-machine -C channels.scm -- shell python -- python3\n" msgstr "" #. type: Plain text #: doc/guix.texi:5454 msgid "" "Given the @file{channels.scm} file, the command above will always fetch the " "@emph{exact same Guix instance}, then use that instance to run the exact " "same Python (@pxref{Invoking guix shell}). On any machine, at any time, it " "ends up running the exact same binaries, bit for bit." msgstr "" #. type: cindex #: doc/guix.texi:5455 #, no-wrap msgid "lock files" msgstr "" #. type: Plain text #: doc/guix.texi:5463 msgid "" "Pinned channels address a problem similar to ``lock files'' as implemented " "by some deployment tools---they let you pin and reproduce a set of " "packages. In the case of Guix though, you are effectively pinning the " "entire package set as defined at the given channel commits; in fact, you are " "pinning all of Guix, including its core modules and command-line tools. " "You're also getting strong guarantees that you are, indeed, obtaining the " "exact same software." msgstr "" #. type: Plain text #: doc/guix.texi:5468 msgid "" "This gives you super powers, allowing you to track the provenance of binary " "artifacts with very fine grain, and to reproduce software environments at " "will---some sort of ``meta reproducibility'' capabilities, if you will. " "@xref{Inferiors}, for another way to take advantage of these super powers." msgstr "" #. type: anchor{#1} #: doc/guix.texi:5473 msgid "channel-authentication" msgstr "" #. type: Plain text #: doc/guix.texi:5479 msgid "" "The @command{guix pull} and @command{guix time-machine} commands " "@dfn{authenticate} the code retrieved from channels: they make sure each " "commit that is fetched is signed by an authorized developer. The goal is to " "protect from unauthorized modifications to the channel that would lead users " "to run malicious code." msgstr "" #. type: Plain text #: doc/guix.texi:5484 msgid "" "As a user, you must provide a @dfn{channel introduction} in your channels " "file so that Guix knows how to authenticate its first commit. A channel " "specification, including its introduction, looks something along these lines:" msgstr "" #. type: lisp #: doc/guix.texi:5494 #, no-wrap msgid "" "(channel\n" " (name 'some-channel)\n" " (url \"https://example.org/some-channel.git\")\n" " (introduction\n" " (make-channel-introduction\n" " \"6f0d8cc0d88abb59c324b2990bfee2876016bb86\"\n" " (openpgp-fingerprint\n" " \"CABB A931 C0FF EEC6 900D 0CFB 090B 1199 3D9A EBB5\"))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:5500 msgid "" "The specification above shows the name and URL of the channel. The call to " "@code{make-channel-introduction} above specifies that authentication of this " "channel starts at commit @code{6f0d8cc@dots{}}, which is signed by the " "OpenPGP key with fingerprint @code{CABB A931@dots{}}." msgstr "" #. type: Plain text #: doc/guix.texi:5506 msgid "" "For the main channel, called @code{guix}, you automatically get that " "information from your Guix installation. For other channels, include the " "channel introduction provided by the channel authors in your @file{channels." "scm} file. Make sure you retrieve the channel introduction from a trusted " "source since that is the root of your trust." msgstr "" #. type: Plain text #: doc/guix.texi:5508 msgid "If you're curious about the authentication mechanics, read on!" msgstr "" #. type: Plain text #: doc/guix.texi:5519 msgid "" "When running @command{guix pull}, Guix will first compile the definitions of " "every available package. This is an expensive operation for which " "substitutes (@pxref{Substitutes}) may be available. The following snippet " "in @file{channels.scm} will ensure that @command{guix pull} uses the latest " "commit with available substitutes for the package definitions: this is done " "by querying the continuous integration server at @url{https://ci.guix.gnu." "org}." msgstr "" #. type: lisp #: doc/guix.texi:5522 #, no-wrap msgid "" "(use-modules (guix ci))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:5526 #, no-wrap msgid "" "(list (channel-with-substitutes-available\n" " %default-guix-channel\n" " \"https://ci.guix.gnu.org\"))\n" msgstr "" #. type: Plain text #: doc/guix.texi:5533 msgid "" "Note that this does not mean that all the packages that you will install " "after running @command{guix pull} will have available substitutes. It only " "ensures that @command{guix pull} will not try to compile package " "definitions. This is particularly useful when using machines with limited " "resources." msgstr "" #. type: cindex #: doc/guix.texi:5537 #, no-wrap msgid "personal packages (channels)" msgstr "" #. type: cindex #: doc/guix.texi:5538 #, no-wrap msgid "channels, for personal packages" msgstr "" #. type: Plain text #: doc/guix.texi:5546 msgid "" "Let's say you have a bunch of custom package variants or personal packages " "that you think would make little sense to contribute to the Guix project, " "but would like to have these packages transparently available to you at the " "command line. You would first write modules containing those package " "definitions (@pxref{Package Modules}), maintain them in a Git repository, " "and then you and anyone else can use it as an additional channel to get " "packages from. Neat, no?" msgstr "" #. type: quotation #: doc/guix.texi:5554 msgid "" "Before you, dear user, shout---``woow this is @emph{soooo coool}!''---and " "publish your personal channel to the world, we would like to share a few " "words of caution:" msgstr "" #. type: itemize #: doc/guix.texi:5562 msgid "" "Before publishing a channel, please consider contributing your package " "definitions to Guix proper (@pxref{Contributing}). Guix as a project is " "open to free software of all sorts, and packages in Guix proper are readily " "available to all Guix users and benefit from the project's quality assurance " "process." msgstr "" #. type: itemize #: doc/guix.texi:5571 msgid "" "When you maintain package definitions outside Guix, we, Guix developers, " "consider that @emph{the compatibility burden is on you}. Remember that " "package modules and package definitions are just Scheme code that uses " "various programming interfaces (APIs). We want to remain free to change " "these APIs to keep improving Guix, possibly in ways that break your " "channel. We never change APIs gratuitously, but we will @emph{not} commit " "to freezing APIs either." msgstr "" #. type: itemize #: doc/guix.texi:5575 msgid "" "Corollary: if you're using an external channel and that channel breaks, " "please @emph{report the issue to the channel authors}, not to the Guix " "project." msgstr "" #. type: quotation #: doc/guix.texi:5582 msgid "" "You've been warned! Having said this, we believe external channels are a " "practical way to exert your freedom to augment Guix' package collection and " "to share your improvements, which are basic tenets of @uref{https://www.gnu." "org/philosophy/free-sw.html, free software}. Please email us at @email{guix-" "devel@@gnu.org} if you'd like to discuss this." msgstr "" #. type: Plain text #: doc/guix.texi:5594 msgid "" "To create a channel, create a Git repository containing your own package " "modules and make it available. The repository can contain anything, but a " "useful channel will contain Guile modules that export packages. Once you " "start using a channel, Guix will behave as if the root directory of that " "channel's Git repository has been added to the Guile load path (@pxref{Load " "Paths,,, guile, GNU Guile Reference Manual}). For example, if your channel " "contains a file at @file{my-packages/my-tools.scm} that defines a Guile " "module, then the module will be available under the name @code{(my-packages " "my-tools)}, and you will be able to use it like any other module " "(@pxref{Modules,,, guile, GNU Guile Reference Manual})." msgstr "" #. type: Plain text #: doc/guix.texi:5599 msgid "" "As a channel author, consider bundling authentication material with your " "channel so that users can authenticate it. @xref{Channel Authentication}, " "and @ref{Specifying Channel Authorizations}, for info on how to do it." msgstr "" #. type: cindex #: doc/guix.texi:5604 #, no-wrap msgid "subdirectory, channels" msgstr "" #. type: Plain text #: doc/guix.texi:5608 msgid "" "As a channel author, you may want to keep your channel modules in a sub-" "directory. If your modules are in the sub-directory @file{guix}, you must " "add a meta-data file @file{.guix-channel} that contains:" msgstr "" #. type: lisp #: doc/guix.texi:5613 #, no-wrap msgid "" "(channel\n" " (version 0)\n" " (directory \"guix\"))\n" msgstr "" #. type: cindex #: doc/guix.texi:5618 #, no-wrap msgid "dependencies, channels" msgstr "" #. type: cindex #: doc/guix.texi:5619 #, no-wrap msgid "meta-data, channels" msgstr "" #. type: Plain text #: doc/guix.texi:5624 msgid "" "Channel authors may decide to augment a package collection provided by other " "channels. They can declare their channel to be dependent on other channels " "in a meta-data file @file{.guix-channel}, which is to be placed in the root " "of the channel repository." msgstr "" #. type: Plain text #: doc/guix.texi:5626 msgid "The meta-data file should contain a simple S-expression like this:" msgstr "" #. type: lisp #: doc/guix.texi:5634 #, no-wrap msgid "" "(channel\n" " (version 0)\n" " (dependencies\n" " (channel\n" " (name some-collection)\n" " (url \"https://example.org/first-collection.git\")\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:5646 #, no-wrap msgid "" " ;; The 'introduction' bit below is optional: you would\n" " ;; provide it for dependencies that can be authenticated.\n" " (introduction\n" " (channel-introduction\n" " (version 0)\n" " (commit \"a8883b58dc82e167c96506cf05095f37c2c2c6cd\")\n" " (signer \"CABB A931 C0FF EEC6 900D 0CFB 090B 1199 3D9A EBB5\"))))\n" " (channel\n" " (name some-other-collection)\n" " (url \"https://example.org/second-collection.git\")\n" " (branch \"testing\"))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:5652 msgid "" "In the above example this channel is declared to depend on two other " "channels, which will both be fetched automatically. The modules provided by " "the channel will be compiled in an environment where the modules of all " "these declared channels are available." msgstr "" #. type: Plain text #: doc/guix.texi:5656 msgid "" "For the sake of reliability and maintainability, you should avoid " "dependencies on channels that you don't control, and you should aim to keep " "the number of dependencies to a minimum." msgstr "" #. type: cindex #: doc/guix.texi:5660 #, no-wrap msgid "channel authorizations" msgstr "" #. type: anchor{#1} #: doc/guix.texi:5674 msgid "channel-authorizations" msgstr "" #. type: Plain text #: doc/guix.texi:5674 msgid "" "As we saw above, Guix ensures the source code it pulls from channels comes " "from authorized developers. As a channel author, you need to specify the " "list of authorized developers in the @file{.guix-authorizations} file in the " "channel's Git repository. The authentication rule is simple: each commit " "must be signed by a key listed in the @file{.guix-authorizations} file of " "its parent commit(s)@footnote{Git commits form a @dfn{directed acyclic " "graph} (DAG). Each commit can have zero or more parents; ``regular'' " "commits have one parent and merge commits have two parent commits. Read " "@uref{https://eagain.net/articles/git-for-computer-scientists/, @i{Git for " "Computer Scientists}} for a great overview.} The @file{.guix-authorizations} " "file looks like this:" msgstr "" #. type: lisp #: doc/guix.texi:5677 #, no-wrap msgid "" ";; Example '.guix-authorizations' file.\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:5680 #, no-wrap msgid "" "(authorizations\n" " (version 0) ;current file format version\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:5687 #, no-wrap msgid "" " ((\"AD17 A21E F8AE D8F1 CC02 DBD9 F8AE D8F1 765C 61E3\"\n" " (name \"alice\"))\n" " (\"2A39 3FFF 68F4 EF7A 3D29 12AF 68F4 EF7A 22FB B2D5\"\n" " (name \"bob\"))\n" " (\"CABB A931 C0FF EEC6 900D 0CFB 090B 1199 3D9A EBB5\"\n" " (name \"charlie\"))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:5691 msgid "" "Each fingerprint is followed by optional key/value pairs, as in the example " "above. Currently these key/value pairs are ignored." msgstr "" #. type: Plain text #: doc/guix.texi:5696 msgid "" "This authentication rule creates a chicken-and-egg issue: how do we " "authenticate the first commit? Related to that: how do we deal with channels " "whose repository history contains unsigned commits and lack @file{.guix-" "authorizations}? And how do we fork existing channels?" msgstr "" #. type: cindex #: doc/guix.texi:5697 #, no-wrap msgid "channel introduction" msgstr "" #. type: Plain text #: doc/guix.texi:5706 msgid "" "Channel introductions answer these questions by describing the first commit " "of a channel that should be authenticated. The first time a channel is " "fetched with @command{guix pull} or @command{guix time-machine}, the command " "looks up the introductory commit and verifies that it is signed by the " "specified OpenPGP key. From then on, it authenticates commits according to " "the rule above. Authentication fails if the target commit is neither a " "descendant nor an ancestor of the introductory commit." msgstr "" #. type: Plain text #: doc/guix.texi:5713 msgid "" "Additionally, your channel must provide all the OpenPGP keys that were ever " "mentioned in @file{.guix-authorizations}, stored as @file{.key} files, which " "can be either binary or ``ASCII-armored''. By default, those @file{.key} " "files are searched for in the branch named @code{keyring} but you can " "specify a different branch name in @code{.guix-channel} like so:" msgstr "" #. type: lisp #: doc/guix.texi:5718 #, no-wrap msgid "" "(channel\n" " (version 0)\n" " (keyring-reference \"my-keyring-branch\"))\n" msgstr "" #. type: Plain text #: doc/guix.texi:5722 msgid "" "To summarize, as the author of a channel, there are three things you have to " "do to allow users to authenticate your code:" msgstr "" #. type: enumerate #: doc/guix.texi:5728 msgid "" "Export the OpenPGP keys of past and present committers with @command{gpg --" "export} and store them in @file{.key} files, by default in a branch named " "@code{keyring} (we recommend making it an @dfn{orphan branch})." msgstr "" #. type: enumerate #: doc/guix.texi:5733 msgid "" "Introduce an initial @file{.guix-authorizations} in the channel's " "repository. Do that in a signed commit (@pxref{Commit Access}, for " "information on how to sign Git commits.)" msgstr "" #. type: enumerate #: doc/guix.texi:5739 msgid "" "Advertise the channel introduction, for instance on your channel's web " "page. The channel introduction, as we saw above, is the commit/key pair---i." "e., the commit that introduced @file{.guix-authorizations}, and the " "fingerprint of the OpenPGP used to sign it." msgstr "" #. type: Plain text #: doc/guix.texi:5744 msgid "" "Before pushing to your public Git repository, you can run @command{guix git-" "authenticate} to verify that you did sign all the commits you are about to " "push with an authorized key:" msgstr "" #. type: example #: doc/guix.texi:5747 #, no-wrap msgid "guix git authenticate @var{commit} @var{signer}\n" msgstr "" #. type: Plain text #: doc/guix.texi:5752 msgid "" "where @var{commit} and @var{signer} are your channel introduction. " "@xref{Invoking guix git authenticate}, for details." msgstr "" #. type: Plain text #: doc/guix.texi:5759 msgid "" "Publishing a signed channel requires discipline: any mistake, such as an " "unsigned commit or a commit signed by an unauthorized key, will prevent " "users from pulling from your channel---well, that's the whole point of " "authentication! Pay attention to merges in particular: merge commits are " "considered authentic if and only if they are signed by a key present in the " "@file{.guix-authorizations} file of @emph{both} branches." msgstr "" #. type: cindex #: doc/guix.texi:5763 #, no-wrap msgid "primary URL, channels" msgstr "" #. type: Plain text #: doc/guix.texi:5766 msgid "" "Channel authors can indicate the primary URL of their channel's Git " "repository in the @file{.guix-channel} file, like so:" msgstr "" #. type: lisp #: doc/guix.texi:5771 #, no-wrap msgid "" "(channel\n" " (version 0)\n" " (url \"https://example.org/guix.git\"))\n" msgstr "" #. type: Plain text #: doc/guix.texi:5778 msgid "" "This allows @command{guix pull} to determine whether it is pulling code from " "a mirror of the channel; when that is the case, it warns the user that the " "mirror might be stale and displays the primary URL@. That way, users cannot " "be tricked into fetching code from a stale mirror that does not receive " "security updates." msgstr "" #. type: Plain text #: doc/guix.texi:5782 msgid "" "This feature only makes sense for authenticated repositories, such as the " "official @code{guix} channel, for which @command{guix pull} ensures the code " "it fetches is authentic." msgstr "" #. type: cindex #: doc/guix.texi:5786 #, no-wrap msgid "news, for channels" msgstr "" #. type: Plain text #: doc/guix.texi:5790 msgid "" "Channel authors may occasionally want to communicate to their users " "information about important changes in the channel. You'd send them all an " "email, but that's not convenient." msgstr "" #. type: Plain text #: doc/guix.texi:5795 msgid "" "Instead, channels can provide a @dfn{news file}; when the channel users run " "@command{guix pull}, that news file is automatically read and @command{guix " "pull --news} can display the announcements that correspond to the new " "commits that have been pulled, if any." msgstr "" #. type: Plain text #: doc/guix.texi:5798 msgid "" "To do that, channel authors must first declare the name of the news file in " "their @file{.guix-channel} file:" msgstr "" #. type: lisp #: doc/guix.texi:5803 #, no-wrap msgid "" "(channel\n" " (version 0)\n" " (news-file \"etc/news.txt\"))\n" msgstr "" #. type: Plain text #: doc/guix.texi:5807 msgid "" "The news file itself, @file{etc/news.txt} in this example, must look " "something like this:" msgstr "" #. type: lisp #: doc/guix.texi:5820 #, no-wrap msgid "" "(channel-news\n" " (version 0)\n" " (entry (tag \"the-bug-fix\")\n" " (title (en \"Fixed terrible bug\")\n" " (fr \"Oh la la\"))\n" " (body (en \"@@emph@{Good news@}! It's fixed!\")\n" " (eo \"Certe ĝi pli bone funkcias nun!\")))\n" " (entry (commit \"bdcabe815cd28144a2d2b4bc3c5057b051fa9906\")\n" " (title (en \"Added a great package\")\n" " (ca \"Què vol dir guix?\"))\n" " (body (en \"Don't miss the @@code@{hello@} package!\"))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:5827 msgid "" "While the news file is using the Scheme syntax, avoid naming it with a " "@file{.scm} extension or else it will get picked up when building the " "channel and yield an error since it is not a valid module. Alternatively, " "you can move the channel module to a subdirectory and store the news file in " "another directory." msgstr "" #. type: Plain text #: doc/guix.texi:5832 msgid "" "The file consists of a list of @dfn{news entries}. Each entry is associated " "with a commit or tag: it describes changes made in this commit, possibly in " "preceding commits as well. Users see entries only the first time they " "obtain the commit the entry refers to." msgstr "" #. type: Plain text #: doc/guix.texi:5838 msgid "" "The @code{title} field should be a one-line summary while @code{body} can be " "arbitrarily long, and both can contain Texinfo markup (@pxref{Overview,,, " "texinfo, GNU Texinfo}). Both the title and body are a list of language tag/" "message tuples, which allows @command{guix pull} to display news in the " "language that corresponds to the user's locale." msgstr "" #. type: Plain text #: doc/guix.texi:5844 msgid "" "If you want to translate news using a gettext-based workflow, you can " "extract translatable strings with @command{xgettext} (@pxref{xgettext " "Invocation,,, gettext, GNU Gettext Utilities}). For example, assuming you " "write news entries in English first, the command below creates a PO file " "containing the strings to translate:" msgstr "" #. type: example #: doc/guix.texi:5847 #, no-wrap msgid "xgettext -o news.po -l scheme -ken etc/news.txt\n" msgstr "" #. type: Plain text #: doc/guix.texi:5851 msgid "" "To sum up, yes, you could use your channel as a blog. But beware, this is " "@emph{not quite} what your users might expect." msgstr "" #. type: cindex #: doc/guix.texi:5856 #, no-wrap msgid "software development" msgstr "" #. type: Plain text #: doc/guix.texi:5860 msgid "" "If you are a software developer, Guix provides tools that you should find " "helpful---independently of the language you're developing in. This is what " "this chapter is about." msgstr "" #. type: Plain text #: doc/guix.texi:5866 msgid "" "The @command{guix shell} command provides a convenient way to set up one-off " "software environments, be it for development purposes or to run a command " "without installing it in your profile. The @command{guix pack} command " "allows you to create @dfn{application bundles} that can be easily " "distributed to users who do not run Guix." msgstr "" #. type: section #: doc/guix.texi:5876 #, no-wrap msgid "Invoking @command{guix shell}" msgstr "" #. type: cindex #: doc/guix.texi:5878 #, no-wrap msgid "reproducible build environments" msgstr "" #. type: cindex #: doc/guix.texi:5879 #, no-wrap msgid "development environments" msgstr "" #. type: command{#1} #: doc/guix.texi:5880 doc/guix.texi:6339 #, no-wrap msgid "guix environment" msgstr "" #. type: command{#1} #: doc/guix.texi:5881 #, no-wrap msgid "guix shell" msgstr "" #. type: cindex #: doc/guix.texi:5882 #, no-wrap msgid "environment, package build environment" msgstr "" #. type: Plain text #: doc/guix.texi:5887 msgid "" "The purpose of @command{guix shell} is to make it easy to create one-off " "software environments, without changing one's profile. It is typically used " "to create development environments; it is also a convenient way to run " "applications without ``polluting'' your profile." msgstr "" #. type: quotation #: doc/guix.texi:5893 msgid "" "The @command{guix shell} command was recently introduced to supersede " "@command{guix environment} (@pxref{Invoking guix environment}). If you are " "familiar with @command{guix environment}, you will notice that it is similar " "but also---we hope!---more convenient." msgstr "" #. type: example #: doc/guix.texi:5899 #, no-wrap msgid "guix shell [@var{options}] [@var{package}@dots{}]\n" msgstr "" #. type: Plain text #: doc/guix.texi:5904 msgid "" "The following example creates an environment containing Python and NumPy, " "building or downloading any missing package, and runs the @command{python3} " "command in that environment:" msgstr "" #. type: example #: doc/guix.texi:5907 #, no-wrap msgid "guix shell python python-numpy -- python3\n" msgstr "" #. type: Plain text #: doc/guix.texi:5912 msgid "" "Development environments can be created as in the example below, which " "spawns an interactive shell containing all the dependencies and environment " "variables needed to work on Inkscape:" msgstr "" #. type: example #: doc/guix.texi:5915 #, no-wrap msgid "guix shell --development inkscape\n" msgstr "" #. type: Plain text #: doc/guix.texi:5921 msgid "" "Exiting the shell places the user back in the original environment before " "@command{guix shell} was invoked. The next garbage collection " "(@pxref{Invoking guix gc}) may clean up packages that were installed in the " "environment and that are no longer used outside of it." msgstr "" #. type: Plain text #: doc/guix.texi:5925 msgid "" "As an added convenience, @command{guix shell} will try to do what you mean " "when it is invoked interactively without any other arguments as in:" msgstr "" #. type: example #: doc/guix.texi:5928 #, no-wrap msgid "guix shell\n" msgstr "" #. type: Plain text #: doc/guix.texi:5940 msgid "" "If it finds a @file{manifest.scm} in the current working directory or any of " "its parents, it uses this manifest as though it was given via @code{--" "manifest}. Likewise, if it finds a @file{guix.scm} in the same directories, " "it uses it to build a development profile as though both @code{--" "development} and @code{--file} were present. In either case, the file will " "only be loaded if the directory it resides in is listed in @file{~/.config/" "guix/shell-authorized-directories}. This provides an easy way to define, " "share, and enter development environments." msgstr "" #. type: Plain text #: doc/guix.texi:5951 msgid "" "By default, the shell session or command runs in an @emph{augmented} " "environment, where the new packages are added to search path environment " "variables such as @code{PATH}. You can, instead, choose to create an " "@emph{isolated} environment containing nothing but the packages you asked " "for. Passing the @option{--pure} option clears environment variable " "definitions found in the parent environment@footnote{Be sure to use the " "@option{--check} option the first time you use @command{guix shell} " "interactively to make sure the shell does not undo the effect of @option{--" "pure}.}; passing @option{--container} goes one step further by spawning a " "@dfn{container} isolated from the rest of the system:" msgstr "" #. type: example #: doc/guix.texi:5954 #, no-wrap msgid "guix shell --container emacs gcc-toolchain\n" msgstr "" #. type: Plain text #: doc/guix.texi:5962 msgid "" "The command above spawns an interactive shell in a container where nothing " "but @code{emacs}, @code{gcc-toolchain}, and their dependencies is " "available. The container lacks network access and shares no files other " "than the current working directory with the surrounding environment. This " "is useful to prevent access to system-wide resources such as @file{/usr/bin} " "on foreign distros." msgstr "" #. type: Plain text #: doc/guix.texi:5969 msgid "" "This @option{--container} option can also prove useful if you wish to run a " "security-sensitive application, such as a web browser, in an isolated " "environment. For example, the command below launches Ungoogled-Chromium in " "an isolated environment, this time sharing network access with the host and " "preserving its @code{DISPLAY} environment variable, but without even sharing " "the current directory:" msgstr "" #. type: example #: doc/guix.texi:5973 #, no-wrap msgid "" "guix shell --container --network --no-cwd ungoogled-chromium \\\n" " --preserve='^DISPLAY$' -- chromium\n" msgstr "" #. type: vindex #: doc/guix.texi:5975 doc/guix.texi:6390 #, no-wrap msgid "GUIX_ENVIRONMENT" msgstr "" #. type: Plain text #: doc/guix.texi:5981 msgid "" "@command{guix shell} defines the @env{GUIX_ENVIRONMENT} variable in the " "shell it spawns; its value is the file name of the profile of this " "environment. This allows users to, say, define a specific prompt for " "development environments in their @file{.bashrc} (@pxref{Bash Startup " "Files,,, bash, The GNU Bash Reference Manual}):" msgstr "" #. type: example #: doc/guix.texi:5987 doc/guix.texi:6402 #, 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:5991 doc/guix.texi:6406 msgid "...@: or to browse the profile:" msgstr "" #. type: example #: doc/guix.texi:5994 doc/guix.texi:6409 #, no-wrap msgid "$ ls \"$GUIX_ENVIRONMENT/bin\"\n" msgstr "" #. type: Plain text #: doc/guix.texi:5997 doc/guix.texi:6485 msgid "The available options are summarized below." msgstr "" #. type: item #: doc/guix.texi:5999 doc/guix.texi:6487 doc/guix.texi:12959 #, no-wrap msgid "--check" msgstr "" #. type: table #: doc/guix.texi:6004 msgid "" "Set up the environment and check whether the shell would clobber environment " "variables. It's a good idea to use this option the first time you run " "@command{guix shell} for an interactive session to make sure your setup is " "correct." msgstr "" #. type: table #: doc/guix.texi:6008 msgid "" "For example, if the shell modifies the @env{PATH} environment variable, " "report it since you would get a different environment than what you asked " "for." msgstr "" #. type: table #: doc/guix.texi:6016 msgid "" "Such problems usually indicate that the shell startup files are unexpectedly " "modifying those environment variables. For example, if you are using Bash, " "make sure that environment variables are set or modified in @file{~/." "bash_profile} and @emph{not} in @file{~/.bashrc}---the former 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: anchor{#1} #: doc/guix.texi:6018 msgid "shell-development-option" msgstr "" #. type: item #: doc/guix.texi:6018 #, no-wrap msgid "--development" msgstr "" #. type: table #: doc/guix.texi:6025 msgid "" "Cause @command{guix shell} to include in the environment the dependencies of " "the following package rather than the package itself. This can be combined " "with other packages. For instance, the command below starts an interactive " "shell containing the build-time dependencies of GNU@tie{}Guile, plus " "Autoconf, Automake, and Libtool:" msgstr "" #. type: example #: doc/guix.texi:6028 #, no-wrap msgid "guix shell -D guile autoconf automake libtool\n" msgstr "" #. type: item #: doc/guix.texi:6030 doc/guix.texi:6508 doc/guix.texi:7017 doc/guix.texi:12826 #: doc/guix.texi:13966 doc/guix.texi:14389 doc/guix.texi:14587 #: doc/guix.texi:14997 doc/guix.texi:38737 doc/guix.texi:41910 #, no-wrap msgid "--expression=@var{expr}" msgstr "" #. type: itemx #: doc/guix.texi:6031 doc/guix.texi:6509 doc/guix.texi:7018 doc/guix.texi:12827 #: doc/guix.texi:13967 doc/guix.texi:14390 doc/guix.texi:14588 #: doc/guix.texi:14998 doc/guix.texi:38738 doc/guix.texi:41911 #, no-wrap msgid "-e @var{expr}" msgstr "" #. type: table #: doc/guix.texi:6034 doc/guix.texi:6512 msgid "" "Create an environment for the package or list of packages that @var{expr} " "evaluates to." msgstr "" #. type: table #: doc/guix.texi:6036 doc/guix.texi:6514 doc/guix.texi:14394 msgid "For example, running:" msgstr "" #. type: example #: doc/guix.texi:6039 #, no-wrap msgid "guix shell -D -e '(@@ (gnu packages maths) petsc-openmpi)'\n" msgstr "" #. type: table #: doc/guix.texi:6043 doc/guix.texi:6521 msgid "" "starts a shell with the environment for this specific variant of the PETSc " "package." msgstr "" #. type: table #: doc/guix.texi:6045 doc/guix.texi:6523 msgid "Running:" msgstr "" #. type: example #: doc/guix.texi:6048 #, no-wrap msgid "guix shell -e '(@@ (gnu) %base-packages)'\n" msgstr "" #. type: table #: doc/guix.texi:6051 doc/guix.texi:6529 msgid "starts a shell with all the base system packages available." msgstr "" #. type: table #: doc/guix.texi:6054 doc/guix.texi:6532 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:6057 #, no-wrap msgid "guix shell -e '(list (@@ (gnu packages bash) bash) \"include\")'\n" msgstr "" #. type: table #: doc/guix.texi:6062 msgid "" "@xref{package-development-manifest, @code{package->development-manifest}}, " "for information on how to write a manifest for the development environment " "of a package." msgstr "" #. type: item #: doc/guix.texi:6063 doc/guix.texi:12800 #, no-wrap msgid "--file=@var{file}" msgstr "" #. type: table #: doc/guix.texi:6067 msgid "" "Create an environment containing the package or list of packages that the " "code within @var{file} evaluates to." msgstr "" #. type: lisp #: doc/guix.texi:6073 doc/guix.texi:6547 #, no-wrap msgid "@verbatiminclude environment-gdb.scm\n" msgstr "" #. type: table #: doc/guix.texi:6077 msgid "" "With the file above, you can enter a development environment for GDB by " "running:" msgstr "" #. type: example #: doc/guix.texi:6080 #, no-wrap msgid "guix shell -D -f gdb-devel.scm\n" msgstr "" #. type: anchor{#1} #: doc/guix.texi:6083 msgid "shell-manifest" msgstr "" #. type: table #: doc/guix.texi:6088 doc/guix.texi:6554 msgid "" "Create an environment for the packages contained in the manifest object " "returned by the Scheme code in @var{file}. This option can be repeated " "several times, in which case the manifests are concatenated." msgstr "" #. type: table #: doc/guix.texi:6092 doc/guix.texi:6558 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: table #: doc/guix.texi:6095 msgid "" "@xref{Writing Manifests}, for information on how to write a manifest. See " "@option{--export-manifest} below on how to obtain a first manifest." msgstr "" #. type: anchor{#1} #: doc/guix.texi:6098 msgid "shell-export-manifest" msgstr "" #. type: table #: doc/guix.texi:6101 msgid "" "Write to standard output a manifest suitable for @option{--manifest} " "corresponding to given command-line options." msgstr "" #. type: table #: doc/guix.texi:6105 msgid "" "This is a way to ``convert'' command-line arguments into a manifest. For " "example, imagine you are tired of typing long lines and would like to get a " "manifest equivalent to this command line:" msgstr "" #. type: example #: doc/guix.texi:6108 #, no-wrap msgid "guix shell -D guile git emacs emacs-geiser emacs-geiser-guile\n" msgstr "" #. type: table #: doc/guix.texi:6111 msgid "Just add @option{--export-manifest} to the command line above:" msgstr "" #. type: example #: doc/guix.texi:6115 #, no-wrap msgid "" "guix shell --export-manifest \\\n" " -D guile git emacs emacs-geiser emacs-geiser-guile\n" msgstr "" #. type: table #: doc/guix.texi:6119 msgid "... and you get a manifest along these lines:" msgstr "" #. type: lisp #: doc/guix.texi:6129 #, no-wrap msgid "" "(concatenate-manifests\n" " (list (specifications->manifest\n" " (list \"git\"\n" " \"emacs\"\n" " \"emacs-geiser\"\n" " \"emacs-geiser-guile\"))\n" " (package->development-manifest\n" " (specification->package \"guile\"))))\n" msgstr "" #. type: table #: doc/guix.texi:6134 msgid "" "You can store it into a file, say @file{manifest.scm}, and from there pass " "it to @command{guix shell} or indeed pretty much any @command{guix} command:" msgstr "" #. type: example #: doc/guix.texi:6137 doc/guix.texi:8319 #, no-wrap msgid "guix shell -m manifest.scm\n" msgstr "" #. type: table #: doc/guix.texi:6142 msgid "" "Voilà, you've converted a long command line into a manifest! That conversion " "process honors package transformation options (@pxref{Package Transformation " "Options}) so it should be lossless." msgstr "" #. type: table #: doc/guix.texi:6148 doc/guix.texi:6594 msgid "" "Create an environment containing the packages installed in @var{profile}. " "Use @command{guix package} (@pxref{Invoking guix package}) to create and " "manage profiles." msgstr "" #. type: item #: doc/guix.texi:6149 doc/guix.texi:6595 #, no-wrap msgid "--pure" msgstr "" #. type: table #: doc/guix.texi:6153 doc/guix.texi:6599 msgid "" "Unset existing environment variables when building the new environment, " "except those specified with @option{--preserve} (see below). This has the " "effect of creating an environment in which search paths only contain package " "inputs." msgstr "" #. type: item #: doc/guix.texi:6154 doc/guix.texi:6600 #, no-wrap msgid "--preserve=@var{regexp}" msgstr "" #. type: itemx #: doc/guix.texi:6155 doc/guix.texi:6601 #, no-wrap msgid "-E @var{regexp}" msgstr "" #. type: table #: doc/guix.texi:6160 doc/guix.texi:6606 msgid "" "When used alongside @option{--pure}, preserve the environment variables " "matching @var{regexp}---in other words, put them on a ``white list'' of " "environment variables that must be preserved. This option can be repeated " "several times." msgstr "" #. type: example #: doc/guix.texi:6164 #, no-wrap msgid "" "guix shell --pure --preserve=^SLURM openmpi @dots{} \\\n" " -- mpirun @dots{}\n" msgstr "" #. type: table #: doc/guix.texi:6170 doc/guix.texi:6616 msgid "" "This example runs @command{mpirun} in a context where the only environment " "variables defined are @env{PATH}, environment variables whose name starts " "with @samp{SLURM}, as well as the usual ``precious'' variables (@env{HOME}, " "@env{USER}, etc.)." msgstr "" #. type: item #: doc/guix.texi:6171 doc/guix.texi:6617 #, no-wrap msgid "--search-paths" msgstr "" #. type: table #: doc/guix.texi:6174 doc/guix.texi:6620 msgid "" "Display the environment variable definitions that make up the environment." msgstr "" #. type: table #: doc/guix.texi:6178 doc/guix.texi:6624 msgid "Attempt to build for @var{system}---e.g., @code{i686-linux}." msgstr "" #. type: item #: doc/guix.texi:6179 doc/guix.texi:6625 #, no-wrap msgid "--container" msgstr "" #. type: itemx #: doc/guix.texi:6180 doc/guix.texi:6626 #, no-wrap msgid "-C" msgstr "" #. type: item #: doc/guix.texi:6181 doc/guix.texi:6451 doc/guix.texi:6627 doc/guix.texi:15565 #: doc/guix.texi:38701 doc/guix.texi:41650 #, no-wrap msgid "container" msgstr "" #. type: table #: doc/guix.texi:6187 doc/guix.texi:6633 msgid "" "Run @var{command} within an isolated container. The current working " "directory outside the container is mapped inside the container. " "Additionally, unless overridden with @option{--user}, a dummy home directory " "is created that matches the current user's home directory, and @file{/etc/" "passwd} is configured accordingly." msgstr "" #. type: table #: doc/guix.texi:6191 doc/guix.texi:6637 msgid "" "The spawned process runs as the current user outside the container. Inside " "the container, it has the same UID and GID as the current user, unless " "@option{--user} is passed (see below)." msgstr "" #. type: item #: doc/guix.texi:6192 doc/guix.texi:6638 doc/guix.texi:38802 #: doc/guix.texi:41668 #, no-wrap msgid "--network" msgstr "" #. type: table #: doc/guix.texi:6197 doc/guix.texi:6643 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:6198 doc/guix.texi:6644 #, no-wrap msgid "--link-profile" msgstr "" #. type: itemx #: doc/guix.texi:6199 doc/guix.texi:6645 #, no-wrap msgid "-P" msgstr "" #. type: table #: doc/guix.texi:6207 msgid "" "For containers, link the environment profile to @file{~/.guix-profile} " "within the container and set @code{GUIX_ENVIRONMENT} to that. This is " "equivalent to making @file{~/.guix-profile} a symlink to the actual profile " "within the container. Linking will fail and abort the environment if the " "directory already exists, which will certainly be the case if @command{guix " "shell} was invoked in the user's home directory." msgstr "" #. type: table #: doc/guix.texi:6213 doc/guix.texi:6659 msgid "" "Certain packages are configured to look in @file{~/.guix-profile} for " "configuration files and data;@footnote{For example, the @code{fontconfig} " "package inspects @file{~/.guix-profile/share/fonts} for additional fonts.} " "@option{--link-profile} allows these programs to behave as expected within " "the environment." msgstr "" #. type: item #: doc/guix.texi:6214 doc/guix.texi:6660 doc/guix.texi:15135 #, no-wrap msgid "--user=@var{user}" msgstr "" #. type: itemx #: doc/guix.texi:6215 doc/guix.texi:6661 doc/guix.texi:15136 #, no-wrap msgid "-u @var{user}" msgstr "" #. type: table #: doc/guix.texi:6222 doc/guix.texi:6668 msgid "" "For containers, use the username @var{user} in place of the current user. " "The generated @file{/etc/passwd} entry within the container will contain the " "name @var{user}, the home directory will be @file{/home/@var{user}}, and no " "user GECOS data will be copied. Furthermore, the UID and GID inside the " "container are 1000. @var{user} need not exist on the system." msgstr "" #. type: table #: doc/guix.texi:6227 doc/guix.texi:6673 msgid "" "Additionally, any shared or exposed path (see @option{--share} and @option{--" "expose} respectively) whose target is within the current user's home " "directory will be remapped relative to @file{/home/USER}; this includes the " "automatic mapping of the current working directory." msgstr "" #. type: example #: doc/guix.texi:6234 #, no-wrap msgid "" "# will expose paths as /home/foo/wd, /home/foo/test, and /home/foo/target\n" "cd $HOME/wd\n" "guix shell --container --user=foo \\\n" " --expose=$HOME/test \\\n" " --expose=/tmp/target=$HOME/target\n" msgstr "" #. type: table #: doc/guix.texi:6239 doc/guix.texi:6685 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:6240 doc/guix.texi:6686 #, no-wrap msgid "--no-cwd" msgstr "" #. type: table #: doc/guix.texi:6247 doc/guix.texi:6693 msgid "" "For containers, the default behavior is to share the current working " "directory with the isolated container and immediately change to that " "directory within the container. If this is undesirable, @option{--no-cwd} " "will cause the current working directory to @emph{not} be automatically " "shared and will change to the user's home directory within the container " "instead. See also @option{--user}." msgstr "" #. type: item #: doc/guix.texi:6248 doc/guix.texi:6694 doc/guix.texi:41672 #, no-wrap msgid "--expose=@var{source}[=@var{target}]" msgstr "" #. type: itemx #: doc/guix.texi:6249 doc/guix.texi:6695 doc/guix.texi:41673 #, no-wrap msgid "--share=@var{source}[=@var{target}]" msgstr "" #. type: table #: doc/guix.texi:6255 doc/guix.texi:6701 msgid "" "For containers, @option{--expose} (resp. @option{--share}) exposes the file " "system @var{source} from the host system as the read-only (resp. writable) " "file system @var{target} within the container. If @var{target} is not " "specified, @var{source} is used as the target mount point in the container." msgstr "" #. type: table #: doc/guix.texi:6259 doc/guix.texi:6705 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:6262 #, no-wrap msgid "guix shell --container --expose=$HOME=/exchange guile -- guile\n" msgstr "" #. type: cindex #: doc/guix.texi:6264 #, no-wrap msgid "symbolic links, guix shell" msgstr "" #. type: item #: doc/guix.texi:6265 doc/guix.texi:7063 #, no-wrap msgid "--symlink=@var{spec}" msgstr "" #. type: itemx #: doc/guix.texi:6266 doc/guix.texi:7064 #, no-wrap msgid "-S @var{spec}" msgstr "" #. type: table #: doc/guix.texi:6269 msgid "" "For containers, create the symbolic links specified by @var{spec}, as " "documented in @ref{pack-symlink-option}." msgstr "" #. type: cindex #: doc/guix.texi:6270 #, no-wrap msgid "file system hierarchy standard (FHS)" msgstr "" #. type: cindex #: doc/guix.texi:6271 #, no-wrap msgid "FHS (file system hierarchy standard)" msgstr "" #. type: item #: doc/guix.texi:6272 doc/guix.texi:6710 #, no-wrap msgid "--emulate-fhs" msgstr "" #. type: item #: doc/guix.texi:6273 doc/guix.texi:6711 #, no-wrap msgid "-F" msgstr "" #. type: table #: doc/guix.texi:6279 msgid "" "When used with @option{--container}, emulate a @uref{https://refspecs." "linuxfoundation.org/fhs.shtml, Filesystem Hierarchy Standard (FHS)} " "configuration within the container, providing @file{/bin}, @file{/lib}, and " "other directories and files specified by the FHS." msgstr "" #. type: table #: doc/guix.texi:6290 msgid "" "As Guix deviates from the FHS specification, this option sets up the " "container to more closely mimic that of other GNU/Linux distributions. This " "is useful for reproducing other development environments, testing, and using " "programs which expect the FHS specification to be followed. With this " "option, the container will include a version of glibc that will read @file{/" "etc/ld.so.cache} within the container for the shared library cache (contrary " "to glibc in regular Guix usage) and set up the expected FHS directories: " "@file{/bin}, @file{/etc}, @file{/lib}, and @file{/usr} from the container's " "profile." msgstr "" #. type: item #: doc/guix.texi:6291 #, no-wrap msgid "--rebuild-cache" msgstr "" #. type: cindex #: doc/guix.texi:6292 #, no-wrap msgid "caching, of profiles" msgstr "" #. type: cindex #: doc/guix.texi:6293 #, no-wrap msgid "caching, in @command{guix shell}" msgstr "" #. type: table #: doc/guix.texi:6299 msgid "" "In most cases, @command{guix shell} caches the environment so that " "subsequent uses are instantaneous. Least-recently used cache entries are " "periodically removed. The cache is also invalidated, when using @option{--" "file} or @option{--manifest}, anytime the corresponding file is modified." msgstr "" #. type: table #: doc/guix.texi:6305 msgid "" "The @option{--rebuild-cache} forces the cached environment to be refreshed. " "This is useful when using @option{--file} or @option{--manifest} and the " "@command{guix.scm} or @command{manifest.scm} file has external dependencies, " "or if its behavior depends, say, on environment variables." msgstr "" #. type: item #: doc/guix.texi:6306 doc/guix.texi:6492 doc/guix.texi:7092 doc/guix.texi:12988 #: doc/guix.texi:38807 #, no-wrap msgid "--root=@var{file}" msgstr "" #. type: itemx #: doc/guix.texi:6307 doc/guix.texi:6493 doc/guix.texi:7093 doc/guix.texi:12989 #: doc/guix.texi:38808 #, no-wrap msgid "-r @var{file}" msgstr "" #. type: cindex #: doc/guix.texi:6308 doc/guix.texi:6494 #, no-wrap msgid "persistent environment" msgstr "" #. type: cindex #: doc/guix.texi:6309 doc/guix.texi:6495 #, no-wrap msgid "garbage collector root, for environments" msgstr "" #. type: table #: doc/guix.texi:6312 doc/guix.texi:6498 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:6315 doc/guix.texi:6501 msgid "" "This is useful if you want to protect your environment from garbage " "collection, to make it ``persistent''." msgstr "" #. type: table #: doc/guix.texi:6321 msgid "" "When this option is omitted, @command{guix shell} caches profiles so that " "subsequent uses of the same environment are instantaneous---this is " "comparable to using @option{--root} except that @command{guix shell} takes " "care of periodically removing the least-recently used garbage collector " "roots." msgstr "" #. type: table #: doc/guix.texi:6328 msgid "" "In some cases, @command{guix shell} does not cache profiles---e.g., if " "transformation options such as @option{--with-latest} are used. In those " "cases, the environment is protected from garbage collection only for the " "duration of the @command{guix shell} session. This means that next time you " "recreate the same environment, you could have to rebuild or re-download " "packages." msgstr "" #. type: table #: doc/guix.texi:6330 msgid "@xref{Invoking guix gc}, for more on GC roots." msgstr "" #. type: Plain text #: doc/guix.texi:6335 msgid "" "@command{guix shell} also supports all of the common build options that " "@command{guix build} supports (@pxref{Common Build Options}) as well as " "package transformation options (@pxref{Package Transformation Options})." msgstr "" #. type: section #: doc/guix.texi:6337 #, no-wrap msgid "Invoking @command{guix environment}" msgstr "" #. type: Plain text #: doc/guix.texi:6343 msgid "" "The purpose of @command{guix environment} is to assist in creating " "development environments." msgstr "" #. type: quotation #: doc/guix.texi:6344 #, no-wrap msgid "Deprecation warning" msgstr "" #. type: quotation #: doc/guix.texi:6348 msgid "" "The @command{guix environment} command is deprecated in favor of " "@command{guix shell}, which performs similar functions but is more " "convenient to use. @xref{Invoking guix shell}." msgstr "" #. type: quotation #: doc/guix.texi:6353 msgid "" "Being deprecated, @command{guix environment} is slated for eventual removal, " "but the Guix project is committed to keeping it until May 1st, 2023. Please " "get in touch with us at @email{guix-devel@@gnu.org} if you would like to " "discuss it." msgstr "" #. type: example #: doc/guix.texi:6359 #, no-wrap msgid "guix environment @var{options} @var{package}@dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:6363 msgid "" "The following example spawns a new shell set up for the development of " "GNU@tie{}Guile:" msgstr "" #. type: example #: doc/guix.texi:6366 #, no-wrap msgid "guix environment guile\n" msgstr "" #. type: Plain text #: doc/guix.texi:6383 msgid "" "If the needed dependencies are not built yet, @command{guix environment} " "automatically builds them. The environment of the new shell is an augmented " "version of the environment that @command{guix environment} was run in. It " "contains the necessary search paths for building the given package added to " "the existing environment variables. To create a ``pure'' environment, in " "which the original environment variables have been unset, use the @option{--" "pure} option@footnote{Users sometimes wrongfully augment environment " "variables such as @env{PATH} in their @file{~/.bashrc} file. As a " "consequence, when @command{guix environment} launches it, Bash may read " "@file{~/.bashrc}, thereby introducing ``impurities'' in these environment " "variables. It is an error to define such environment variables in @file{." "bashrc}; instead, they should be defined in @file{.bash_profile}, which is " "sourced only by log-in shells. @xref{Bash Startup Files,,, bash, The GNU " "Bash Reference Manual}, for details on Bash start-up files.}." msgstr "" #. type: Plain text #: doc/guix.texi:6389 msgid "" "Exiting from a Guix environment is the same as exiting from the shell, and " "will place the user back in the old environment before @command{guix " "environment} was invoked. The next garbage collection (@pxref{Invoking guix " "gc}) will clean up packages that were installed from within the environment " "and are no longer used outside of it." msgstr "" #. type: Plain text #: doc/guix.texi:6396 msgid "" "@command{guix environment} defines the @env{GUIX_ENVIRONMENT} variable in " "the shell it spawns; its value is the file name of the profile of this " "environment. This allows users to, say, define a specific prompt for " "development environments in their @file{.bashrc} (@pxref{Bash Startup " "Files,,, bash, The GNU Bash Reference Manual}):" msgstr "" #. type: Plain text #: doc/guix.texi:6415 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:6418 #, no-wrap msgid "guix environment guile emacs\n" msgstr "" #. type: Plain text #: doc/guix.texi:6423 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:6426 #, no-wrap msgid "guix environment guile -- make -j4\n" msgstr "" #. type: Plain text #: doc/guix.texi:6432 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{}3 and NumPy:" msgstr "" #. type: example #: doc/guix.texi:6435 #, no-wrap msgid "guix environment --ad-hoc python-numpy python -- python3\n" msgstr "" #. type: Plain text #: doc/guix.texi:6446 msgid "" "Furthermore, one might want the dependencies of a package and also some " "additional packages that are not build-time or runtime dependencies, but are " "useful when developing nonetheless. Because of this, the @option{--ad-hoc} " "flag is positional. Packages appearing before @option{--ad-hoc} are " "interpreted as packages whose dependencies will be added to the " "environment. Packages appearing after are interpreted as packages that will " "be added to the environment directly. For example, the following command " "creates a Guix development environment that additionally includes Git and " "strace:" msgstr "" #. type: example #: doc/guix.texi:6449 #, no-wrap msgid "guix environment --pure guix --ad-hoc git strace\n" msgstr "" #. type: Plain text #: doc/guix.texi:6459 msgid "" "Sometimes it is desirable to isolate the environment as much as possible, " "for maximal purity and reproducibility. In particular, when using Guix on a " "host distro that is not Guix System, it is desirable to prevent access to " "@file{/usr/bin} and other system-wide resources from the development " "environment. For example, the following command spawns a Guile REPL in a " "``container'' where only the store and the current working directory are " "mounted:" msgstr "" #. type: example #: doc/guix.texi:6462 #, no-wrap msgid "guix environment --ad-hoc --container guile -- guile\n" msgstr "" #. type: quotation #: doc/guix.texi:6466 msgid "The @option{--container} option requires Linux-libre 3.19 or newer." msgstr "" #. type: cindex #: doc/guix.texi:6468 #, no-wrap msgid "certificates" msgstr "" #. type: Plain text #: doc/guix.texi:6475 msgid "" "Another typical use case for containers is to run security-sensitive " "applications such as a web browser. To run Eolie, we must expose and share " "some files and directories; we include @code{nss-certs} and expose @file{/" "etc/ssl/certs/} for HTTPS authentication; finally we preserve the " "@env{DISPLAY} environment variable since containerized graphical " "applications won't display without it." msgstr "" #. type: example #: doc/guix.texi:6482 #, no-wrap msgid "" "guix environment --preserve='^DISPLAY$' --container --network \\\n" " --expose=/etc/machine-id \\\n" " --expose=/etc/ssl/certs/ \\\n" " --share=$HOME/.local/share/eolie/=$HOME/.local/share/eolie/ \\\n" " --ad-hoc eolie nss-certs dbus -- eolie\n" msgstr "" #. type: table #: doc/guix.texi:6491 msgid "" "Set up the environment and check whether the shell would clobber environment " "variables. @xref{Invoking guix shell, @option{--check}}, for more info." msgstr "" #. type: table #: doc/guix.texi:6507 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: example #: doc/guix.texi:6517 #, no-wrap msgid "guix environment -e '(@@ (gnu packages maths) petsc-openmpi)'\n" msgstr "" #. type: example #: doc/guix.texi:6526 #, no-wrap msgid "guix environment --ad-hoc -e '(@@ (gnu) %base-packages)'\n" msgstr "" #. type: example #: doc/guix.texi:6535 #, no-wrap msgid "guix environment --ad-hoc -e '(list (@@ (gnu packages bash) bash) \"include\")'\n" msgstr "" #. type: item #: doc/guix.texi:6537 #, no-wrap msgid "--load=@var{file}" msgstr "" #. type: itemx #: doc/guix.texi:6538 #, no-wrap msgid "-l @var{file}" msgstr "" #. type: table #: doc/guix.texi:6541 msgid "" "Create an environment for the package or list of packages that the code " "within @var{file} evaluates to." msgstr "" #. type: table #: doc/guix.texi:6562 msgid "" "@xref{shell-export-manifest, @command{guix shell --export-manifest}}, for " "information on how to ``convert'' command-line options into a manifest." msgstr "" #. type: item #: doc/guix.texi:6563 #, no-wrap msgid "--ad-hoc" msgstr "" #. type: table #: doc/guix.texi:6568 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:6570 msgid "For instance, the command:" msgstr "" #. type: example #: doc/guix.texi:6573 #, no-wrap msgid "guix environment --ad-hoc guile guile-sdl -- guile\n" msgstr "" #. type: table #: doc/guix.texi:6577 msgid "" "runs @command{guile} in an environment where Guile and Guile-SDL are " "available." msgstr "" #. type: table #: doc/guix.texi:6582 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:6588 msgid "" "This option may be composed with the default behavior of @command{guix " "environment}. Packages appearing before @option{--ad-hoc} are interpreted " "as packages whose dependencies will be added to the environment, the default " "behavior. Packages appearing after are interpreted as packages that will be " "added to the environment directly." msgstr "" #. type: example #: doc/guix.texi:6610 #, no-wrap msgid "" "guix environment --pure --preserve=^SLURM --ad-hoc openmpi @dots{} \\\n" " -- mpirun @dots{}\n" msgstr "" #. type: table #: doc/guix.texi:6653 msgid "" "For containers, link the environment profile to @file{~/.guix-profile} " "within the container and set @code{GUIX_ENVIRONMENT} to that. This is " "equivalent to making @file{~/.guix-profile} a symlink to the actual profile " "within the container. Linking will fail and abort the environment if the " "directory already exists, which will certainly be the case if @command{guix " "environment} was invoked in the user's home directory." msgstr "" #. type: example #: doc/guix.texi:6680 #, 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: example #: doc/guix.texi:6708 #, no-wrap msgid "guix environment --container --expose=$HOME=/exchange --ad-hoc guile -- guile\n" msgstr "" #. type: table #: doc/guix.texi:6725 msgid "" "For containers, emulate a Filesystem Hierarchy Standard (FHS) configuration " "within the container, see @uref{https://refspecs.linuxfoundation.org/fhs." "shtml, the official specification}. As Guix deviates from the FHS " "specification, this option sets up the container to more closely mimic that " "of other GNU/Linux distributions. This is useful for reproducing other " "development environments, testing, and using programs which expect the FHS " "specification to be followed. With this option, the container will include " "a version of @code{glibc} which will read @code{/etc/ld.so.cache} within the " "container for the shared library cache (contrary to @code{glibc} in regular " "Guix usage) and set up the expected FHS directories: @code{/bin}, @code{/" "etc}, @code{/lib}, and @code{/usr} from the container's profile." msgstr "" #. type: Plain text #: doc/guix.texi:6732 msgid "" "@command{guix environment} also supports all of the common build options " "that @command{guix build} supports (@pxref{Common Build Options}) as well as " "package transformation options (@pxref{Package Transformation Options})." msgstr "" #. type: section #: doc/guix.texi:6734 #, no-wrap msgid "Invoking @command{guix pack}" msgstr "" #. type: command{#1} #: doc/guix.texi:6736 #, no-wrap msgid "guix pack" msgstr "" #. type: Plain text #: doc/guix.texi:6742 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:6747 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:6749 #, no-wrap msgid "pack" msgstr "" #. type: cindex #: doc/guix.texi:6750 #, no-wrap msgid "bundle" msgstr "" #. type: cindex #: doc/guix.texi:6751 #, no-wrap msgid "application bundle" msgstr "" #. type: cindex #: doc/guix.texi:6752 #, no-wrap msgid "software bundle" msgstr "" #. type: Plain text #: doc/guix.texi:6761 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:6764 msgid "" "For example, to create a bundle containing Guile, Emacs, Geiser, and all " "their dependencies, you can run:" msgstr "" #. type: example #: doc/guix.texi:6769 #, no-wrap msgid "" "$ guix pack guile emacs emacs-geiser\n" "@dots{}\n" "/gnu/store/@dots{}-pack.tar.gz\n" msgstr "" #. type: Plain text #: doc/guix.texi:6777 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:6782 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:6785 #, no-wrap msgid "guix pack -S /opt/gnu/bin=bin guile emacs emacs-geiser\n" msgstr "" #. type: Plain text #: doc/guix.texi:6789 msgid "That way, users can happily type @file{/opt/gnu/bin/guile} and enjoy." msgstr "" #. type: cindex #: doc/guix.texi:6790 #, no-wrap msgid "relocatable binaries, with @command{guix pack}" msgstr "" #. type: Plain text #: doc/guix.texi:6798 msgid "" "What if the recipient of your pack does not have root privileges on their " "machine, and thus cannot unpack it in the root file system? In that case, " "you will want to use the @option{--relocatable} option (see below). This " "option produces @dfn{relocatable binaries}, meaning they they can be placed " "anywhere in the file system hierarchy: in the example above, users can " "unpack your tarball in their home directory and directly run @file{./opt/gnu/" "bin/guile}." msgstr "" #. type: cindex #: doc/guix.texi:6799 #, no-wrap msgid "Docker, build an image with guix pack" msgstr "" #. type: Plain text #: doc/guix.texi:6802 msgid "" "Alternatively, you can produce a pack in the Docker image format using the " "following command:" msgstr "" #. type: example #: doc/guix.texi:6805 #, no-wrap msgid "guix pack -f docker -S /bin=bin guile guile-readline\n" msgstr "" #. type: Plain text #: doc/guix.texi:6810 msgid "" "The result is a tarball that can be passed to the @command{docker load} " "command, followed by @code{docker run}:" msgstr "" #. type: example #: doc/guix.texi:6814 #, no-wrap msgid "" "docker load < @var{file}\n" "docker run -ti guile-guile-readline /bin/guile\n" msgstr "" #. type: Plain text #: doc/guix.texi:6821 msgid "" "where @var{file} is the image returned by @var{guix pack}, and @code{guile-" "guile-readline} is its ``image tag''. See the @uref{https://docs.docker.com/" "engine/reference/commandline/load/, Docker documentation} for more " "information." msgstr "" #. type: cindex #: doc/guix.texi:6822 #, no-wrap msgid "Singularity, build an image with guix pack" msgstr "" #. type: cindex #: doc/guix.texi:6823 #, no-wrap msgid "SquashFS, build an image with guix pack" msgstr "" #. type: Plain text #: doc/guix.texi:6826 msgid "" "Yet another option is to produce a SquashFS image with the following command:" msgstr "" #. type: example #: doc/guix.texi:6829 #, no-wrap msgid "guix pack -f squashfs bash guile emacs emacs-geiser\n" msgstr "" #. type: Plain text #: doc/guix.texi:6837 msgid "" "The result is a SquashFS file system image that can either be mounted or " "directly be used as a file system container image with the @uref{https://www." "sylabs.io/docs/, Singularity container execution environment}, using " "commands like @command{singularity shell} or @command{singularity exec}." msgstr "" #. type: Plain text #: doc/guix.texi:6839 msgid "Several command-line options allow you to customize your pack:" msgstr "" #. type: table #: doc/guix.texi:6844 msgid "Produce a pack in the given @var{format}." msgstr "" #. type: table #: doc/guix.texi:6846 msgid "The available formats are:" msgstr "" #. type: item #: doc/guix.texi:6848 #, no-wrap msgid "tarball" msgstr "" #. type: table #: doc/guix.texi:6851 msgid "" "This is the default format. It produces a tarball containing all the " "specified binaries and symlinks." msgstr "" #. type: item #: doc/guix.texi:6852 #, no-wrap msgid "docker" msgstr "" #. type: table #: doc/guix.texi:6858 msgid "" "This produces a tarball that follows the @uref{https://github.com/docker/" "docker/blob/master/image/spec/v1.2.md, Docker Image Specification}. The " "``repository name'' as it appears in the output of the @command{docker " "images} command is computed from package names passed on the command line or " "in the manifest file." msgstr "" #. type: item #: doc/guix.texi:6859 #, no-wrap msgid "squashfs" msgstr "" #. type: table #: doc/guix.texi:6863 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: quotation #: doc/guix.texi:6869 msgid "" "Singularity @emph{requires} you to provide @file{/bin/sh} in the image. For " "that reason, @command{guix pack -f squashfs} always implies @code{-S /" "bin=bin}. Thus, your @command{guix pack} invocation must always start with " "something like:" msgstr "" #. type: example #: doc/guix.texi:6872 #, no-wrap msgid "guix pack -f squashfs bash @dots{}\n" msgstr "" #. type: quotation #: doc/guix.texi:6877 msgid "" "If you forget the @code{bash} (or similar) package, @command{singularity " "run} and @command{singularity exec} will fail with an unhelpful ``no such " "file or directory'' message." msgstr "" #. type: item #: doc/guix.texi:6879 #, no-wrap msgid "deb" msgstr "" #. type: table #: doc/guix.texi:6887 msgid "" "This produces a Debian archive (a package with the @samp{.deb} file " "extension) containing all the specified binaries and symbolic links, that " "can be installed on top of any dpkg-based GNU(/Linux) distribution. " "Advanced options can be revealed via the @option{--help-deb-format} option. " "They allow embedding control files for more fine-grained control, such as " "activating specific triggers or providing a maintainer configure script to " "run arbitrary setup code upon installation." msgstr "" #. type: example #: doc/guix.texi:6890 #, no-wrap msgid "guix pack -f deb -C xz -S /usr/bin/hello=bin/hello hello\n" msgstr "" #. type: quotation #: doc/guix.texi:6897 msgid "" "Because archives produced with @command{guix pack} contain a collection of " "store items and because each @command{dpkg} package must not have " "conflicting files, in practice that means you likely won't be able to " "install more than one such archive on a given system." msgstr "" #. type: quotation #: doc/guix.texi:6905 msgid "" "@command{dpkg} will assume ownership of any files contained in the pack that " "it does @emph{not} know about. It is unwise to install Guix-produced @samp{." "deb} files on a system where @file{/gnu/store} is shared by other software, " "such as a Guix installation or other, non-deb packs." msgstr "" #. type: cindex #: doc/guix.texi:6909 #, no-wrap msgid "relocatable binaries" msgstr "" #. type: item #: doc/guix.texi:6910 #, no-wrap msgid "--relocatable" msgstr "" #. type: table #: doc/guix.texi:6914 msgid "" "Produce @dfn{relocatable binaries}---i.e., binaries that can be placed " "anywhere in the file system hierarchy and run from there." msgstr "" #. type: table #: doc/guix.texi:6922 msgid "" "When this option is passed once, the resulting binaries require support for " "@dfn{user namespaces} in the kernel Linux; when passed @emph{twice}" "@footnote{Here's a trick to memorize it: @code{-RR}, which adds PRoot " "support, can be thought of as the abbreviation of ``Really Relocatable''. " "Neat, isn't it?}, relocatable binaries fall to back to other techniques if " "user namespaces are unavailable, and essentially work anywhere---see below " "for the implications." msgstr "" #. type: table #: doc/guix.texi:6924 msgid "For example, if you create a pack containing Bash with:" msgstr "" #. type: example #: doc/guix.texi:6927 #, no-wrap msgid "guix pack -RR -S /mybin=bin bash\n" msgstr "" #. type: table #: doc/guix.texi:6932 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:6936 #, no-wrap msgid "" "tar xf pack.tar.gz\n" "./mybin/sh\n" msgstr "" #. type: table #: doc/guix.texi:6944 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: quotation #: doc/guix.texi:6950 msgid "" "By default, relocatable binaries rely on the @dfn{user namespace} feature of " "the kernel Linux, which allows unprivileged users to mount or change root. " "Old versions of Linux did not support it, and some GNU/Linux distributions " "turn it off." msgstr "" #. type: quotation #: doc/guix.texi:6956 msgid "" "To produce relocatable binaries that work even in the absence of user " "namespaces, pass @option{--relocatable} or @option{-R} @emph{twice}. In " "that case, binaries will try user namespace support and fall back to another " "@dfn{execution engine} if user namespaces are not supported. The following " "execution engines are supported:" msgstr "" #. type: item #: doc/guix.texi:6958 doc/guix.texi:19540 #, no-wrap msgid "default" msgstr "" #. type: table #: doc/guix.texi:6961 msgid "" "Try user namespaces and fall back to PRoot if user namespaces are not " "supported (see below)." msgstr "" #. type: item #: doc/guix.texi:6962 #, no-wrap msgid "performance" msgstr "" #. type: table #: doc/guix.texi:6965 msgid "" "Try user namespaces and fall back to Fakechroot if user namespaces are not " "supported (see below)." msgstr "" #. type: item #: doc/guix.texi:6966 #, no-wrap msgid "userns" msgstr "" #. type: table #: doc/guix.texi:6969 msgid "" "Run the program through user namespaces and abort if they are not supported." msgstr "" #. type: item #: doc/guix.texi:6970 #, no-wrap msgid "proot" msgstr "" #. type: table #: doc/guix.texi:6977 msgid "" "Run through PRoot. The @uref{https://proot-me.github.io/, PRoot} program " "provides the necessary support for file system virtualization. It achieves " "that by using the @code{ptrace} system call on the running program. This " "approach has the advantage to work without requiring special kernel support, " "but it incurs run-time overhead every time a system call is made." msgstr "" #. type: item #: doc/guix.texi:6978 #, no-wrap msgid "fakechroot" msgstr "" #. type: table #: doc/guix.texi:6986 msgid "" "Run through Fakechroot. @uref{https://github.com/dex4er/fakechroot/, " "Fakechroot} virtualizes file system accesses by intercepting calls to C " "library functions such as @code{open}, @code{stat}, @code{exec}, and so on. " "Unlike PRoot, it incurs very little overhead. However, it does not always " "work: for example, some file system accesses made from within the C library " "are not intercepted, and file system accesses made @i{via} direct syscalls " "are not intercepted either, leading to erratic behavior." msgstr "" #. type: vindex #: doc/guix.texi:6988 #, no-wrap msgid "GUIX_EXECUTION_ENGINE" msgstr "" #. type: quotation #: doc/guix.texi:6992 msgid "" "When running a wrapped program, you can explicitly request one of the " "execution engines listed above by setting the @env{GUIX_EXECUTION_ENGINE} " "environment variable accordingly." msgstr "" #. type: cindex #: doc/guix.texi:6994 #, no-wrap msgid "entry point, for Docker images" msgstr "" #. type: item #: doc/guix.texi:6995 #, no-wrap msgid "--entry-point=@var{command}" msgstr "" #. type: table #: doc/guix.texi:7000 msgid "" "Use @var{command} as the @dfn{entry point} of the resulting pack, if the " "pack format supports it---currently @code{docker} and @code{squashfs} " "(Singularity) support it. @var{command} must be relative to the profile " "contained in the pack." msgstr "" #. type: table #: doc/guix.texi:7004 msgid "" "The entry point specifies the command that tools like @code{docker run} or " "@code{singularity run} automatically start by default. For example, you can " "do:" msgstr "" #. type: example #: doc/guix.texi:7007 #, no-wrap msgid "guix pack -f docker --entry-point=bin/guile guile\n" msgstr "" #. type: table #: doc/guix.texi:7011 msgid "" "The resulting pack can easily be loaded and @code{docker run} with no extra " "arguments will spawn @code{bin/guile}:" msgstr "" #. type: example #: doc/guix.texi:7015 #, no-wrap msgid "" "docker load -i pack.tar.gz\n" "docker run @var{image-id}\n" msgstr "" #. type: table #: doc/guix.texi:7020 doc/guix.texi:13969 doc/guix.texi:14590 #: doc/guix.texi:15000 msgid "Consider the package @var{expr} evaluates to." msgstr "" #. type: table #: doc/guix.texi:7024 msgid "" "This has the same purpose as the same-named option in @command{guix build} " "(@pxref{Additional Build Options, @option{--expression} in @command{guix " "build}})." msgstr "" #. type: anchor{#1} #: doc/guix.texi:7026 msgid "pack-manifest" msgstr "" #. type: table #: doc/guix.texi:7031 msgid "" "Use the packages contained in the manifest object returned by the Scheme " "code in @var{file}. This option can be repeated several times, in which " "case the manifests are concatenated." msgstr "" #. type: table #: doc/guix.texi:7039 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: table #: doc/guix.texi:7044 msgid "" "@xref{Writing Manifests}, for information on how to write a manifest. " "@xref{shell-export-manifest, @command{guix shell --export-manifest}}, for " "information on how to ``convert'' command-line options into a manifest." msgstr "" #. type: item #: doc/guix.texi:7050 doc/guix.texi:12944 doc/guix.texi:38750 #, no-wrap msgid "--target=@var{triplet}" msgstr "" #. type: cindex #: doc/guix.texi:7051 doc/guix.texi:7510 doc/guix.texi:12945 #, no-wrap msgid "cross-compilation" msgstr "" #. type: table #: doc/guix.texi:7055 doc/guix.texi:38754 msgid "" "Cross-build for @var{triplet}, which must be a valid GNU triplet, such as " "@code{\"aarch64-linux-gnu\"} (@pxref{Specifying target triplets, GNU " "configuration triplets,, autoconf, Autoconf})." msgstr "" #. type: item #: doc/guix.texi:7056 #, no-wrap msgid "--compression=@var{tool}" msgstr "" #. type: itemx #: doc/guix.texi:7057 #, no-wrap msgid "-C @var{tool}" msgstr "" #. type: table #: doc/guix.texi:7061 msgid "" "Compress the resulting tarball using @var{tool}---one of @code{gzip}, " "@code{zstd}, @code{bzip2}, @code{xz}, @code{lzip}, or @code{none} for no " "compression." msgstr "" #. type: anchor{#1} #: doc/guix.texi:7063 msgid "pack-symlink-option" msgstr "" #. type: table #: doc/guix.texi:7067 msgid "" "Add the symlinks specified by @var{spec} to the pack. This option can " "appear several times." msgstr "" #. type: table #: doc/guix.texi:7071 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:7074 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:7075 doc/guix.texi:38761 #, no-wrap msgid "--save-provenance" msgstr "" #. type: table #: doc/guix.texi:7079 msgid "" "Save provenance information for the packages passed on the command line. " "Provenance information includes the URL and commit of the channels in use " "(@pxref{Channels})." msgstr "" #. type: table #: doc/guix.texi:7085 msgid "" "Provenance information is saved in the @file{/gnu/store/@dots{}-profile/" "manifest} file in the pack, along with the usual package metadata---the name " "and version of each package, their propagated inputs, and so on. It is " "useful information to the recipient of the pack, who then knows how the pack " "was (supposedly) obtained." msgstr "" #. type: table #: doc/guix.texi:7091 msgid "" "This option is not enabled by default because, like timestamps, provenance " "information contributes nothing to the build process. In other words, there " "is an infinity of channel URLs and commit IDs that can lead to the same " "pack. Recording such ``silent'' metadata in the output thus potentially " "breaks the source-to-binary bitwise reproducibility property." msgstr "" #. type: cindex #: doc/guix.texi:7094 #, no-wrap msgid "garbage collector root, for packs" msgstr "" #. type: table #: doc/guix.texi:7097 msgid "" "Make @var{file} a symlink to the resulting pack, and register it as a " "garbage collector root." msgstr "" #. type: item #: doc/guix.texi:7098 #, no-wrap msgid "--localstatedir" msgstr "" #. type: itemx #: doc/guix.texi:7099 #, no-wrap msgid "--profile-name=@var{name}" msgstr "" #. type: table #: doc/guix.texi:7104 msgid "" "Include the ``local state directory'', @file{/var/guix}, in the resulting " "pack, and notably the @file{/var/guix/profiles/per-user/root/@var{name}} " "profile---by default @var{name} is @code{guix-profile}, which corresponds to " "@file{~root/.guix-profile}." msgstr "" #. type: table #: doc/guix.texi:7110 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:7113 msgid "" "One use case for this is the Guix self-contained binary tarball " "(@pxref{Binary Installation})." msgstr "" #. type: item #: doc/guix.texi:7114 doc/guix.texi:38755 #, no-wrap msgid "--derivation" msgstr "" #. type: itemx #: doc/guix.texi:7115 doc/guix.texi:12984 doc/guix.texi:38756 #, no-wrap msgid "-d" msgstr "" #. type: table #: doc/guix.texi:7117 msgid "Print the name of the derivation that builds the pack." msgstr "" #. type: table #: doc/guix.texi:7121 msgid "" "Use the bootstrap binaries to build the pack. This option is only useful to " "Guix developers." msgstr "" #. type: Plain text #: doc/guix.texi:7126 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: cindex #: doc/guix.texi:7131 #, no-wrap msgid "GCC" msgstr "" #. type: cindex #: doc/guix.texi:7132 #, no-wrap msgid "ld-wrapper" msgstr "" #. type: cindex #: doc/guix.texi:7133 #, no-wrap msgid "linker wrapper" msgstr "" #. type: cindex #: doc/guix.texi:7134 #, no-wrap msgid "toolchain, for C development" msgstr "" #. type: cindex #: doc/guix.texi:7135 #, no-wrap msgid "toolchain, for Fortran development" msgstr "" #. type: Plain text #: doc/guix.texi:7142 msgid "" "If you need a complete toolchain for compiling and linking C or C++ source " "code, use the @code{gcc-toolchain} package. This package provides a " "complete GCC toolchain for C/C++ development, including GCC itself, the GNU " "C Library (headers and binaries, plus debugging symbols in the @code{debug} " "output), Binutils, and a linker wrapper." msgstr "" #. type: Plain text #: doc/guix.texi:7148 msgid "" "The wrapper's purpose is to inspect the @code{-L} and @code{-l} switches " "passed to the linker, add corresponding @code{-rpath} arguments, and invoke " "the actual linker with this new set of arguments. You can instruct the " "wrapper to refuse to link against libraries not in the store by setting the " "@env{GUIX_LD_WRAPPER_ALLOW_IMPURITIES} environment variable to @code{no}." msgstr "" #. type: Plain text #: doc/guix.texi:7152 msgid "" "The package @code{gfortran-toolchain} provides a complete GCC toolchain for " "Fortran development. For other languages, please use @samp{guix search gcc " "toolchain} (@pxref{guix-search,, Invoking guix package})." msgstr "" #. type: section #: doc/guix.texi:7155 #, no-wrap msgid "Invoking @command{guix git authenticate}" msgstr "" #. type: command{#1} #: doc/guix.texi:7157 #, no-wrap msgid "guix git authenticate" msgstr "" #. type: Plain text #: doc/guix.texi:7165 msgid "" "The @command{guix git authenticate} command authenticates a Git checkout " "following the same rule as for channels (@pxref{channel-authentication, " "channel authentication}). That is, starting from a given commit, it ensures " "that all subsequent commits are signed by an OpenPGP key whose fingerprint " "appears in the @file{.guix-authorizations} file of its parent commit(s)." msgstr "" #. type: Plain text #: doc/guix.texi:7170 msgid "" "You will find this command useful if you maintain a channel. But in fact, " "this authentication mechanism is useful in a broader context, so you might " "want to use it for Git repositories that have nothing to do with Guix." msgstr "" #. type: example #: doc/guix.texi:7175 #, no-wrap msgid "guix git authenticate @var{commit} @var{signer} [@var{options}@dots{}]\n" msgstr "" #. type: Plain text #: doc/guix.texi:7184 msgid "" "By default, this command authenticates the Git checkout in the current " "directory; it outputs nothing and exits with exit code zero on success and " "non-zero on failure. @var{commit} above denotes the first commit where " "authentication takes place, and @var{signer} is the OpenPGP fingerprint of " "public key used to sign @var{commit}. Together, they form a ``channel " "introduction'' (@pxref{channel-authentication, channel introduction}). The " "options below allow you to fine-tune the process." msgstr "" #. type: item #: doc/guix.texi:7186 #, no-wrap msgid "--repository=@var{directory}" msgstr "" #. type: itemx #: doc/guix.texi:7187 #, no-wrap msgid "-r @var{directory}" msgstr "" #. type: table #: doc/guix.texi:7190 msgid "" "Open the Git repository in @var{directory} instead of the current directory." msgstr "" #. type: item #: doc/guix.texi:7191 #, no-wrap msgid "--keyring=@var{reference}" msgstr "" #. type: itemx #: doc/guix.texi:7192 #, no-wrap msgid "-k @var{reference}" msgstr "" #. type: table #: doc/guix.texi:7198 msgid "" "Load OpenPGP keyring from @var{reference}, the reference of a branch such as " "@code{origin/keyring} or @code{my-keyring}. The branch must contain OpenPGP " "public keys in @file{.key} files, either in binary form or ``ASCII-" "armored''. By default the keyring is loaded from the branch named " "@code{keyring}." msgstr "" #. type: item #: doc/guix.texi:7199 #, no-wrap msgid "--stats" msgstr "" #. type: table #: doc/guix.texi:7201 msgid "Display commit signing statistics upon completion." msgstr "" #. type: item #: doc/guix.texi:7202 #, no-wrap msgid "--cache-key=@var{key}" msgstr "" #. type: table #: doc/guix.texi:7206 msgid "" "Previously-authenticated commits are cached in a file under @file{~/.cache/" "guix/authentication}. This option forces the cache to be stored in file " "@var{key} in that directory." msgstr "" #. type: item #: doc/guix.texi:7207 #, no-wrap msgid "--historical-authorizations=@var{file}" msgstr "" #. type: table #: doc/guix.texi:7214 msgid "" "By default, any commit whose parent commit(s) lack the @file{.guix-" "authorizations} file is considered inauthentic. In contrast, this option " "considers the authorizations in @var{file} for any commit that lacks @file{." "guix-authorizations}. The format of @var{file} is the same as that of " "@file{.guix-authorizations} (@pxref{channel-authorizations, @file{.guix-" "authorizations} format})." msgstr "" #. type: Plain text #: doc/guix.texi:7227 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:7233 msgid "" "Build actions are performed by the Guix daemon, on behalf of users. In a " "standard setup, the daemon has write access to the store---the @file{/gnu/" "store} directory---whereas users do not. The recommended setup also has the " "daemon perform builds in chroots, under specific build users, to minimize " "interference with the rest of the system." msgstr "" #. type: Plain text #: doc/guix.texi:7242 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:7245 msgid "" "This chapter describes all these APIs in turn, starting from high-level " "package definitions." msgstr "" #. type: menuentry #: doc/guix.texi:7261 msgid "Programming Guix in Guile" msgstr "" #. type: Plain text #: doc/guix.texi:7277 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{} object (@pxref{Defining " "Packages})." msgstr "" #. type: Plain text #: doc/guix.texi:7284 msgid "" "The @code{(gnu packages @dots{})} module name space is automatically scanned " "for packages by the command-line tools. For instance, when running " "@code{guix install emacs}, all the @code{(gnu packages @dots{})} modules are " "scanned until one that exports a package object whose name is @code{emacs} " "is found. This package search facility is implemented in the @code{(gnu " "packages)} module." msgstr "" #. type: cindex #: doc/guix.texi:7286 #, no-wrap msgid "package module search path" msgstr "" #. type: Plain text #: doc/guix.texi:7295 msgid "" "Users can store package definitions in modules with different names---e.g., " "@code{(my-packages emacs)}@footnote{Note that the file name and module name " "must match. For instance, the @code{(my-packages emacs)} module must be " "stored in a @file{my-packages/emacs.scm} file relative to the load path " "specified with @option{--load-path} or @env{GUIX_PACKAGE_PATH}. " "@xref{Modules and the File System,,, guile, GNU Guile Reference Manual}, for " "details.}. There are two ways to make these package definitions visible to " "the user interfaces:" msgstr "" #. type: enumerate #: doc/guix.texi:7302 msgid "" "By adding the directory containing your package modules to the search path " "with the @code{-L} flag of @command{guix package} and other commands " "(@pxref{Common Build Options}), or by setting the @env{GUIX_PACKAGE_PATH} " "environment variable described below." msgstr "" #. type: enumerate #: doc/guix.texi:7308 msgid "" "By defining a @dfn{channel} and configuring @command{guix pull} so that it " "pulls from it. A channel is essentially a Git repository containing package " "modules. @xref{Channels}, for more information on how to define and use " "channels." msgstr "" #. type: Plain text #: doc/guix.texi:7311 msgid "@env{GUIX_PACKAGE_PATH} works similarly to other search path variables:" msgstr "" #. type: defvr #: doc/guix.texi:7312 #, no-wrap msgid "{Environment Variable} GUIX_PACKAGE_PATH" msgstr "" #. type: defvr #: doc/guix.texi:7316 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:7324 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: Plain text #: doc/guix.texi:7332 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: lisp #: doc/guix.texi:7340 #, 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: lisp #: doc/guix.texi:7359 #, 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 (list gawk))\n" " (synopsis \"Hello, GNU world: An example GNU package\")\n" " (description \"Guess what GNU Hello prints!\")\n" " (home-page \"https://www.gnu.org/software/hello/\")\n" " (license gpl3+)))\n" msgstr "" #. type: Plain text #: doc/guix.texi:7369 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{} 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:7373 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:7379 msgid "" "In the example above, @code{hello} is defined in a module of its own, " "@code{(gnu packages hello)}. Technically, this is not strictly necessary, " "but it is convenient to do so: all the packages defined in modules under " "@code{(gnu packages @dots{})} are automatically known to the command-line " "tools (@pxref{Package Modules})." msgstr "" #. type: Plain text #: doc/guix.texi:7381 msgid "There are a few points worth noting in the above package definition:" msgstr "" #. type: itemize #: doc/guix.texi:7388 msgid "" "The @code{source} field of the package is an @code{} 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:7391 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:7398 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:7399 #, no-wrap msgid "patches" msgstr "" #. type: itemize #: doc/guix.texi:7403 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:7405 #, no-wrap msgid "GNU Build System" msgstr "" #. type: itemize #: doc/guix.texi:7411 msgid "" "The @code{build-system} field specifies the procedure to build the package " "(@pxref{Build Systems}). Here, @code{gnu-build-system} represents the " "familiar GNU Build System, where packages may be configured, built, and " "installed with the usual @code{./configure && make && make check && make " "install} command sequence." msgstr "" #. type: itemize #: doc/guix.texi:7415 msgid "" "When you start packaging non-trivial software, you may need tools to " "manipulate those build phases, manipulate files, and so on. @xref{Build " "Utilities}, for more on this." msgstr "" #. type: itemize #: doc/guix.texi:7421 msgid "" "The @code{arguments} field specifies options for the build system " "(@pxref{Build Systems}). Here it is interpreted by @code{gnu-build-system} " "as a request run @file{configure} with the @option{--enable-silent-rules} " "flag." msgstr "" #. type: findex #: doc/guix.texi:7422 doc/guix.texi:7425 #, no-wrap msgid "quote" msgstr "" #. type: cindex #: doc/guix.texi:7423 #, no-wrap msgid "quoting" msgstr "" #. type: findex #: doc/guix.texi:7424 #, no-wrap msgid "'" msgstr "" #. type: cindex #: doc/guix.texi:7426 #, no-wrap msgid "backquote (quasiquote)" msgstr "" #. type: findex #: doc/guix.texi:7427 #, no-wrap msgid "`" msgstr "" #. type: findex #: doc/guix.texi:7428 #, no-wrap msgid "quasiquote" msgstr "" #. type: cindex #: doc/guix.texi:7429 #, no-wrap msgid "comma (unquote)" msgstr "" #. type: findex #: doc/guix.texi:7430 #, no-wrap msgid "," msgstr "" #. type: findex #: doc/guix.texi:7431 #, no-wrap msgid "unquote" msgstr "" #. type: itemize #: doc/guix.texi:7441 msgid "" "What about these quote (@code{'}) characters? They are Scheme syntax to " "introduce a literal list; @code{'} is synonymous with @code{quote}. " "Sometimes you'll also see @code{`} (a backquote, synonymous with " "@code{quasiquote}) and @code{,} (a comma, synonymous with @code{unquote}). " "@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:7447 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:7453 msgid "" "The @code{inputs} field specifies inputs to the build process---i.e., build-" "time or run-time dependencies of the package. Here, we add an input, a " "reference to the @code{gawk} variable; @code{gawk} is itself bound to a " "@code{} object." msgstr "" #. type: itemize #: doc/guix.texi:7457 msgid "" "Note that GCC, Coreutils, Bash, and other essential tools do not need to be " "specified as inputs here. Instead, @code{gnu-build-system} takes care of " "ensuring that they are present (@pxref{Build Systems})." msgstr "" #. type: itemize #: doc/guix.texi:7461 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:7464 msgid "@xref{package Reference}, for a full description of possible fields." msgstr "" #. type: cindex #: doc/guix.texi:7466 #, no-wrap msgid "Scheme programming language, getting started" msgstr "" #. type: quotation #: doc/guix.texi:7471 msgid "" "Intimidated by the Scheme language or curious about it? The Cookbook has a " "short section to get started that recaps some of the things shown above and " "explains the fundamentals. @xref{A Scheme Crash Course,,, guix-cookbook, " "GNU Guix Cookbook}, for more information." msgstr "" #. type: Plain text #: doc/guix.texi:7483 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:7483 #, no-wrap msgid "GUIX_PACKAGE_PATH" msgstr "" #. type: Plain text #: doc/guix.texi:7487 msgid "" "Lastly, @pxref{Channels}, for information on how to extend the distribution " "by adding your own package definitions in a ``channel''." msgstr "" #. type: Plain text #: doc/guix.texi:7491 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:7497 msgid "" "Behind the scenes, a derivation corresponding to the @code{} object " "is first computed by the @code{package-derivation} procedure. That " "derivation is stored in a @file{.drv} file under @file{/gnu/store}. The " "build actions it prescribes may then be realized by using the @code{build-" "derivations} procedure (@pxref{The Store})." msgstr "" #. type: deffn #: doc/guix.texi:7498 #, no-wrap msgid "{Scheme Procedure} package-derivation @var{store} @var{package} [@var{system}]" msgstr "" #. type: deffn #: doc/guix.texi:7501 msgid "" "Return the @code{} object of @var{package} for @var{system} " "(@pxref{Derivations})." msgstr "" #. type: deffn #: doc/guix.texi:7507 msgid "" "@var{package} must be a valid @code{} 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:7513 msgid "" "Similarly, it is possible to compute a derivation that cross-builds a " "package for some other system:" msgstr "" #. type: deffn #: doc/guix.texi:7514 #, no-wrap msgid "{Scheme Procedure} package-cross-derivation @var{store} @" msgstr "" #. type: deffn #: doc/guix.texi:7518 msgid "" "@var{package} @var{target} [@var{system}] Return the @code{} " "object of @var{package} cross-built from @var{system} to @var{target}." msgstr "" #. type: deffn #: doc/guix.texi:7522 msgid "" "@var{target} must be a valid GNU triplet denoting the target hardware and " "operating system, such as @code{\"aarch64-linux-gnu\"} (@pxref{Specifying " "Target Triplets,,, autoconf, Autoconf})." msgstr "" #. type: Plain text #: doc/guix.texi:7526 msgid "" "Once you have package definitions, you can easily define @emph{variants} of " "those packages. @xref{Defining Package Variants}, for more on that." msgstr "" #. type: subsection #: doc/guix.texi:7534 #, no-wrap msgid "@code{package} Reference" msgstr "" #. type: Plain text #: doc/guix.texi:7538 msgid "" "This section summarizes all the options available in @code{package} " "declarations (@pxref{Defining Packages})." msgstr "" #. type: deftp #: doc/guix.texi:7539 #, no-wrap msgid "{Data Type} package" msgstr "" #. type: deftp #: doc/guix.texi:7541 msgid "This is the data type representing a package recipe." msgstr "" #. type: table #: doc/guix.texi:7545 msgid "The name of the package, as a string." msgstr "" #. type: code{#1} #: doc/guix.texi:7546 doc/guix.texi:8446 #, no-wrap msgid "version" msgstr "" #. type: table #: doc/guix.texi:7549 msgid "" "The version of the package, as a string. @xref{Version Numbers}, for " "guidelines." msgstr "" #. type: code{#1} #: doc/guix.texi:7550 doc/guix.texi:14445 doc/guix.texi:16923 #: doc/guix.texi:17549 #, no-wrap msgid "source" msgstr "" #. type: table #: doc/guix.texi:7557 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:7558 #, no-wrap msgid "build-system" msgstr "" #. type: table #: doc/guix.texi:7561 msgid "" "The build system that should be used to build the package (@pxref{Build " "Systems})." msgstr "" #. type: item #: doc/guix.texi:7562 doc/guix.texi:20108 #, no-wrap msgid "@code{arguments} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:7566 msgid "" "The arguments that should be passed to the build system (@pxref{Build " "Systems}). This is a list, typically containing sequential keyword-value " "pairs, as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:7575 #, no-wrap msgid "" "(package\n" " (name \"example\")\n" " ;; several fields omitted\n" " (arguments\n" " (list #:tests? #f ;skip tests\n" " #:make-flags #~'(\"VERBOSE=1\") ;pass flags to 'make'\n" " #:configure-flags #~'(\"--enable-frobbing\"))))\n" msgstr "" #. type: table #: doc/guix.texi:7582 msgid "" "The exact set of supported keywords depends on the build system " "(@pxref{Build Systems}), but you will find that almost all of them honor " "@code{#:configure-flags}, @code{#:make-flags}, @code{#:tests?}, and @code{#:" "phases}. The @code{#:phases} keyword in particular lets you modify the set " "of build phases for your package (@pxref{Build Phases})." msgstr "" #. type: item #: doc/guix.texi:7583 #, no-wrap msgid "@code{inputs} (default: @code{'()})" msgstr "" #. type: itemx #: doc/guix.texi:7584 #, no-wrap msgid "@code{native-inputs} (default: @code{'()})" msgstr "" #. type: itemx #: doc/guix.texi:7585 #, no-wrap msgid "@code{propagated-inputs} (default: @code{'()})" msgstr "" #. type: cindex #: doc/guix.texi:7586 #, no-wrap msgid "inputs, of packages" msgstr "" #. type: table #: doc/guix.texi:7593 msgid "" "These fields list dependencies of the package. Each element of these lists " "is either a package, origin, or other ``file-like object'' (@pxref{G-" "Expressions}); to specify the output of that file-like object that should be " "used, pass a two-element list where the second element is the output " "(@pxref{Packages with Multiple Outputs}, for more on package outputs). For " "example, the list below specifies three inputs:" msgstr "" #. type: lisp #: doc/guix.texi:7597 #, no-wrap msgid "" "(list libffi libunistring\n" " `(,glib \"bin\")) ;the \"bin\" output of GLib\n" msgstr "" #. type: table #: doc/guix.texi:7601 msgid "" "In the example above, the @code{\"out\"} output of @code{libffi} and " "@code{libunistring} is used." msgstr "" #. type: quotation #: doc/guix.texi:7602 #, no-wrap msgid "Compatibility Note" msgstr "" #. type: quotation #: doc/guix.texi:7609 msgid "" "Until version 1.3.0, input lists were 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\"}. For example, " "the list below is equivalent to the one above, but using the @dfn{old input " "style}:" msgstr "" #. type: lisp #: doc/guix.texi:7615 #, no-wrap msgid "" ";; Old input style (deprecated).\n" "`((\"libffi\" ,libffi)\n" " (\"libunistring\" ,libunistring)\n" " (\"glib:bin\" ,glib \"bin\")) ;the \"bin\" output of GLib\n" msgstr "" #. type: quotation #: doc/guix.texi:7621 msgid "" "This style is now deprecated; it is still supported but support will be " "removed in a future version. It should not be used for new package " "definitions. @xref{Invoking guix style}, on how to migrate to the new style." msgstr "" #. type: cindex #: doc/guix.texi:7623 #, no-wrap msgid "cross compilation, package dependencies" msgstr "" #. type: table #: doc/guix.texi:7629 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:7634 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:7642 msgid "package-propagated-inputs" msgstr "" #. type: table #: doc/guix.texi:7642 msgid "" "Lastly, @code{propagated-inputs} is similar to @code{inputs}, but the " "specified packages will be automatically installed to profiles " "(@pxref{Features, the role of profiles in Guix}) alongside the package they " "belong to (@pxref{package-cmd-propagated-inputs, @command{guix package}}, " "for information on how @command{guix package} deals with propagated inputs)." msgstr "" #. type: table #: doc/guix.texi:7646 msgid "" "For example this is necessary when packaging a C/C++ library that needs " "headers of another library to compile, or when a pkg-config file refers to " "another one @i{via} its @code{Requires} field." msgstr "" #. type: table #: doc/guix.texi:7653 msgid "" "Another example where @code{propagated-inputs} is useful is for languages " "that lack a facility to record the run-time search path akin to the " "@code{RUNPATH} of ELF files; this includes Guile, Python, Perl, and more. " "When packaging libraries written in those languages, ensure they can find " "library code they depend on at run time by listing run-time dependencies in " "@code{propagated-inputs} rather than @code{inputs}." msgstr "" #. type: item #: doc/guix.texi:7654 #, no-wrap msgid "@code{outputs} (default: @code{'(\"out\")})" msgstr "" #. type: table #: doc/guix.texi:7657 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:7658 #, no-wrap msgid "@code{native-search-paths} (default: @code{'()})" msgstr "" #. type: item #: doc/guix.texi:7659 doc/guix.texi:8465 #, no-wrap msgid "@code{search-paths} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:7663 msgid "" "A list of @code{search-path-specification} objects describing search-path " "environment variables honored by the package. @xref{Search Paths}, for more " "on search path specifications." msgstr "" #. type: table #: doc/guix.texi:7669 msgid "" "As for inputs, the distinction between @code{native-search-paths} and " "@code{search-paths} only matters when cross-compiling. In a cross-" "compilation context, @code{native-search-paths} applies exclusively to " "native inputs whereas @code{search-paths} applies only to host inputs." msgstr "" #. type: table #: doc/guix.texi:7676 msgid "" "Packages such as cross-compilers care about target inputs---for instance, " "our (modified) GCC cross-compiler has @env{CROSS_C_INCLUDE_PATH} in " "@code{search-paths}, which allows it to pick @file{.h} files for the target " "system and @emph{not} those of native inputs. For the majority of packages " "though, only @code{native-search-paths} makes sense." msgstr "" #. type: item #: doc/guix.texi:7677 #, no-wrap msgid "@code{replacement} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:7681 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:7682 doc/guix.texi:14437 #, no-wrap msgid "synopsis" msgstr "" #. type: table #: doc/guix.texi:7684 msgid "A one-line description of the package." msgstr "" #. type: code{#1} #: doc/guix.texi:7685 doc/guix.texi:14438 doc/guix.texi:39522 #: doc/guix.texi:39682 #, no-wrap msgid "description" msgstr "" #. type: table #: doc/guix.texi:7688 msgid "" "A more elaborate description of the package, as a string in Texinfo syntax." msgstr "" #. type: code{#1} #: doc/guix.texi:7689 #, no-wrap msgid "license" msgstr "" #. type: cindex #: doc/guix.texi:7690 #, no-wrap msgid "license, of packages" msgstr "" #. type: table #: doc/guix.texi:7693 msgid "" "The license of the package; a value from @code{(guix licenses)}, or a list " "of such values." msgstr "" #. type: itemx #: doc/guix.texi:7694 doc/guix.texi:14446 #, no-wrap msgid "home-page" msgstr "" #. type: table #: doc/guix.texi:7696 msgid "The URL to the home-page of the package, as a string." msgstr "" #. type: item #: doc/guix.texi:7697 #, no-wrap msgid "@code{supported-systems} (default: @code{%supported-systems})" msgstr "" #. type: table #: doc/guix.texi:7700 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:7701 #, no-wrap msgid "@code{location} (default: source location of the @code{package} form)" msgstr "" #. type: table #: doc/guix.texi:7705 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: deffn #: doc/guix.texi:7708 #, no-wrap msgid "{Scheme Syntax} this-package" msgstr "" #. type: deffn #: doc/guix.texi:7711 msgid "" "When used in the @emph{lexical scope} of a package field definition, this " "identifier resolves to the package being defined." msgstr "" #. type: deffn #: doc/guix.texi:7714 msgid "" "The example below shows how to add a package as a native input of itself " "when cross-compiling:" msgstr "" #. type: lisp #: doc/guix.texi:7719 #, no-wrap msgid "" "(package\n" " (name \"guile\")\n" " ;; ...\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:7725 #, no-wrap msgid "" " ;; When cross-compiled, Guile, for example, depends on\n" " ;; a native version of itself. Add it here.\n" " (native-inputs (if (%current-target-system)\n" " (list this-package)\n" " '())))\n" msgstr "" #. type: deffn #: doc/guix.texi:7728 msgid "" "It is an error to refer to @code{this-package} outside a package definition." msgstr "" #. type: Plain text #: doc/guix.texi:7732 msgid "" "The following helper procedures are provided to help deal with package " "inputs." msgstr "" #. type: deffn #: doc/guix.texi:7733 #, no-wrap msgid "{Scheme Procedure} lookup-package-input @var{package} @var{name}" msgstr "" #. type: deffnx #: doc/guix.texi:7734 #, no-wrap msgid "{Scheme Procedure} lookup-package-native-input @var{package} @var{name}" msgstr "" #. type: deffnx #: doc/guix.texi:7735 #, no-wrap msgid "{Scheme Procedure} lookup-package-propagated-input @var{package} @var{name}" msgstr "" #. type: deffnx #: doc/guix.texi:7736 #, no-wrap msgid "{Scheme Procedure} lookup-package-direct-input @var{package} @var{name}" msgstr "" #. type: deffn #: doc/guix.texi:7739 msgid "" "Look up @var{name} among @var{package}'s inputs (or native, propagated, or " "direct inputs). Return it if found, @code{#f} otherwise." msgstr "" #. type: deffn #: doc/guix.texi:7742 msgid "" "@var{name} is the name of a package depended on. Here's how you might use " "it:" msgstr "" #. type: lisp #: doc/guix.texi:7745 #, no-wrap msgid "" "(use-modules (guix packages) (gnu packages base))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:7748 #, no-wrap msgid "" "(lookup-package-direct-input coreutils \"gmp\")\n" "@result{} #\n" msgstr "" #. type: deffn #: doc/guix.texi:7752 msgid "" "In this example we obtain the @code{gmp} package that is among the direct " "inputs of @code{coreutils}." msgstr "" #. type: cindex #: doc/guix.texi:7754 #, no-wrap msgid "development inputs, of a package" msgstr "" #. type: cindex #: doc/guix.texi:7755 #, no-wrap msgid "implicit inputs, of a package" msgstr "" #. type: Plain text #: doc/guix.texi:7760 msgid "" "Sometimes you will want to obtain the list of inputs needed to " "@emph{develop} a package---all the inputs that are visible when the package " "is compiled. This is what the @code{package-development-inputs} procedure " "returns." msgstr "" #. type: deffn #: doc/guix.texi:7761 #, no-wrap msgid "{Scheme Procedure} package-development-inputs @var{package} @" msgstr "" #. type: deffn #: doc/guix.texi:7768 msgid "" "[@var{system}] [#:target #f] Return the list of inputs required by " "@var{package} for development purposes on @var{system}. When @var{target} " "is true, return the inputs needed to cross-compile @var{package} from " "@var{system} to @var{target}, where @var{target} is a triplet such as " "@code{\"aarch64-linux-gnu\"}." msgstr "" #. type: deffn #: doc/guix.texi:7772 msgid "" "Note that the result includes both explicit inputs and implicit inputs---" "inputs automatically added by the build system (@pxref{Build Systems}). Let " "us take the @code{hello} package to illustrate that:" msgstr "" #. type: lisp #: doc/guix.texi:7775 #, no-wrap msgid "" "(use-modules (gnu packages base) (guix packages))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:7778 #, no-wrap msgid "" "hello\n" "@result{} #\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:7781 #, no-wrap msgid "" "(package-direct-inputs hello)\n" "@result{} ()\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:7784 #, no-wrap msgid "" "(package-development-inputs hello)\n" "@result{} ((\"source\" @dots{}) (\"tar\" #) @dots{})\n" msgstr "" #. type: deffn #: doc/guix.texi:7793 msgid "" "In this example, @code{package-direct-inputs} returns the empty list, " "because @code{hello} has zero explicit dependencies. Conversely, " "@code{package-development-inputs} includes inputs implicitly added by " "@code{gnu-build-system} that are required to build @code{hello}: tar, gzip, " "GCC, libc, Bash, and more. To visualize it, @command{guix graph hello} " "would show you explicit inputs, whereas @command{guix graph -t bag hello} " "would include implicit inputs (@pxref{Invoking guix graph})." msgstr "" #. type: Plain text #: doc/guix.texi:7799 msgid "" "Because packages are regular Scheme objects that capture a complete " "dependency graph and associated build procedures, it is often useful to " "write procedures that take a package and return a modified version thereof " "according to some parameters. Below are a few examples." msgstr "" #. type: cindex #: doc/guix.texi:7800 #, no-wrap msgid "tool chain, choosing a package's tool chain" msgstr "" #. type: deffn #: doc/guix.texi:7801 #, no-wrap msgid "{Scheme Procedure} package-with-c-toolchain @var{package} @var{toolchain}" msgstr "" #. type: deffn #: doc/guix.texi:7806 msgid "" "Return a variant of @var{package} that uses @var{toolchain} instead of the " "default GNU C/C++ toolchain. @var{toolchain} must be a list of inputs " "(label/package tuples) providing equivalent functionality, such as the " "@code{gcc-toolchain} package." msgstr "" #. type: deffn #: doc/guix.texi:7810 msgid "" "The example below returns a variant of the @code{hello} package built with " "GCC@tie{}10.x and the rest of the GNU tool chain (Binutils and the GNU C " "Library) instead of the default tool chain:" msgstr "" #. type: lisp #: doc/guix.texi:7814 #, no-wrap msgid "" "(let ((toolchain (specification->package \"gcc-toolchain@@10\")))\n" " (package-with-c-toolchain hello `((\"toolchain\" ,toolchain))))\n" msgstr "" #. type: deffn #: doc/guix.texi:7822 msgid "" "The build tool chain is part of the @dfn{implicit inputs} of packages---it's " "usually not listed as part of the various ``inputs'' fields and is instead " "pulled in by the build system. Consequently, this procedure works by " "changing the build system of @var{package} so that it pulls in " "@var{toolchain} instead of the defaults. @ref{Build Systems}, for more on " "build systems." msgstr "" #. type: subsection #: doc/guix.texi:7825 #, no-wrap msgid "@code{origin} Reference" msgstr "" #. type: Plain text #: doc/guix.texi:7833 msgid "" "This section documents @dfn{origins}. An @code{origin} declaration " "specifies data that must be ``produced''---downloaded, usually---and whose " "content hash is known in advance. Origins are primarily used to represent " "the source code of packages (@pxref{Defining Packages}). For that reason, " "the @code{origin} form allows you to declare patches to apply to the " "original source code as well as code snippets to modify it." msgstr "" #. type: deftp #: doc/guix.texi:7834 #, no-wrap msgid "{Data Type} origin" msgstr "" #. type: deftp #: doc/guix.texi:7836 msgid "This is the data type representing a source code origin." msgstr "" #. type: code{#1} #: doc/guix.texi:7838 doc/guix.texi:29377 #, no-wrap msgid "uri" msgstr "" #. type: table #: doc/guix.texi:7843 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: cindex #: doc/guix.texi:7844 #, no-wrap msgid "fixed-output derivations, for download" msgstr "" #. type: code{#1} #: doc/guix.texi:7845 #, no-wrap msgid "method" msgstr "" #. type: table #: doc/guix.texi:7852 msgid "" "A monadic procedure that handles the given URI@. The procedure must accept " "at least three arguments: the value of the @code{uri} field and the hash " "algorithm and hash value specified by the @code{hash} field. It must return " "a store item or a derivation in the store monad (@pxref{The Store Monad}); " "most methods return a fixed-output derivation (@pxref{Derivations})." msgstr "" #. type: table #: doc/guix.texi:7856 msgid "" "Commonly used methods include @code{url-fetch}, which fetches data from a " "URL, and @code{git-fetch}, which fetches data from a Git repository (see " "below)." msgstr "" #. type: code{#1} #: doc/guix.texi:7857 #, no-wrap msgid "sha256" msgstr "" #. type: table #: doc/guix.texi:7861 msgid "" "A bytevector containing the SHA-256 hash of the source. This is equivalent " "to providing a @code{content-hash} SHA256 object in the @code{hash} field " "described below." msgstr "" #. type: code{#1} #: doc/guix.texi:7862 #, no-wrap msgid "hash" msgstr "" #. type: table #: doc/guix.texi:7865 msgid "" "The @code{content-hash} object of the source---see below for how to use " "@code{content-hash}." msgstr "" #. type: table #: doc/guix.texi:7869 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:7870 #, no-wrap msgid "@code{file-name} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:7876 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:7877 #, no-wrap msgid "@code{patches} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:7880 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:7884 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:7885 #, no-wrap msgid "@code{snippet} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:7889 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:7890 #, no-wrap msgid "@code{patch-flags} (default: @code{'(\"-p1\")})" msgstr "" #. type: table #: doc/guix.texi:7893 msgid "" "A list of command-line flags that should be passed to the @code{patch} " "command." msgstr "" #. type: item #: doc/guix.texi:7894 #, no-wrap msgid "@code{patch-inputs} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:7898 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:7899 doc/guix.texi:29246 #, no-wrap msgid "@code{modules} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:7902 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:7903 #, no-wrap msgid "@code{patch-guile} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:7906 msgid "" "The Guile package that should be used in the patching process. When this is " "@code{#f}, a sensible default is used." msgstr "" #. type: deftp #: doc/guix.texi:7909 #, no-wrap msgid "{Data Type} content-hash @var{value} [@var{algorithm}]" msgstr "" #. type: deftp #: doc/guix.texi:7913 msgid "" "Construct a content hash object for the given @var{algorithm}, and with " "@var{value} as its hash value. When @var{algorithm} is omitted, assume it " "is @code{sha256}." msgstr "" #. type: deftp #: doc/guix.texi:7916 msgid "" "@var{value} can be a literal string, in which case it is base32-decoded, or " "it can be a bytevector." msgstr "" #. type: deftp #: doc/guix.texi:7918 msgid "The following forms are all equivalent:" msgstr "" #. type: lisp #: doc/guix.texi:7927 #, no-wrap msgid "" "(content-hash \"05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj\")\n" "(content-hash \"05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj\"\n" " sha256)\n" "(content-hash (base32\n" " \"05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj\"))\n" "(content-hash (base64 \"kkb+RPaP7uyMZmu4eXPVkM4BN8yhRd8BTHLslb6f/Rc=\")\n" " sha256)\n" msgstr "" #. type: deftp #: doc/guix.texi:7932 msgid "" "Technically, @code{content-hash} is currently implemented as a macro. It " "performs sanity checks at macro-expansion time, when possible, such as " "ensuring that @var{value} has the right size for @var{algorithm}." msgstr "" #. type: Plain text #: doc/guix.texi:7938 msgid "" "As we have seen above, how exactly the data an origin refers to is retrieved " "is determined by its @code{method} field. The @code{(guix download)} module " "provides the most common method, @code{url-fetch}, described below." msgstr "" #. type: deffn #: doc/guix.texi:7939 #, no-wrap msgid "{Scheme Procedure} url-fetch @var{url} @var{hash-algo} @var{hash} @" msgstr "" #. type: deffn #: doc/guix.texi:7947 msgid "" "[name] [#:executable? #f] Return a fixed-output derivation that fetches data " "from @var{url} (a string, or a list of strings denoting alternate URLs), " "which is expected to have hash @var{hash} of type @var{hash-algo} (a " "symbol). By default, the file name is the base name of URL; optionally, " "@var{name} can specify a different file name. When @var{executable?} is " "true, make the downloaded file executable." msgstr "" #. type: deffn #: doc/guix.texi:7950 msgid "" "When one of the URL starts with @code{mirror://}, then its host part is " "interpreted as the name of a mirror scheme, taken from @file{%mirror-file}." msgstr "" #. type: deffn #: doc/guix.texi:7953 msgid "" "Alternatively, when URL starts with @code{file://}, return the corresponding " "file name in the store." msgstr "" #. type: Plain text #: doc/guix.texi:7959 msgid "" "Likewise, the @code{(guix git-download)} module defines the @code{git-fetch} " "origin method, which fetches data from a Git version control repository, and " "the @code{git-reference} data type to describe the repository and revision " "to fetch." msgstr "" #. type: deffn #: doc/guix.texi:7960 #, no-wrap msgid "{Scheme Procedure} git-fetch @var{ref} @var{hash-algo} @var{hash}" msgstr "" #. type: deffn #: doc/guix.texi:7965 msgid "" "Return a fixed-output derivation that fetches @var{ref}, a @code{} object. The output is expected to have recursive hash " "@var{hash} of type @var{hash-algo} (a symbol). Use @var{name} as the file " "name, or a generic name if @code{#f}." msgstr "" #. type: deftp #: doc/guix.texi:7967 #, no-wrap msgid "{Data Type} git-reference" msgstr "" #. type: deftp #: doc/guix.texi:7970 msgid "" "This data type represents a Git reference for @code{git-fetch} to retrieve." msgstr "" #. type: code{#1} #: doc/guix.texi:7972 doc/guix.texi:27084 #, no-wrap msgid "url" msgstr "" #. type: table #: doc/guix.texi:7974 msgid "The URL of the Git repository to clone." msgstr "" #. type: code{#1} #: doc/guix.texi:7975 #, no-wrap msgid "commit" msgstr "" #. type: table #: doc/guix.texi:7980 msgid "" "This string denotes either the commit to fetch (a hexadecimal string), or " "the tag to fetch. You can also use a ``short'' commit ID or a @command{git " "describe} style identifier such as @code{v1.0.1-10-g58d7909c97}." msgstr "" #. type: item #: doc/guix.texi:7981 #, no-wrap msgid "@code{recursive?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:7983 msgid "This Boolean indicates whether to recursively fetch Git sub-modules." msgstr "" #. type: deftp #: doc/guix.texi:7987 msgid "" "The example below denotes the @code{v2.10} tag of the GNU@tie{}Hello " "repository:" msgstr "" #. type: lisp #: doc/guix.texi:7992 #, no-wrap msgid "" "(git-reference\n" " (url \"https://git.savannah.gnu.org/git/hello.git\")\n" " (commit \"v2.10\"))\n" msgstr "" #. type: deftp #: doc/guix.texi:7996 msgid "" "This is equivalent to the reference below, which explicitly names the commit:" msgstr "" #. type: lisp #: doc/guix.texi:8001 #, no-wrap msgid "" "(git-reference\n" " (url \"https://git.savannah.gnu.org/git/hello.git\")\n" " (commit \"dc7dc56a00e48fe6f231a58f6537139fe2908fb9\"))\n" msgstr "" #. type: Plain text #: doc/guix.texi:8007 msgid "" "For Mercurial repositories, the module @code{(guix hg-download)} defines the " "@code{hg-fetch} origin method and @code{hg-reference} data type for support " "of the Mercurial version control system." msgstr "" #. type: deffn #: doc/guix.texi:8008 #, no-wrap msgid "{Scheme Procedure} hg-fetch @var{ref} @var{hash-algo} @var{hash} @" msgstr "" #. type: deffn #: doc/guix.texi:8014 msgid "" "[name] Return a fixed-output derivation that fetches @var{ref}, a @code{} object. The output is expected to have recursive hash " "@var{hash} of type @var{hash-algo} (a symbol). Use @var{name} as the file " "name, or a generic name if @code{#false}." msgstr "" #. type: cindex #: doc/guix.texi:8019 #, no-wrap msgid "customizing packages" msgstr "" #. type: cindex #: doc/guix.texi:8020 #, no-wrap msgid "variants, of packages" msgstr "" #. type: Plain text #: doc/guix.texi:8030 msgid "" "One of the nice things with Guix is that, given a package definition, you " "can easily @emph{derive} variants of that package---for a different upstream " "version, with different dependencies, different compilation options, and so " "on. Some of these custom packages can be defined straight from the command " "line (@pxref{Package Transformation Options}). This section describes how " "to define package variants in code. This can be useful in " "``manifests'' (@pxref{Writing Manifests}) and in your own package " "collection (@pxref{Creating a Channel}), among others!" msgstr "" #. type: cindex #: doc/guix.texi:8031 #, no-wrap msgid "inherit, for package definitions" msgstr "" #. type: Plain text #: doc/guix.texi:8038 msgid "" "As discussed earlier, packages are first-class objects in the Scheme " "language. The @code{(guix packages)} module provides the @code{package} " "construct to define new package objects (@pxref{package Reference}). The " "easiest way to define a package variant is using the @code{inherit} keyword " "together with @code{package}. This allows you to inherit from a package " "definition while overriding the fields you want." msgstr "" #. type: Plain text #: doc/guix.texi:8043 msgid "" "For example, given the @code{hello} variable, which contains a definition " "for the current version of GNU@tie{}Hello, here's how you would define a " "variant for version 2.2 (released in 2006, it's vintage!):" msgstr "" #. type: lisp #: doc/guix.texi:8046 #, no-wrap msgid "" "(use-modules (gnu packages base)) ;for 'hello'\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:8058 #, no-wrap msgid "" "(define hello-2.2\n" " (package\n" " (inherit hello)\n" " (version \"2.2\")\n" " (source (origin\n" " (method url-fetch)\n" " (uri (string-append \"mirror://gnu/hello/hello-\" version\n" " \".tar.gz\"))\n" " (sha256\n" " (base32\n" " \"0lappv4slgb5spyqbh6yl5r013zv72yqg2pcl30mginf3wdqd8k9\"))))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:8067 msgid "" "The example above corresponds to what the @option{--with-source} package " "transformation option does. Essentially @code{hello-2.2} preserves all the " "fields of @code{hello}, except @code{version} and @code{source}, which it " "overrides. Note that the original @code{hello} variable is still there, in " "the @code{(gnu packages base)} module, unchanged. When you define a custom " "package like this, you are really @emph{adding} a new package definition; " "the original one remains available." msgstr "" #. type: Plain text #: doc/guix.texi:8073 msgid "" "You can just as well define variants with a different set of dependencies " "than the original package. For example, the default @code{gdb} package " "depends on @code{guile}, but since that is an optional dependency, you can " "define a variant that removes that dependency like so:" msgstr "" #. type: lisp #: doc/guix.texi:8076 #, no-wrap msgid "" "(use-modules (gnu packages gdb)) ;for 'gdb'\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:8082 #, no-wrap msgid "" "(define gdb-sans-guile\n" " (package\n" " (inherit gdb)\n" " (inputs (modify-inputs (package-inputs gdb)\n" " (delete \"guile\")))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:8088 msgid "" "The @code{modify-inputs} form above removes the @code{\"guile\"} package " "from the @code{inputs} field of @code{gdb}. The @code{modify-inputs} macro " "is a helper that can prove useful anytime you want to remove, add, or " "replace package inputs." msgstr "" #. type: deffn #: doc/guix.texi:8089 #, no-wrap msgid "{Scheme Syntax} modify-inputs @var{inputs} @var{clauses}" msgstr "" #. type: deffn #: doc/guix.texi:8093 msgid "" "Modify the given package inputs, as returned by @code{package-inputs} & co., " "according to the given clauses. Each clause must have one of the following " "forms:" msgstr "" #. type: item #: doc/guix.texi:8095 #, no-wrap msgid "(delete @var{name}@dots{})" msgstr "" #. type: table #: doc/guix.texi:8097 msgid "Delete from the inputs packages with the given @var{name}s (strings)." msgstr "" #. type: item #: doc/guix.texi:8098 #, no-wrap msgid "(prepend @var{package}@dots{})" msgstr "" #. type: table #: doc/guix.texi:8100 msgid "Add @var{package}s to the front of the input list." msgstr "" #. type: item #: doc/guix.texi:8101 #, no-wrap msgid "(append @var{package}@dots{})" msgstr "" #. type: table #: doc/guix.texi:8103 msgid "Add @var{package}s to the end of the input list." msgstr "" #. type: deffn #: doc/guix.texi:8107 msgid "" "The example below removes the GMP and ACL inputs of Coreutils and adds " "libcap to the front of the input list:" msgstr "" #. type: lisp #: doc/guix.texi:8112 #, no-wrap msgid "" "(modify-inputs (package-inputs coreutils)\n" " (delete \"gmp\" \"acl\")\n" " (prepend libcap))\n" msgstr "" #. type: deffn #: doc/guix.texi:8116 msgid "" "The example below replaces the @code{guile} package from the inputs of " "@code{guile-redis} with @code{guile-2.2}:" msgstr "" #. type: lisp #: doc/guix.texi:8120 #, no-wrap msgid "" "(modify-inputs (package-inputs guile-redis)\n" " (replace \"guile\" guile-2.2))\n" msgstr "" #. type: deffn #: doc/guix.texi:8124 msgid "" "The last type of clause is @code{append}, to add inputs at the back of the " "list." msgstr "" #. type: Plain text #: doc/guix.texi:8133 msgid "" "In some cases, you may find it useful to write functions (``procedures'', in " "Scheme parlance) that return a package based on some parameters. For " "example, consider the @code{luasocket} library for the Lua programming " "language. We want to create @code{luasocket} packages for major versions of " "Lua. One way to do that is to define a procedure that takes a Lua package " "and returns a @code{luasocket} package that depends on it:" msgstr "" #. type: lisp #: doc/guix.texi:8143 #, no-wrap msgid "" "(define (make-lua-socket name lua)\n" " ;; Return a luasocket package built with LUA.\n" " (package\n" " (name name)\n" " (version \"3.0\")\n" " ;; several fields omitted\n" " (inputs (list lua))\n" " (synopsis \"Socket library for Lua\")))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:8146 #, no-wrap msgid "" "(define-public lua5.1-socket\n" " (make-lua-socket \"lua5.1-socket\" lua-5.1))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:8149 #, no-wrap msgid "" "(define-public lua5.2-socket\n" " (make-lua-socket \"lua5.2-socket\" lua-5.2))\n" msgstr "" #. type: Plain text #: doc/guix.texi:8157 msgid "" "Here we have defined packages @code{lua5.1-socket} and @code{lua5.2-socket} " "by calling @code{make-lua-socket} with different arguments. " "@xref{Procedures,,, guile, GNU Guile Reference Manual}, for more info on " "procedures. Having top-level public definitions for these two packages " "means that they can be referred to from the command line (@pxref{Package " "Modules})." msgstr "" #. type: cindex #: doc/guix.texi:8158 #, no-wrap msgid "package transformations" msgstr "" #. type: Plain text #: doc/guix.texi:8163 msgid "" "These are pretty simple package variants. As a convenience, the @code{(guix " "transformations)} module provides a high-level interface that directly maps " "to the more sophisticated package transformation options (@pxref{Package " "Transformation Options}):" msgstr "" #. type: deffn #: doc/guix.texi:8164 #, no-wrap msgid "{Scheme Procedure} options->transformation @var{opts}" msgstr "" #. type: deffn #: doc/guix.texi:8168 msgid "" "Return a procedure that, when passed an object to build (package, " "derivation, etc.), applies the transformations specified by @var{opts} and " "returns the resulting objects. @var{opts} must be a list of symbol/string " "pairs such as:" msgstr "" #. type: lisp #: doc/guix.texi:8172 #, no-wrap msgid "" "((with-branch . \"guile-gcrypt=master\")\n" " (without-tests . \"libgcrypt\"))\n" msgstr "" #. type: deffn #: doc/guix.texi:8176 msgid "" "Each symbol names a transformation and the corresponding string is an " "argument to that transformation." msgstr "" #. type: Plain text #: doc/guix.texi:8179 msgid "For instance, a manifest equivalent to this command:" msgstr "" #. type: example #: doc/guix.texi:8184 #, no-wrap msgid "" "guix build guix \\\n" " --with-branch=guile-gcrypt=master \\\n" " --with-debug-info=zlib\n" msgstr "" #. type: Plain text #: doc/guix.texi:8188 msgid "... would look like this:" msgstr "" #. type: lisp #: doc/guix.texi:8191 #, no-wrap msgid "" "(use-modules (guix transformations))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:8197 #, no-wrap msgid "" "(define transform\n" " ;; The package transformation procedure.\n" " (options->transformation\n" " '((with-branch . \"guile-gcrypt=master\")\n" " (with-debug-info . \"zlib\"))))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:8200 #, no-wrap msgid "" "(packages->manifest\n" " (list (transform (specification->package \"guix\"))))\n" msgstr "" #. type: cindex #: doc/guix.texi:8202 #, no-wrap msgid "input rewriting" msgstr "" #. type: cindex #: doc/guix.texi:8203 #, no-wrap msgid "dependency graph rewriting" msgstr "" #. type: Plain text #: doc/guix.texi:8210 msgid "" "The @code{options->transformation} procedure is convenient, but it's perhaps " "also not as flexible as you may like. How is it implemented? The astute " "reader probably noticed that most package transformation options go beyond " "the superficial changes shown in the first examples of this section: they " "involve @dfn{input rewriting}, whereby the dependency graph of a package is " "rewritten by replacing specific inputs by others." msgstr "" #. type: Plain text #: doc/guix.texi:8214 msgid "" "Dependency graph rewriting, for the purposes of swapping packages in the " "graph, is what the @code{package-input-rewriting} procedure in @code{(guix " "packages)} implements." msgstr "" #. type: deffn #: doc/guix.texi:8215 #, no-wrap msgid "{Scheme Procedure} package-input-rewriting @var{replacements} @" msgstr "" #. type: deffn #: doc/guix.texi:8222 msgid "" "[@var{rewrite-name}] [#:deep? #t] Return a procedure that, when passed a " "package, replaces its direct and indirect dependencies, including implicit " "inputs when @var{deep?} is true, according to @var{replacements}. " "@var{replacements} is a list of package pairs; the first element of each " "pair is the package to replace, and the second one is the replacement." msgstr "" #. type: deffn #: doc/guix.texi:8225 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: table #: doc/guix.texi:8229 doc/guix.texi:12621 msgid "Consider this example:" msgstr "" #. type: lisp #: doc/guix.texi:8235 #, 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: lisp #: doc/guix.texi:8238 #, no-wrap msgid "" "(define git-with-libressl\n" " (libressl-instead-of-openssl git))\n" msgstr "" #. type: Plain text #: doc/guix.texi:8246 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:8249 msgid "" "The following variant of @code{package-input-rewriting} can match packages " "to be replaced by name rather than by identity." msgstr "" #. type: deffn #: doc/guix.texi:8250 #, no-wrap msgid "{Scheme Procedure} package-input-rewriting/spec @var{replacements} [#:deep? #t]" msgstr "" #. type: deffn #: doc/guix.texi:8257 msgid "" "Return a procedure that, given a package, applies the given " "@var{replacements} to all the package graph, including implicit inputs " "unless @var{deep?} is false. @var{replacements} is a list of spec/" "procedures pair; each spec is a package specification such as @code{\"gcc\"} " "or @code{\"guile@@2\"}, and each procedure takes a matching package and " "returns a replacement for that package." msgstr "" #. type: Plain text #: doc/guix.texi:8260 msgid "The example above could be rewritten this way:" msgstr "" #. type: lisp #: doc/guix.texi:8265 #, no-wrap msgid "" "(define libressl-instead-of-openssl\n" " ;; Replace all the packages called \"openssl\" with LibreSSL.\n" " (package-input-rewriting/spec `((\"openssl\" . ,(const libressl)))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:8270 msgid "" "The key difference here is that, this time, packages are matched by spec and " "not by identity. In other words, any package in the graph that is called " "@code{openssl} will be replaced." msgstr "" #. type: Plain text #: doc/guix.texi:8274 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:8275 #, no-wrap msgid "{Scheme Procedure} package-mapping @var{proc} [@var{cut?}] [#:deep? #f]" msgstr "" #. type: deffn #: doc/guix.texi:8280 msgid "" "Return a procedure that, given a package, applies @var{proc} to all the " "packages depended on and returns the resulting package. The procedure stops " "recursion when @var{cut?} returns true for a given package. When " "@var{deep?} is true, @var{proc} is applied to implicit inputs as well." msgstr "" #. type: cindex #: doc/guix.texi:8285 #, no-wrap msgid "manifest" msgstr "" #. type: cindex #: doc/guix.texi:8286 #, no-wrap msgid "bill of materials (manifests)" msgstr "" #. type: Plain text #: doc/guix.texi:8297 msgid "" "@command{guix} commands let you specify package lists on the command line. " "This is convenient, but as the command line becomes longer and less trivial, " "it quickly becomes more convenient to have that package list in what we call " "a @dfn{manifest}. A manifest is some sort of a ``bill of materials'' that " "defines a package set. You would typically come up with a code snippet that " "builds the manifest, store it in a file, say @file{manifest.scm}, and then " "pass that file to the @option{-m} (or @option{--manifest}) option that many " "@command{guix} commands support. For example, here's what a manifest for a " "simple package set might look like:" msgstr "" #. type: lisp #: doc/guix.texi:8301 #, no-wrap msgid "" ";; Manifest for three packages.\n" "(specifications->manifest '(\"gcc-toolchain\" \"make\" \"git\"))\n" msgstr "" #. type: Plain text #: doc/guix.texi:8307 msgid "" "Once you have that manifest, you can pass it, for example, to @command{guix " "package} to install just those three packages to your profile " "(@pxref{profile-manifest, @option{-m} option of @command{guix package}}):" msgstr "" #. type: example #: doc/guix.texi:8310 #, no-wrap msgid "guix package -m manifest.scm\n" msgstr "" #. type: Plain text #: doc/guix.texi:8316 msgid "" "... or you can pass it to @command{guix shell} (@pxref{shell-manifest, " "@command{-m} option of @command{guix shell}}) to spawn an ephemeral " "environment:" msgstr "" #. type: Plain text #: doc/guix.texi:8326 msgid "" "... or you can pass it to @command{guix pack} in pretty much the same way " "(@pxref{pack-manifest, @option{-m} option of @command{guix pack}}). You can " "store the manifest under version control, share it with others so they can " "easily get set up, etc." msgstr "" #. type: Plain text #: doc/guix.texi:8332 msgid "" "But how do you write your first manifest? To get started, maybe you'll want " "to write a manifest that mirrors what you already have in a profile. Rather " "than start from a blank page, @command{guix package} can generate a manifest " "for you (@pxref{export-manifest, @command{guix package --export-manifest}}):" msgstr "" #. type: example #: doc/guix.texi:8337 #, no-wrap msgid "" "# Write to 'manifest.scm' a manifest corresponding to the\n" "# default profile, ~/.guix-profile.\n" "guix package --export-manifest > manifest.scm\n" msgstr "" #. type: Plain text #: doc/guix.texi:8342 msgid "" "Or maybe you'll want to ``translate'' command-line arguments into a " "manifest. In that case, @command{guix shell} can help (@pxref{shell-export-" "manifest, @command{guix shell --export-manifest}}):" msgstr "" #. type: example #: doc/guix.texi:8346 #, no-wrap msgid "" "# Write a manifest for the packages specified on the command line.\n" "guix shell --export-manifest gcc-toolchain make git > manifest.scm\n" msgstr "" #. type: Plain text #: doc/guix.texi:8352 msgid "" "In both cases, the @option{--export-manifest} option tries hard to generate " "a faithful manifest; in particular, it takes package transformation options " "into account (@pxref{Package Transformation Options})." msgstr "" #. type: quotation #: doc/guix.texi:8358 msgid "" "Manifests are @emph{symbolic}: they refer to packages of the channels " "@emph{currently in use} (@pxref{Channels}). In the example above, @code{gcc-" "toolchain} might refer to version 11 today, but it might refer to version 13 " "two years from now." msgstr "" #. type: quotation #: doc/guix.texi:8363 msgid "" "If you want to ``pin'' your software environment to specific package " "versions and variants, you need an additional piece of information: the list " "of channel revisions in use, as returned by @command{guix describe}. " "@xref{Replicating Guix}, for more information." msgstr "" #. type: Plain text #: doc/guix.texi:8368 msgid "" "Once you've obtained your first manifest, perhaps you'll want to customize " "it. Since your manifest is code, you now have access to all the Guix " "programming interfaces!" msgstr "" #. type: Plain text #: doc/guix.texi:8374 msgid "" "Let's assume you want a manifest to deploy a custom variant of GDB, the GNU " "Debugger, that does not depend on Guile, together with another package. " "Building on the example seen in the previous section (@pxref{Defining " "Package Variants}), you can write a manifest along these lines:" msgstr "" #. type: lisp #: doc/guix.texi:8379 #, no-wrap msgid "" "(use-modules (guix packages)\n" " (gnu packages gdb) ;for 'gdb'\n" " (gnu packages version-control)) ;for 'git'\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:8386 #, no-wrap msgid "" ";; Define a variant of GDB without a dependency on Guile.\n" "(define gdb-sans-guile\n" " (package\n" " (inherit gdb)\n" " (inputs (modify-inputs (package-inputs gdb)\n" " (delete \"guile\")))))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:8389 #, no-wrap msgid "" ";; Return a manifest containing that one package plus Git.\n" "(packages->manifest (list gdb-sans-guile git))\n" msgstr "" #. type: Plain text #: doc/guix.texi:8400 msgid "" "Note that in this example, the manifest directly refers to the @code{gdb} " "and @code{git} variables, which are bound to a @code{package} object " "(@pxref{package Reference}), instead of calling @code{specifications-" ">manifest} to look up packages by name as we did before. The @code{use-" "modules} form at the top lets us access the core package interface " "(@pxref{Defining Packages}) and the modules that define @code{gdb} and " "@code{git} (@pxref{Package Modules}). Seamlessly, we're weaving all this " "together---the possibilities are endless, unleash your creativity!" msgstr "" #. type: Plain text #: doc/guix.texi:8404 msgid "" "The data type for manifests as well as supporting procedures are defined in " "the @code{(guix profiles)} module, which is automatically available to code " "passed to @option{-m}. The reference follows." msgstr "" #. type: deftp #: doc/guix.texi:8405 #, no-wrap msgid "{Data Type} manifest" msgstr "" #. type: deftp #: doc/guix.texi:8407 msgid "Data type representing a manifest." msgstr "" #. type: deftp #: doc/guix.texi:8409 msgid "It currently has one field:" msgstr "" #. type: item #: doc/guix.texi:8411 #, no-wrap msgid "entries" msgstr "" #. type: table #: doc/guix.texi:8413 msgid "This must be a list of @code{manifest-entry} records---see below." msgstr "" #. type: deftp #: doc/guix.texi:8416 #, no-wrap msgid "{Data Type} manifest-entry" msgstr "" #. type: deftp #: doc/guix.texi:8422 msgid "" "Data type representing a manifest entry. A manifest entry contains " "essential metadata: a name and version string, the object (usually a " "package) for that entry, the desired output (@pxref{Packages with Multiple " "Outputs}), and a number of optional pieces of information detailed below." msgstr "" #. type: deftp #: doc/guix.texi:8427 msgid "" "Most of the time, you won't build a manifest entry directly; instead, you " "will pass a package to @code{package->manifest-entry}, described below. In " "some unusual cases though, you might want to create manifest entries for " "things that are @emph{not} packages, as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:8440 #, no-wrap msgid "" ";; Manually build a single manifest entry for a non-package object.\n" "(let ((hello (program-file \"hello\" #~(display \"Hi!\"))))\n" " (manifest-entry\n" " (name \"foo\")\n" " (version \"42\")\n" " (item\n" " (computed-file \"hello-directory\"\n" " #~(let ((bin (string-append #$output \"/bin\")))\n" " (mkdir #$output) (mkdir bin)\n" " (symlink #$hello\n" " (string-append bin \"/hello\")))))))\n" msgstr "" #. type: deftp #: doc/guix.texi:8443 msgid "The available fields are the following:" msgstr "" #. type: table #: doc/guix.texi:8448 msgid "Name and version string for this entry." msgstr "" #. type: code{#1} #: doc/guix.texi:8449 #, no-wrap msgid "item" msgstr "" #. type: table #: doc/guix.texi:8452 msgid "" "A package or other file-like object (@pxref{G-Expressions, file-like " "objects})." msgstr "" #. type: item #: doc/guix.texi:8453 #, no-wrap msgid "@code{output} (default: @code{\"out\"})" msgstr "" #. type: table #: doc/guix.texi:8456 msgid "" "Output of @code{item} to use, in case @code{item} has multiple outputs " "(@pxref{Packages with Multiple Outputs})." msgstr "" #. type: item #: doc/guix.texi:8457 doc/guix.texi:16693 doc/guix.texi:17089 #, no-wrap msgid "@code{dependencies} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:8460 msgid "" "List of manifest entries this entry depends on. When building a profile, " "dependencies are added to the profile." msgstr "" #. type: table #: doc/guix.texi:8464 msgid "" "Typically, the propagated inputs of a package (@pxref{package Reference, " "@code{propagated-inputs}}) end up having a corresponding manifest entry in " "among the dependencies of the package's own manifest entry." msgstr "" #. type: table #: doc/guix.texi:8468 msgid "" "The list of search path specifications honored by this entry (@pxref{Search " "Paths})." msgstr "" #. type: item #: doc/guix.texi:8469 #, no-wrap msgid "@code{properties} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:8472 msgid "" "List of symbol/value pairs. When building a profile, those properties get " "serialized." msgstr "" #. type: table #: doc/guix.texi:8476 msgid "" "This can be used to piggyback additional metadata---e.g., the " "transformations applied to a package (@pxref{Package Transformation " "Options})." msgstr "" #. type: item #: doc/guix.texi:8477 #, no-wrap msgid "@code{parent} (default: @code{(delay #f)})" msgstr "" #. type: table #: doc/guix.texi:8479 msgid "A promise pointing to the ``parent'' manifest entry." msgstr "" #. type: table #: doc/guix.texi:8482 msgid "" "This is used as a hint to provide context when reporting an error related to " "a manifest entry coming from a @code{dependencies} field." msgstr "" #. type: deffn #: doc/guix.texi:8485 #, no-wrap msgid "{Scheme Procedure} concatenate-manifests @var{lst}" msgstr "" #. type: deffn #: doc/guix.texi:8488 msgid "" "Concatenate the manifests listed in @var{lst} and return the resulting " "manifest." msgstr "" #. type: deffn #: doc/guix.texi:8492 #, no-wrap msgid "{Scheme Procedure} package->manifest-entry @var{package} @" msgstr "" #. type: deffn #: doc/guix.texi:8501 msgid "" "[@var{output}] [#:properties] Return a manifest entry for the @var{output} " "of package @var{package}, where @var{output} defaults to @code{\"out\"}, and " "with the given @var{properties}. By default @var{properties} is the empty " "list or, if one or more package transformations were applied to " "@var{package}, it is an association list representing those transformations, " "suitable as an argument to @code{options->transformation} (@pxref{Defining " "Package Variants, @code{options->transformation}})." msgstr "" #. type: deffn #: doc/guix.texi:8504 msgid "" "The code snippet below builds a manifest with an entry for the default " "output and the @code{send-email} output of the @code{git} package:" msgstr "" #. type: lisp #: doc/guix.texi:8507 doc/guix.texi:8524 #, no-wrap msgid "" "(use-modules (gnu packages version-control))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:8510 #, no-wrap msgid "" "(manifest (list (package->manifest-entry git)\n" " (package->manifest-entry git \"send-email\")))\n" msgstr "" #. type: deffn #: doc/guix.texi:8513 #, no-wrap msgid "{Scheme Procedure} packages->manifest @var{packages}" msgstr "" #. type: deffn #: doc/guix.texi:8518 msgid "" "Return a list of manifest entries, one for each item listed in " "@var{packages}. Elements of @var{packages} can be either package objects or " "package/string tuples denoting a specific output of a package." msgstr "" #. type: deffn #: doc/guix.texi:8521 msgid "" "Using this procedure, the manifest above may be rewritten more concisely:" msgstr "" #. type: lisp #: doc/guix.texi:8526 #, no-wrap msgid "(packages->manifest (list git `(,git \"send-email\")))\n" msgstr "" #. type: anchor{#1} #: doc/guix.texi:8530 msgid "package-development-manifest" msgstr "" #. type: deffn #: doc/guix.texi:8530 #, no-wrap msgid "{Scheme Procedure} package->development-manifest @var{package} @" msgstr "" #. type: deffn #: doc/guix.texi:8536 msgid "" "[@var{system}] [#:target] Return a manifest for the @dfn{development inputs} " "of @var{package} for @var{system}, optionally when cross-compiling to " "@var{target}. Development inputs include both explicit and implicit inputs " "of @var{package}." msgstr "" #. type: deffn #: doc/guix.texi:8544 msgid "" "Like the @option{-D} option of @command{guix shell} (@pxref{shell-" "development-option, @command{guix shell -D}}), the resulting manifest " "describes the environment in which one can develop @var{package}. For " "example, suppose you're willing to set up a development environment for " "Inkscape, with the addition of Git for version control; you can describe " "that ``bill of materials'' with the following manifest:" msgstr "" #. type: lisp #: doc/guix.texi:8548 #, no-wrap msgid "" "(use-modules (gnu packages inkscape) ;for 'inkscape'\n" " (gnu packages version-control)) ;for 'git'\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:8552 #, no-wrap msgid "" "(concatenate-manifests\n" " (list (package->development-manifest inkscape)\n" " (packages->manifest (list git))))\n" msgstr "" #. type: deffn #: doc/guix.texi:8559 msgid "" "In this example, the development manifest that @code{package->development-" "manifest} returns includes the compiler (GCC), the many supporting libraries " "(Boost, GLib, GTK, etc.), and a couple of additional development tools---" "these are the dependencies @command{guix show inkscape} lists." msgstr "" #. type: Plain text #: doc/guix.texi:8566 msgid "" "Last, the @code{(gnu packages)} module provides higher-level facilities to " "build manifests. In particular, it lets you look up packages by name---see " "below." msgstr "" #. type: deffn #: doc/guix.texi:8567 #, no-wrap msgid "{Scheme Procedure} specifications->manifest @var{specs}" msgstr "" #. type: deffn #: doc/guix.texi:8572 msgid "" "Given @var{specs}, a list of specifications such as @code{\"emacs@@25.2\"} " "or @code{\"guile:debug\"}, return a manifest. Specs have the format that " "command-line tools such as @command{guix install} and @command{guix package} " "understand (@pxref{Invoking guix package})." msgstr "" #. type: deffn #: doc/guix.texi:8575 msgid "" "As an example, it lets you rewrite the Git manifest that we saw earlier like " "this:" msgstr "" #. type: lisp #: doc/guix.texi:8578 #, no-wrap msgid "(specifications->manifest '(\"git\" \"git:send-email\"))\n" msgstr "" #. type: deffn #: doc/guix.texi:8584 msgid "" "Notice that we do not need to worry about @code{use-modules}, importing the " "right set of modules, and referring to the right variables. Instead, we " "directly refer to packages in the same way as on the command line, which can " "often be more convenient." msgstr "" #. type: cindex #: doc/guix.texi:8592 #, no-wrap msgid "build system" msgstr "" #. type: Plain text #: doc/guix.texi:8597 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:8601 msgid "" "Build systems are @code{} 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:8602 #, no-wrap msgid "bag (low-level package representation)" msgstr "" #. type: Plain text #: doc/guix.texi:8612 msgid "" "Under the hood, build systems first compile package objects to @dfn{bags}. " "A @dfn{bag} is like a package, but with less ornamentation---in other words, " "a bag is a lower-level representation of a package, which includes all the " "inputs of that package, including some that were implicitly added by the " "build system. This intermediate representation is then compiled to a " "derivation (@pxref{Derivations}). The @code{package-with-c-toolchain} is an " "example of a way to change the implicit inputs that a package's build system " "pulls in (@pxref{package Reference, @code{package-with-c-toolchain}})." msgstr "" #. type: Plain text #: doc/guix.texi:8620 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:8624 msgid "" "The main build system is @code{gnu-build-system}, which implements the " "standard build procedure for GNU and many other packages. It is provided by " "the @code{(guix build-system gnu)} module." msgstr "" #. type: defvr #: doc/guix.texi:8625 #, no-wrap msgid "{Scheme Variable} gnu-build-system" msgstr "" #. type: defvr #: doc/guix.texi:8629 msgid "" "@code{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:8630 doc/guix.texi:9700 doc/guix.texi:10287 #, no-wrap msgid "build phases" msgstr "" #. type: defvr #: doc/guix.texi:8637 msgid "" "In a nutshell, packages using it are configured, built, and installed with " "the usual @code{./configure && make && make check && make install} command " "sequence. In practice, a few additional steps are often needed. All these " "steps are split up in separate @dfn{phases}. @xref{Build Phases}, for more " "info on build phases and ways to customize them." msgstr "" #. type: defvr #: doc/guix.texi:8644 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: defvr #: doc/guix.texi:8648 msgid "" "This build system supports a number of keyword arguments, which can be " "passed @i{via} the @code{arguments} field of a package. Here are some of " "the main parameters:" msgstr "" #. type: item #: doc/guix.texi:8650 #, no-wrap msgid "#:phases" msgstr "" #. type: table #: doc/guix.texi:8653 msgid "" "This argument specifies build-side code that evaluates to an alist of build " "phases. @xref{Build Phases}, for more information." msgstr "" #. type: item #: doc/guix.texi:8654 #, no-wrap msgid "#:configure-flags" msgstr "" #. type: table #: doc/guix.texi:8657 msgid "" "This is a list of flags (strings) passed to the @command{configure} script. " "@xref{Defining Packages}, for an example." msgstr "" #. type: item #: doc/guix.texi:8658 #, no-wrap msgid "#:make-flags" msgstr "" #. type: table #: doc/guix.texi:8662 msgid "" "This list of strings contains flags passed as arguments to @command{make} " "invocations in the @code{build}, @code{check}, and @code{install} phases." msgstr "" #. type: item #: doc/guix.texi:8663 #, no-wrap msgid "#:out-of-source?" msgstr "" #. type: table #: doc/guix.texi:8666 msgid "" "This Boolean, @code{#f} by default, indicates whether to run builds in a " "build directory separate from the source tree." msgstr "" #. type: table #: doc/guix.texi:8671 msgid "" "When it is true, the @code{configure} phase creates a separate build " "directory, changes to that directory, and runs the @code{configure} script " "from there. This is useful for packages that require it, such as " "@code{glibc}." msgstr "" #. type: item #: doc/guix.texi:8672 #, no-wrap msgid "#:tests?" msgstr "" #. type: table #: doc/guix.texi:8675 msgid "" "This Boolean, @code{#t} by default, indicates whether the @code{check} phase " "should run the package's test suite." msgstr "" #. type: item #: doc/guix.texi:8676 #, no-wrap msgid "#:test-target" msgstr "" #. type: table #: doc/guix.texi:8679 msgid "" "This string, @code{\"check\"} by default, gives the name of the makefile " "target used by the @code{check} phase." msgstr "" #. type: item #: doc/guix.texi:8680 #, no-wrap msgid "#:parallel-build?" msgstr "" #. type: itemx #: doc/guix.texi:8681 #, no-wrap msgid "#:parallel-tests?" msgstr "" #. type: table #: doc/guix.texi:8688 msgid "" "These Boolean values specify whether to build, respectively run the test " "suite, in parallel, with the @code{-j} flag of @command{make}. When they " "are true, @code{make} is passed @code{-j@var{n}}, where @var{n} is the " "number specified as the @option{--cores} option of @command{guix-daemon} or " "that of the @command{guix} client command (@pxref{Common Build Options, " "@option{--cores}})." msgstr "" #. type: cindex #: doc/guix.texi:8689 doc/guix.texi:9818 #, no-wrap msgid "RUNPATH, validation" msgstr "" #. type: item #: doc/guix.texi:8690 #, no-wrap msgid "#:validate-runpath?" msgstr "" #. type: table #: doc/guix.texi:8696 msgid "" "This Boolean, @code{#t} by default, determines whether to ``validate'' the " "@code{RUNPATH} of ELF binaries (@code{.so} shared libraries as well as " "executables) previously installed by the @code{install} phase. @xref{phase-" "validate-runpath, the @code{validate-runpath} phase}, for details." msgstr "" #. type: item #: doc/guix.texi:8697 #, no-wrap msgid "#:substitutable?" msgstr "" #. type: table #: doc/guix.texi:8701 msgid "" "This Boolean, @code{#t} by default, tells whether the package outputs should " "be substitutable---i.e., whether users should be able to obtain substitutes " "for them instead of building locally (@pxref{Substitutes})." msgstr "" #. type: item #: doc/guix.texi:8702 #, no-wrap msgid "#:allowed-references" msgstr "" #. type: itemx #: doc/guix.texi:8703 #, no-wrap msgid "#:disallowed-references" msgstr "" #. type: table #: doc/guix.texi:8708 msgid "" "When true, these arguments must be a list of dependencies that must not " "appear among the references of the build results. If, upon build " "completion, some of these references are retained, the build process fails." msgstr "" #. type: table #: doc/guix.texi:8713 msgid "" "This is useful to ensure that a package does not erroneously keep a " "reference to some of it build-time inputs, in cases where doing so would, " "for example, unnecessarily increase its size (@pxref{Invoking guix size})." msgstr "" #. type: defvr #: doc/guix.texi:8716 msgid "Most other build systems support these keyword arguments." msgstr "" #. type: Plain text #: doc/guix.texi:8723 msgid "" "Other @code{} objects are defined to support other conventions " "and tools used by free software packages. They inherit most of @code{gnu-" "build-system}, and differ mainly in the set of inputs implicitly added to " "the build process, and in the list of phases executed. Some of these build " "systems are listed below." msgstr "" #. type: defvr #: doc/guix.texi:8724 #, no-wrap msgid "{Scheme Variable} ant-build-system" msgstr "" #. type: defvr #: doc/guix.texi:8728 msgid "" "This variable is exported by @code{(guix build-system ant)}. It implements " "the build procedure for Java packages that can be built with @url{https://" "ant.apache.org/, Ant build tool}." msgstr "" #. type: defvr #: doc/guix.texi:8733 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:8739 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:8747 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:8751 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:8754 #, no-wrap msgid "{Scheme Variable} android-ndk-build-system" msgstr "" #. type: cindex #: doc/guix.texi:8755 #, no-wrap msgid "Android distribution" msgstr "" #. type: cindex #: doc/guix.texi:8756 #, no-wrap msgid "Android NDK build system" msgstr "" #. type: defvr #: doc/guix.texi:8760 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:8764 msgid "" "The build system assumes that packages install their public interface " "(header) files to the subdirectory @file{include} of the @code{out} output " "and their libraries to the subdirectory @file{lib} the @code{out} output." msgstr "" #. type: defvr #: doc/guix.texi:8767 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:8770 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:8773 #, no-wrap msgid "{Scheme Variable} asdf-build-system/source" msgstr "" #. type: defvrx #: doc/guix.texi:8774 #, no-wrap msgid "{Scheme Variable} asdf-build-system/sbcl" msgstr "" #. type: defvrx #: doc/guix.texi:8775 #, no-wrap msgid "{Scheme Variable} asdf-build-system/ecl" msgstr "" #. type: defvr #: doc/guix.texi:8781 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:8788 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:8792 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:8796 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:8804 msgid "" "In order to create executable programs and images, the build-side procedures " "@code{build-program} and @code{build-image} can be used. They should be " "called in a build phase after the @code{create-asdf-configuration} phase, so " "that the system which was just built can be used within the resulting " "image. @code{build-program} requires a list of Common Lisp expressions to " "be passed as the @code{#:entry-program} argument." msgstr "" #. type: defvr #: doc/guix.texi:8813 msgid "" "By default, all the @file{.asd} files present in the sources are read to " "find system definitions. The @code{#:asd-files} parameter can be used to " "specify the list of @file{.asd} files to read. Furthermore, if the package " "defines a system for its tests in a separate file, it will be loaded before " "the tests are run if it is specified by the @code{#:test-asd-file} " "parameter. If it is not set, the files @code{-tests.asd}, " "@code{-test.asd}, @code{tests.asd}, and @code{test.asd} will be " "tried if they exist." msgstr "" #. type: defvr #: doc/guix.texi:8818 msgid "" "If for some reason the package must be named in a different way than the " "naming conventions suggest, or if several systems must be compiled, the " "@code{#:asd-systems} parameter can be used to specify the list of system " "names." msgstr "" #. type: defvr #: doc/guix.texi:8821 #, no-wrap msgid "{Scheme Variable} cargo-build-system" msgstr "" #. type: cindex #: doc/guix.texi:8822 #, no-wrap msgid "Rust programming language" msgstr "" #. type: cindex #: doc/guix.texi:8823 #, no-wrap msgid "Cargo (Rust build system)" msgstr "" #. type: defvr #: doc/guix.texi:8827 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:8830 msgid "" "It adds @code{rustc} and @code{cargo} to the set of inputs. A different " "Rust package can be specified with the @code{#:rust} parameter." msgstr "" #. type: defvr #: doc/guix.texi:8840 msgid "" "Regular cargo dependencies should be added to the package definition " "similarly to other packages; those needed only at build time to native-" "inputs, others to inputs. If you need to add source-only crates then you " "should add them to via the @code{#:cargo-inputs} parameter as a list of name " "and spec pairs, where the spec can be a package or a source definition. " "Note that the spec must evaluate to a path to a gzipped tarball which " "includes a @code{Cargo.toml} file at its root, or it will be ignored. " "Similarly, cargo dev-dependencies should be added to the package definition " "via the @code{#:cargo-development-inputs} parameter." msgstr "" #. type: defvr #: doc/guix.texi:8850 msgid "" "In its @code{configure} phase, this build system will make any source inputs " "specified in the @code{#:cargo-inputs} and @code{#:cargo-development-inputs} " "parameters available to cargo. It will also remove an included @code{Cargo." "lock} file to be recreated by @code{cargo} during the @code{build} phase. " "The @code{package} phase will run @code{cargo package} to create a source " "crate for future use. The @code{install} phase installs the binaries " "defined by the crate. Unless @code{install-source? #f} is defined it will " "also install a source crate repository of itself and unpacked sources, to " "ease in future hacking on rust packages." msgstr "" #. type: defvr #: doc/guix.texi:8852 #, no-wrap msgid "{Scheme Variable} chicken-build-system" msgstr "" #. type: defvr #: doc/guix.texi:8857 msgid "" "This variable is exported by @code{(guix build-system chicken)}. It builds " "@uref{https://call-cc.org/, CHICKEN Scheme} modules, also called ``eggs'' or " "``extensions''. CHICKEN generates C source code, which then gets compiled " "by a C compiler, in this case GCC." msgstr "" #. type: defvr #: doc/guix.texi:8860 msgid "" "This build system adds @code{chicken} to the package inputs, as well as the " "packages of @code{gnu-build-system}." msgstr "" #. type: defvr #: doc/guix.texi:8864 msgid "" "The build system can't (yet) deduce the egg's name automatically, so just " "like with @code{go-build-system} and its @code{#:import-path}, you should " "define @code{#:egg-name} in the package's @code{arguments} field." msgstr "" #. type: defvr #: doc/guix.texi:8866 msgid "For example, if you are packaging the @code{srfi-1} egg:" msgstr "" #. type: lisp #: doc/guix.texi:8869 #, no-wrap msgid "(arguments '(#:egg-name \"srfi-1\"))\n" msgstr "" #. type: defvr #: doc/guix.texi:8874 msgid "" "Egg dependencies must be defined in @code{propagated-inputs}, not " "@code{inputs} because CHICKEN doesn't embed absolute references in compiled " "eggs. Test dependencies should go to @code{native-inputs}, as usual." msgstr "" #. type: defvr #: doc/guix.texi:8876 #, no-wrap msgid "{Scheme Variable} copy-build-system" msgstr "" #. type: defvr #: doc/guix.texi:8880 msgid "" "This variable is exported by @code{(guix build-system copy)}. It supports " "builds of simple packages that don't require much compiling, mostly just " "moving files around." msgstr "" #. type: defvr #: doc/guix.texi:8885 msgid "" "It adds much of the @code{gnu-build-system} packages to the set of inputs. " "Because of this, the @code{copy-build-system} does not require all the " "boilerplate code often needed for the @code{trivial-build-system}." msgstr "" #. type: defvr #: doc/guix.texi:8890 msgid "" "To further simplify the file installation process, an @code{#:install-plan} " "argument is exposed to let the packager specify which files go where. The " "install plan is a list of @code{(@var{source} @var{target} " "[@var{filters}])}. @var{filters} are optional." msgstr "" #. type: item #: doc/guix.texi:8892 #, no-wrap msgid "When @var{source} matches a file or directory without trailing slash, install it to @var{target}." msgstr "" #. type: item #: doc/guix.texi:8894 #, no-wrap msgid "If @var{target} has a trailing slash, install @var{source} basename beneath @var{target}." msgstr "" #. type: item #: doc/guix.texi:8895 #, no-wrap msgid "Otherwise install @var{source} as @var{target}." msgstr "" #. type: item #: doc/guix.texi:8898 #, no-wrap msgid "When @var{source} is a directory with a trailing slash, or when @var{filters} are used," msgstr "" #. type: itemize #: doc/guix.texi:8901 msgid "" "the trailing slash of @var{target} is implied with the same meaning as above." msgstr "" #. type: item #: doc/guix.texi:8902 #, no-wrap msgid "Without @var{filters}, install the full @var{source} @emph{content} to @var{target}." msgstr "" #. type: item #: doc/guix.texi:8903 #, no-wrap msgid "With @var{filters} among @code{#:include}, @code{#:include-regexp}, @code{#:exclude}," msgstr "" #. type: itemize #: doc/guix.texi:8906 msgid "" "@code{#:exclude-regexp}, only select files are installed depending on the " "filters. Each filters is specified by a list of strings." msgstr "" #. type: item #: doc/guix.texi:8907 #, no-wrap msgid "With @code{#:include}, install all the files which the path suffix matches" msgstr "" #. type: itemize #: doc/guix.texi:8909 msgid "at least one of the elements in the given list." msgstr "" #. type: item #: doc/guix.texi:8909 #, no-wrap msgid "With @code{#:include-regexp}, install all the files which the" msgstr "" #. type: itemize #: doc/guix.texi:8912 msgid "" "subpaths match at least one of the regular expressions in the given list." msgstr "" #. type: item #: doc/guix.texi:8912 #, no-wrap msgid "The @code{#:exclude} and @code{#:exclude-regexp} filters" msgstr "" #. type: itemize #: doc/guix.texi:8917 msgid "" "are the complement of their inclusion counterpart. Without @code{#:include} " "flags, install all files but those matching the exclusion filters. If both " "inclusions and exclusions are specified, the exclusions are done on top of " "the inclusions." msgstr "" #. type: itemize #: doc/guix.texi:8921 msgid "" "In all cases, the paths relative to @var{source} are preserved within " "@var{target}." msgstr "" #. type: defvr #: doc/guix.texi:8924 msgid "Examples:" msgstr "" #. type: item #: doc/guix.texi:8926 #, no-wrap msgid "@code{(\"foo/bar\" \"share/my-app/\")}: Install @file{bar} to @file{share/my-app/bar}." msgstr "" #. type: item #: doc/guix.texi:8927 #, no-wrap msgid "@code{(\"foo/bar\" \"share/my-app/baz\")}: Install @file{bar} to @file{share/my-app/baz}." msgstr "" #. type: item #: doc/guix.texi:8928 #, no-wrap msgid "@code{(\"foo/\" \"share/my-app\")}: Install the content of @file{foo} inside @file{share/my-app}," msgstr "" #. type: itemize #: doc/guix.texi:8930 msgid "e.g., install @file{foo/sub/file} to @file{share/my-app/sub/file}." msgstr "" #. type: item #: doc/guix.texi:8930 #, no-wrap msgid "@code{(\"foo/\" \"share/my-app\" #:include (\"sub/file\"))}: Install only @file{foo/sub/file} to" msgstr "" #. type: itemize #: doc/guix.texi:8932 msgid "@file{share/my-app/sub/file}." msgstr "" #. type: item #: doc/guix.texi:8932 #, no-wrap msgid "@code{(\"foo/sub\" \"share/my-app\" #:include (\"file\"))}: Install @file{foo/sub/file} to" msgstr "" #. type: itemize #: doc/guix.texi:8934 msgid "@file{share/my-app/file}." msgstr "" #. type: cindex #: doc/guix.texi:8938 #, no-wrap msgid "Clojure (programming language)" msgstr "" #. type: cindex #: doc/guix.texi:8939 #, no-wrap msgid "simple Clojure build system" msgstr "" #. type: defvr #: doc/guix.texi:8940 #, no-wrap msgid "{Scheme Variable} clojure-build-system" msgstr "" #. type: defvr #: doc/guix.texi:8945 msgid "" "This variable is exported by @code{(guix build-system clojure)}. It " "implements a simple build procedure for @uref{https://clojure.org/, Clojure} " "packages using plain old @code{compile} in Clojure. Cross-compilation is " "not supported yet." msgstr "" #. type: defvr #: doc/guix.texi:8949 msgid "" "It adds @code{clojure}, @code{icedtea} and @code{zip} to the set of inputs. " "Different packages can be specified with the @code{#:clojure}, @code{#:jdk} " "and @code{#:zip} parameters, respectively." msgstr "" #. type: defvr #: doc/guix.texi:8955 msgid "" "A list of source directories, test directories and jar names can be " "specified with the @code{#:source-dirs}, @code{#:test-dirs} and @code{#:jar-" "names} parameters, respectively. Compile directory and main class can be " "specified with the @code{#:compile-dir} and @code{#:main-class} parameters, " "respectively. Other parameters are documented below." msgstr "" #. type: defvr #: doc/guix.texi:8958 msgid "" "This build system is an extension of @code{ant-build-system}, but with the " "following phases changed:" msgstr "" #. type: item #: doc/guix.texi:8961 doc/guix.texi:9510 doc/guix.texi:9661 doc/guix.texi:9710 #: doc/guix.texi:9796 doc/guix.texi:38527 doc/guix.texi:41818 #, no-wrap msgid "build" msgstr "" #. type: table #: doc/guix.texi:8970 msgid "" "This phase calls @code{compile} in Clojure to compile source files and runs " "@command{jar} to create jars from both source files and compiled files " "according to the include list and exclude list specified in @code{#:aot-" "include} and @code{#:aot-exclude}, respectively. The exclude list has " "priority over the include list. These lists consist of symbols representing " "Clojure libraries or the special keyword @code{#:all} representing all " "Clojure libraries found under the source directories. The parameter @code{#:" "omit-source?} decides if source should be included into the jars." msgstr "" #. type: item #: doc/guix.texi:8971 doc/guix.texi:9514 doc/guix.texi:9665 doc/guix.texi:9801 #, no-wrap msgid "check" msgstr "" #. type: table #: doc/guix.texi:8978 msgid "" "This phase runs tests according to the include list and exclude list " "specified in @code{#:test-include} and @code{#:test-exclude}, respectively. " "Their meanings are analogous to that of @code{#:aot-include} and @code{#:aot-" "exclude}, except that the special keyword @code{#:all} now stands for all " "Clojure libraries found under the test directories. The parameter @code{#:" "tests?} decides if tests should be run." msgstr "" #. type: item #: doc/guix.texi:8979 doc/guix.texi:9520 doc/guix.texi:9671 doc/guix.texi:9714 #: doc/guix.texi:9807 #, no-wrap msgid "install" msgstr "" #. type: table #: doc/guix.texi:8981 msgid "This phase installs all jars built previously." msgstr "" #. type: defvr #: doc/guix.texi:8984 msgid "" "Apart from the above, this build system also contains an additional phase:" msgstr "" #. type: item #: doc/guix.texi:8987 #, no-wrap msgid "install-doc" msgstr "" #. type: table #: doc/guix.texi:8992 msgid "" "This phase installs all top-level files with base name matching @code{%doc-" "regex}. A different regex can be specified with the @code{#:doc-regex} " "parameter. All files (recursively) inside the documentation directories " "specified in @code{#:doc-dirs} are installed as well." msgstr "" #. type: defvr #: doc/guix.texi:8995 #, no-wrap msgid "{Scheme Variable} cmake-build-system" msgstr "" #. type: defvr #: doc/guix.texi:8999 msgid "" "This variable is exported by @code{(guix build-system cmake)}. It " "implements the build procedure for packages using the @url{https://www.cmake." "org, CMake build tool}." msgstr "" #. type: defvr #: doc/guix.texi:9003 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:9010 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:9012 #, no-wrap msgid "{Scheme Variable} dune-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9019 msgid "" "This variable is exported by @code{(guix build-system dune)}. It supports " "builds of packages using @uref{https://dune.build/, Dune}, a build tool for " "the OCaml programming language. It is implemented as an extension of the " "@code{ocaml-build-system} which is described below. As such, the @code{#:" "ocaml} and @code{#:findlib} parameters can be passed to this build system." msgstr "" #. type: defvr #: doc/guix.texi:9023 msgid "" "It automatically adds the @code{dune} package to the set of inputs. Which " "package is used can be specified with the @code{#:dune} parameter." msgstr "" #. type: defvr #: doc/guix.texi:9027 msgid "" "There is no @code{configure} phase because dune packages typically don't " "need to be configured. The @code{#:build-flags} parameter is taken as a " "list of flags passed to the @code{dune} command during the build." msgstr "" #. type: defvr #: doc/guix.texi:9031 msgid "" "The @code{#:jbuild?} parameter can be passed to use the @code{jbuild} " "command instead of the more recent @code{dune} command while building a " "package. Its default value is @code{#f}." msgstr "" #. type: defvr #: doc/guix.texi:9036 msgid "" "The @code{#:package} parameter can be passed to specify a package name, " "which is useful when a package contains multiple packages and you want to " "build only one of them. This is equivalent to passing the @code{-p} " "argument to @code{dune}." msgstr "" #. type: defvr #: doc/guix.texi:9039 #, no-wrap msgid "{Scheme variable} elm-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9043 msgid "" "This variable is exported by @code{(guix build-system elm)}. It implements " "a build procedure for @url{https://elm-lang.org, Elm} packages similar to " "@samp{elm install}." msgstr "" #. type: defvr #: doc/guix.texi:9051 msgid "" "The build system adds an Elm compiler package to the set of inputs. The " "default compiler package (currently @code{elm-sans-reactor}) can be " "overridden using the @code{#:elm} argument. Additionally, Elm packages " "needed by the build system itself are added as implicit inputs if they are " "not already present: to suppress this behavior, use the @code{#:implicit-elm-" "package-inputs?} argument, which is primarily useful for bootstrapping." msgstr "" #. type: defvr #: doc/guix.texi:9055 msgid "" "The @code{\"dependencies\"} and @code{\"test-dependencies\"} in an Elm " "package's @file{elm.json} file correspond to @code{propagated-inputs} and " "@code{inputs}, respectively." msgstr "" #. type: defvr #: doc/guix.texi:9059 msgid "" "Elm requires a particular structure for package names: @pxref{Elm Packages} " "for more details, including utilities provided by @code{(guix build-system " "elm)}." msgstr "" #. type: defvr #: doc/guix.texi:9061 msgid "" "There are currently a few noteworthy limitations to @code{elm-build-system}:" msgstr "" #. type: itemize #: doc/guix.texi:9072 msgid "" "The build system is focused on @dfn{packages} in the Elm sense of the word: " "Elm @dfn{projects} which declare @code{@{ \"type\": \"package\" @}} in their " "@file{elm.json} files. Using @code{elm-build-system} to build Elm " "@dfn{applications} (which declare @code{@{ \"type\": \"application\" @}}) is " "possible, but requires ad-hoc modifications to the build phases. For " "examples, see the definitions of the @code{elm-todomvc} example application " "and the @code{elm} package itself (because the front-end for the @samp{elm " "reactor} command is an Elm application)." msgstr "" #. type: itemize #: doc/guix.texi:9084 msgid "" "Elm supports multiple versions of a package coexisting simultaneously under " "@env{ELM_HOME}, but this does not yet work well with @code{elm-build-" "system}. This limitation primarily affects Elm applications, because they " "specify exact versions for their dependencies, whereas Elm packages specify " "supported version ranges. As a workaround, the example applications " "mentioned above use the @code{patch-application-dependencies} procedure " "provided by @code{(guix build elm-build-system)} to rewrite their @file{elm." "json} files to refer to the package versions actually present in the build " "environment. Alternatively, Guix package transformations (@pxref{Defining " "Package Variants}) could be used to rewrite an application's entire " "dependency graph." msgstr "" #. type: itemize #: doc/guix.texi:9090 msgid "" "We are not yet able to run tests for Elm projects because neither " "@url{https://github.com/mpizenberg/elm-test-rs, @command{elm-test-rs}} nor " "the Node.js-based @url{https://github.com/rtfeldman/node-test-runner, " "@command{elm-test}} runner has been packaged for Guix yet." msgstr "" #. type: defvr #: doc/guix.texi:9093 #, no-wrap msgid "{Scheme Variable} go-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9098 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:9109 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:9114 msgid "" "Packages that provide Go libraries should install their source code into the " "built output. The key @code{#:install-source?}, which defaults to " "@code{#t}, controls whether or not the source code is installed. It can be " "set to @code{#f} for packages that only provide executable files." msgstr "" #. type: defvr #: doc/guix.texi:9121 msgid "" "Packages can be cross-built, and if a specific architecture or operating " "system is desired then the keywords @code{#:goarch} and @code{#:goos} can be " "used to force the package to be built for that architecture and operating " "system. The combinations known to Go can be found @url{\"https://golang.org/" "doc/install/source#environment\", in their documentation}." msgstr "" #. type: defvr #: doc/guix.texi:9123 #, no-wrap msgid "{Scheme Variable} glib-or-gtk-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9126 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:9129 msgid "" "This build system adds the following two phases to the ones defined by " "@code{gnu-build-system}:" msgstr "" #. type: item #: doc/guix.texi:9131 doc/guix.texi:9687 #, no-wrap msgid "glib-or-gtk-wrap" msgstr "" #. type: table #: doc/guix.texi:9138 msgid "" "The phase @code{glib-or-gtk-wrap} ensures that programs in @file{bin/} are " "able to find GLib ``schemas'' and @uref{https://developer.gnome.org/gtk3/" "stable/gtk-running.html, GTK+ modules}. This is achieved by wrapping the " "programs in launch scripts that appropriately set the @env{XDG_DATA_DIRS} " "and @env{GTK_PATH} environment variables." msgstr "" #. type: table #: doc/guix.texi:9145 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:9146 doc/guix.texi:9691 #, no-wrap msgid "glib-or-gtk-compile-schemas" msgstr "" #. type: table #: doc/guix.texi:9154 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:9157 msgid "Both phases are executed after the @code{install} phase." msgstr "" #. type: defvr #: doc/guix.texi:9159 #, no-wrap msgid "{Scheme Variable} guile-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9166 msgid "" "This build system is for Guile packages that consist exclusively of Scheme " "code and that are so lean that they don't even have a makefile, let alone a " "@file{configure} script. It compiles Scheme code using @command{guild " "compile} (@pxref{Compilation,,, guile, GNU Guile Reference Manual}) and " "installs the @file{.scm} and @file{.go} files in the right place. It also " "installs documentation." msgstr "" #. type: defvr #: doc/guix.texi:9169 msgid "" "This build system supports cross-compilation by using the @option{--target} " "option of @samp{guild compile}." msgstr "" #. type: defvr #: doc/guix.texi:9172 msgid "" "Packages built with @code{guile-build-system} must provide a Guile package " "in their @code{native-inputs} field." msgstr "" #. type: defvr #: doc/guix.texi:9174 #, no-wrap msgid "{Scheme Variable} julia-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9181 msgid "" "This variable is exported by @code{(guix build-system julia)}. It " "implements the build procedure used by @uref{https://julialang.org/, julia} " "packages, which essentially is similar to running @samp{julia -e 'using Pkg; " "Pkg.add(package)'} in an environment where @env{JULIA_LOAD_PATH} contains " "the paths to all Julia package inputs. Tests are run by calling @code{/test/" "runtests.jl}." msgstr "" #. type: defvr #: doc/guix.texi:9186 msgid "" "The Julia package name and uuid is read from the file @file{Project.toml}. " "These values can be overridden by passing the argument @code{#:julia-package-" "name} (which must be correctly capitalized) or @code{#:julia-package-uuid}." msgstr "" #. type: defvr #: doc/guix.texi:9190 msgid "" "Julia packages usually manage their binary dependencies via " "@code{JLLWrappers.jl}, a Julia package that creates a module (named after " "the wrapped library followed by @code{_jll.jl}." msgstr "" #. type: defvr #: doc/guix.texi:9195 msgid "" "To add the binary path @code{_jll.jl} packages, you need to patch the files " "under @file{src/wrappers/}, replacing the call to the macro " "@code{JLLWrappers.@@generate_wrapper_header}, adding as a second argument " "containing the store path the binary." msgstr "" #. type: defvr #: doc/guix.texi:9199 msgid "" "As an example, in the MbedTLS Julia package, we add a build phase " "(@pxref{Build Phases}) to insert the absolute file name of the wrapped " "MbedTLS package:" msgstr "" #. type: lisp #: doc/guix.texi:9211 #, no-wrap msgid "" "(add-after 'unpack 'override-binary-path\n" " (lambda* (#:key inputs #:allow-other-keys)\n" " (for-each (lambda (wrapper)\n" " (substitute* wrapper\n" " ((\"generate_wrapper_header.*\")\n" " (string-append\n" " \"generate_wrapper_header(\\\"MbedTLS\\\", \\\"\"\n" " (assoc-ref inputs \"mbedtls-apache\") \"\\\")\\n\"))))\n" " ;; There's a Julia file for each platform, override them all.\n" " (find-files \"src/wrappers/\" \"\\\\.jl$\"))))\n" msgstr "" #. type: defvr #: doc/guix.texi:9217 msgid "" "Some older packages that aren't using @file{Project.toml} yet, will require " "this file to be created, too. It is internally done if the arguments " "@code{#:julia-package-name} and @code{#:julia-package-uuid} are provided." msgstr "" #. type: defvr #: doc/guix.texi:9219 #, no-wrap msgid "{Scheme Variable} maven-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9226 msgid "" "This variable is exported by @code{(guix build-system maven)}. It " "implements a build procedure for @uref{https://maven.apache.org, Maven} " "packages. Maven is a dependency and lifecycle management tool for Java. A " "user of Maven specifies dependencies and plugins in a @file{pom.xml} file " "that Maven reads. When Maven does not have one of the dependencies or " "plugins in its repository, it will download them and use them to build the " "package." msgstr "" #. type: defvr #: doc/guix.texi:9236 msgid "" "The maven build system ensures that maven will not try to download any " "dependency by running in offline mode. Maven will fail if a dependency is " "missing. Before running Maven, the @file{pom.xml} (and subprojects) are " "modified to specify the version of dependencies and plugins that match the " "versions available in the guix build environment. Dependencies and plugins " "must be installed in the fake maven repository at @file{lib/m2}, and are " "symlinked into a proper repository before maven is run. Maven is instructed " "to use that repository for the build and installs built artifacts there. " "Changed files are copied to the @file{lib/m2} directory of the package " "output." msgstr "" #. type: defvr #: doc/guix.texi:9239 msgid "" "You can specify a @file{pom.xml} file with the @code{#:pom-file} argument, " "or let the build system use the default @file{pom.xml} file in the sources." msgstr "" #. type: defvr #: doc/guix.texi:9245 msgid "" "In case you need to specify a dependency's version manually, you can use the " "@code{#:local-packages} argument. It takes an association list where the " "key is the groupId of the package and its value is an association list where " "the key is the artifactId of the package and its value is the version you " "want to override in the @file{pom.xml}." msgstr "" #. type: defvr #: doc/guix.texi:9251 msgid "" "Some packages use dependencies or plugins that are not useful at runtime nor " "at build time in Guix. You can alter the @file{pom.xml} file to remove them " "using the @code{#:exclude} argument. Its value is an association list where " "the key is the groupId of the plugin or dependency you want to remove, and " "the value is a list of artifactId you want to remove." msgstr "" #. type: defvr #: doc/guix.texi:9254 msgid "" "You can override the default @code{jdk} and @code{maven} packages with the " "corresponding argument, @code{#:jdk} and @code{#:maven}." msgstr "" #. type: defvr #: doc/guix.texi:9259 msgid "" "The @code{#:maven-plugins} argument is a list of maven plugins used during " "the build, with the same format as the @code{inputs} fields of the package " "declaration. Its default value is @code{(default-maven-plugins)} which is " "also exported." msgstr "" #. type: defvr #: doc/guix.texi:9261 #, no-wrap msgid "{Scheme Variable} minetest-mod-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9267 msgid "" "This variable is exported by @code{(guix build-system minetest)}. It " "implements a build procedure for @uref{https://www.minetest.net, Minetest} " "mods, which consists of copying Lua code, images and other resources to the " "location Minetest searches for mods. The build system also minimises PNG " "images and verifies that Minetest can load the mod without errors." msgstr "" #. type: defvr #: doc/guix.texi:9269 #, no-wrap msgid "{Scheme Variable} minify-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9272 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:9278 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:9282 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:9284 #, no-wrap msgid "{Scheme Variable} ocaml-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9290 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:9300 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:9305 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:9309 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:9317 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:9325 msgid "" "Note that most OCaml packages assume they will be installed in the same " "directory as OCaml, which is not what we want in guix. In particular, they " "will install @file{.so} files in their module's directory, which is usually " "fine because it is in the OCaml compiler directory. In guix though, these " "libraries cannot be found and we use @env{CAML_LD_LIBRARY_PATH}. This " "variable points to @file{lib/ocaml/site-lib/stubslibs} and this is where " "@file{.so} libraries should be installed." msgstr "" #. type: defvr #: doc/guix.texi:9327 #, no-wrap msgid "{Scheme Variable} python-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9332 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:9337 msgid "" "For packages that install stand-alone Python programs under @code{bin/}, it " "takes care of wrapping these programs so that their @env{GUIX_PYTHONPATH} " "environment variable points to all the Python libraries they depend on." msgstr "" #. type: defvr #: doc/guix.texi:9343 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:9348 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:9354 msgid "" "If a @code{\"python\"} output is available, the package is installed into it " "instead of the default @code{\"out\"} output. This is useful for packages " "that include a Python package as only a part of the software, and thus want " "to combine the phases of @code{python-build-system} with another build " "system. Python bindings are a common usecase." msgstr "" #. type: defvr #: doc/guix.texi:9356 #, no-wrap msgid "{Scheme Variable} pyproject-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9361 msgid "" "This is a variable exported by @code{guix build-system pyproject}. It is " "based on @var{python-build-system}, and adds support for @file{pyproject." "toml} and @url{https://peps.python.org/pep-0517/, PEP 517}. It also " "supports a variety of build backends and test frameworks." msgstr "" #. type: defvr #: doc/guix.texi:9363 msgid "The API is slightly different from @var{python-build-system}:" msgstr "" #. type: itemize #: doc/guix.texi:9366 msgid "@code{#:use-setuptools?} and @code{#:test-target} is removed." msgstr "" #. type: itemize #: doc/guix.texi:9369 msgid "" "@code{#:build-backend} is added. It defaults to @code{#false} and will try " "to guess the appropriate backend based on @file{pyproject.toml}." msgstr "" #. type: itemize #: doc/guix.texi:9372 msgid "" "@code{#:test-backend} is added. It defaults to @code{#false} and will guess " "an appropriate test backend based on what is available in package inputs." msgstr "" #. type: itemize #: doc/guix.texi:9376 msgid "" "@code{#:test-flags} is added. The default is @code{'()}. These flags are " "passed as arguments to the test command. Note that flags for verbose output " "is always enabled on supported backends." msgstr "" #. type: defvr #: doc/guix.texi:9382 msgid "" "It is considered ``experimental'' in that the implementation details are not " "set in stone yet, however users are encouraged to try it for new Python " "projects (even those using @file{setup.py}). The API is subject to change, " "but any breaking changes in the Guix channel will be dealt with." msgstr "" #. type: defvr #: doc/guix.texi:9385 msgid "" "Eventually this build system will be deprecated and merged back into " "@var{python-build-system}, probably some time in 2024." msgstr "" #. type: defvr #: doc/guix.texi:9387 #, no-wrap msgid "{Scheme Variable} perl-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9399 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:9403 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:9405 msgid "Which Perl package is used can be specified with @code{#:perl}." msgstr "" #. type: defvr #: doc/guix.texi:9407 #, no-wrap msgid "{Scheme Variable} renpy-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9411 msgid "" "This variable is exported by @code{(guix build-system renpy)}. It " "implements the more or less standard build procedure used by Ren'py games, " "which consists of loading @code{#:game} once, thereby creating bytecode for " "it." msgstr "" #. type: defvr #: doc/guix.texi:9414 msgid "" "It further creates a wrapper script in @code{bin/} and a desktop entry in " "@code{share/applications}, both of which can be used to launch the game." msgstr "" #. type: defvr #: doc/guix.texi:9418 msgid "" "Which Ren'py package is used can be specified with @code{#:renpy}. Games " "can also be installed in outputs other than ``out'' by using @code{#:output}." msgstr "" #. type: defvr #: doc/guix.texi:9420 #, no-wrap msgid "{Scheme Variable} qt-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9423 msgid "" "This variable is exported by @code{(guix build-system qt)}. It is intended " "for use with applications using Qt or KDE." msgstr "" #. type: defvr #: doc/guix.texi:9426 msgid "" "This build system adds the following two phases to the ones defined by " "@code{cmake-build-system}:" msgstr "" #. type: item #: doc/guix.texi:9428 #, no-wrap msgid "check-setup" msgstr "" #. type: table #: doc/guix.texi:9435 msgid "" "The phase @code{check-setup} prepares the environment for running the checks " "as commonly used by Qt test programs. For now this only sets some " "environment variables: @code{QT_QPA_PLATFORM=offscreen}, " "@code{DBUS_FATAL_WARNINGS=0} and @code{CTEST_OUTPUT_ON_FAILURE=1}." msgstr "" #. type: table #: doc/guix.texi:9438 msgid "" "This phase is added before the @code{check} phase. It's a separate phase to " "ease adjusting if necessary." msgstr "" #. type: item #: doc/guix.texi:9439 #, no-wrap msgid "qt-wrap" msgstr "" #. type: table #: doc/guix.texi:9445 msgid "" "The phase @code{qt-wrap} searches for Qt5 plugin paths, QML paths and some " "XDG in the inputs and output. In case some path is found, all programs in " "the output's @file{bin/}, @file{sbin/}, @file{libexec/} and @file{lib/" "libexec/} directories are wrapped in scripts defining the necessary " "environment variables." msgstr "" #. type: table #: doc/guix.texi:9451 msgid "" "It is possible to exclude specific package outputs from that wrapping " "process by listing their names in the @code{#:qt-wrap-excluded-outputs} " "parameter. This is useful when an output is known not to contain any Qt " "binaries, and where wrapping would gratuitously add a dependency of that " "output on Qt, KDE, or such." msgstr "" #. type: table #: doc/guix.texi:9453 msgid "This phase is added after the @code{install} phase." msgstr "" #. type: defvr #: doc/guix.texi:9456 #, no-wrap msgid "{Scheme Variable} r-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9464 msgid "" "This variable is exported by @code{(guix build-system r)}. It implements " "the build procedure used by @uref{https://r-project.org, R} packages, which " "essentially is little more than running @samp{R CMD INSTALL --library=/gnu/" "store/@dots{}} in an environment where @env{R_LIBS_SITE} contains the paths " "to all R package inputs. Tests are run after installation using the R " "function @code{tools::testInstalledPackage}." msgstr "" #. type: defvr #: doc/guix.texi:9466 #, no-wrap msgid "{Scheme Variable} rakudo-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9474 msgid "" "This variable is exported by @code{(guix build-system rakudo)}. It " "implements the build procedure used by @uref{https://rakudo.org/, Rakudo} " "for @uref{https://perl6.org/, Perl6} packages. It installs the package to " "@code{/gnu/store/@dots{}/NAME-VERSION/share/perl6} and installs the " "binaries, library files and the resources, as well as wrap the files under " "the @code{bin/} directory. Tests can be skipped by passing @code{#f} to the " "@code{tests?} parameter." msgstr "" #. type: defvr #: doc/guix.texi:9482 msgid "" "Which rakudo package is used can be specified with @code{rakudo}. Which " "perl6-tap-harness package used for the tests can be specified with @code{#:" "prove6} or removed by passing @code{#f} to the @code{with-prove6?} " "parameter. Which perl6-zef package used for tests and installing can be " "specified with @code{#:zef} or removed by passing @code{#f} to the " "@code{with-zef?} parameter." msgstr "" #. type: defvr #: doc/guix.texi:9484 #, no-wrap msgid "{Scheme Variable} rebar-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9488 msgid "" "This variable is exported by @code{(guix build-system rebar)}. It " "implements a build procedure around @uref{https://rebar3.org,rebar3}, a " "build system for programs written in the Erlang language." msgstr "" #. type: defvr #: doc/guix.texi:9492 msgid "" "It adds both @code{rebar3} and the @code{erlang} to the set of inputs. " "Different packages can be specified with the @code{#:rebar} and @code{#:" "erlang} parameters, respectively." msgstr "" #. type: defvr #: doc/guix.texi:9495 msgid "" "This build system is based on @code{gnu-build-system}, but with the " "following phases changed:" msgstr "" #. type: item #: doc/guix.texi:9498 doc/guix.texi:9781 #, no-wrap msgid "unpack" msgstr "" #. type: table #: doc/guix.texi:9504 msgid "" "This phase, after unpacking the source like the @code{gnu-build-system} " "does, checks for a file @code{contents.tar.gz} at the top-level of the " "source. If this file exists, it will be unpacked, too. This eases handling " "of package hosted at @uref{https://hex.pm/}, the Erlang and Elixir package " "repository." msgstr "" #. type: item #: doc/guix.texi:9505 #, no-wrap msgid "bootstrap" msgstr "" #. type: item #: doc/guix.texi:9506 doc/guix.texi:9655 doc/guix.texi:9706 doc/guix.texi:9791 #, no-wrap msgid "configure" msgstr "" #. type: table #: doc/guix.texi:9509 msgid "" "There are no @code{bootstrap} and @code{configure} phase because erlang " "packages typically don’t need to be configured." msgstr "" #. type: table #: doc/guix.texi:9513 msgid "" "This phase runs @code{rebar3 compile} with the flags listed in @code{#:rebar-" "flags}." msgstr "" #. type: table #: doc/guix.texi:9519 msgid "" "Unless @code{#:tests? #f} is passed, this phase runs @code{rebar3 eunit}, or " "some other target specified with @code{#:test-target}, with the flags listed " "in @code{#:rebar-flags}," msgstr "" #. type: table #: doc/guix.texi:9523 msgid "" "This installs the files created in the @i{default} profile, or some other " "profile specified with @code{#:install-profile}." msgstr "" #. type: defvr #: doc/guix.texi:9527 #, no-wrap msgid "{Scheme Variable} texlive-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9532 msgid "" "This variable is exported by @code{(guix build-system texlive)}. It is used " "to build TeX packages in batch mode with a specified engine. The build " "system sets the @env{TEXINPUTS} variable to find all TeX source files in the " "inputs." msgstr "" #. type: defvr #: doc/guix.texi:9541 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:9544 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:9546 #, no-wrap msgid "{Scheme Variable} ruby-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9550 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:9558 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:9562 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:9564 #, no-wrap msgid "{Scheme Variable} waf-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9570 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:9574 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:9576 #, no-wrap msgid "{Scheme Variable} scons-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9582 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:9589 msgid "" "Additional flags to be passed to @code{scons} can be specified with the " "@code{#:scons-flags} parameter. The default build and install targets can " "be overridden with @code{#:build-targets} and @code{#:install-targets} " "respectively. The version of Python used to run SCons can be specified by " "selecting the appropriate SCons package with the @code{#:scons} parameter." msgstr "" #. type: defvr #: doc/guix.texi:9591 #, no-wrap msgid "{Scheme Variable} haskell-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9605 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:9608 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:9610 #, no-wrap msgid "{Scheme Variable} dub-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9615 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:9618 msgid "" "Which D compiler is used can be specified with the @code{#:ldc} parameter " "which defaults to @code{ldc}." msgstr "" #. type: anchor{#1} #: doc/guix.texi:9621 msgid "emacs-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9621 #, no-wrap msgid "{Scheme Variable} emacs-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9625 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:9631 msgid "" "It first creates the @code{@code{package}-autoloads.el} file, then it byte " "compiles all Emacs Lisp files. Differently from the Emacs packaging system, " "the Info documentation files are moved to the standard documentation " "directory and the @file{dir} file is deleted. The Elisp package files are " "installed directly under @file{share/emacs/site-lisp}." msgstr "" #. type: defvr #: doc/guix.texi:9633 #, no-wrap msgid "{Scheme Variable} font-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9639 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:9641 #, no-wrap msgid "{Scheme Variable} meson-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9645 msgid "" "This variable is exported by @code{(guix build-system meson)}. It " "implements the build procedure for packages that use @url{https://mesonbuild." "com, Meson} as their build system." msgstr "" #. type: defvr #: doc/guix.texi:9649 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." msgstr "" #. type: defvr #: doc/guix.texi:9652 msgid "" "This build system is an extension of @code{gnu-build-system}, but with the " "following phases changed to some specific for Meson:" msgstr "" #. type: table #: doc/guix.texi:9660 msgid "" "The phase runs @code{meson} with the flags specified in @code{#:configure-" "flags}. The flag @option{--buildtype} is always set to " "@code{debugoptimized} unless something else is specified in @code{#:build-" "type}." msgstr "" #. type: table #: doc/guix.texi:9664 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:9670 msgid "" "The phase runs @samp{meson test} with a base set of options that cannot be " "overridden. This base set of options can be extended via the @code{#:test-" "options} argument, for example to select or skip a specific test suite." msgstr "" #. type: table #: doc/guix.texi:9673 msgid "The phase runs @code{ninja install} and can not be changed." msgstr "" #. type: defvr #: doc/guix.texi:9676 msgid "Apart from that, the build system also adds the following phases:" msgstr "" #. type: item #: doc/guix.texi:9679 #, no-wrap msgid "fix-runpath" msgstr "" #. type: table #: doc/guix.texi:9686 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}, such " "as test dependencies, that aren't actually required for the program to run." msgstr "" #. type: table #: doc/guix.texi:9690 doc/guix.texi:9694 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: defvr #: doc/guix.texi:9697 #, no-wrap msgid "{Scheme Variable} linux-module-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9699 msgid "@code{linux-module-build-system} allows building Linux kernel modules." msgstr "" #. type: defvr #: doc/guix.texi:9703 msgid "" "This build system is an extension of @code{gnu-build-system}, but with the " "following phases changed:" msgstr "" #. type: table #: doc/guix.texi:9709 msgid "" "This phase configures the environment so that the Linux kernel's Makefile " "can be used to build the external kernel module." msgstr "" #. type: table #: doc/guix.texi:9713 msgid "" "This phase uses the Linux kernel's Makefile in order to build the external " "kernel module." msgstr "" #. type: table #: doc/guix.texi:9717 msgid "" "This phase uses the Linux kernel's Makefile in order to install the external " "kernel module." msgstr "" #. type: defvr #: doc/guix.texi:9722 msgid "" "It is possible and useful to specify the Linux kernel to use for building " "the module (in the @code{arguments} form of a package using the @code{linux-" "module-build-system}, use the key @code{#:linux} to specify it)." msgstr "" #. type: defvr #: doc/guix.texi:9724 #, no-wrap msgid "{Scheme Variable} node-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9729 msgid "" "This variable is exported by @code{(guix build-system node)}. It implements " "the build procedure used by @uref{https://nodejs.org, Node.js}, which " "implements an approximation of the @code{npm install} command, followed by " "an @code{npm test} command." msgstr "" #. type: defvr #: doc/guix.texi:9733 msgid "" "Which Node.js package is used to interpret the @code{npm} commands can be " "specified with the @code{#:node} parameter which defaults to @code{node}." msgstr "" #. type: Plain text #: doc/guix.texi:9739 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:9740 #, no-wrap msgid "{Scheme Variable} trivial-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9742 msgid "This variable is exported by @code{(guix build-system trivial)}." msgstr "" #. type: defvr #: doc/guix.texi:9747 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: defvr #: doc/guix.texi:9749 #, no-wrap msgid "{Scheme Variable} channel-build-system" msgstr "" #. type: defvr #: doc/guix.texi:9751 msgid "This variable is exported by @code{(guix build-system channel)}." msgstr "" #. type: defvr #: doc/guix.texi:9757 msgid "" "This build system is meant primarily for internal use. A package using this " "build system must have a channel specification as its @code{source} field " "(@pxref{Channels}); alternatively, its source can be a directory name, in " "which case an additional @code{#:commit} argument must be supplied to " "specify the commit being built (a hexadecimal string)." msgstr "" #. type: defvr #: doc/guix.texi:9760 msgid "" "The resulting package is a Guix instance of the given channel, similar to " "how @command{guix time-machine} would build it." msgstr "" #. type: cindex #: doc/guix.texi:9765 #, no-wrap msgid "build phases, for packages" msgstr "" #. type: Plain text #: doc/guix.texi:9771 msgid "" "Almost all package build systems implement a notion @dfn{build phases}: a " "sequence of actions that the build system executes, when you build the " "package, leading to the installed byproducts in the store. A notable " "exception is the ``bare-bones'' @code{trivial-build-system} (@pxref{Build " "Systems})." msgstr "" #. type: Plain text #: doc/guix.texi:9775 msgid "" "As discussed in the previous section, those build systems provide a standard " "list of phases. For @code{gnu-build-system}, the main build phases are the " "following:" msgstr "" #. type: item #: doc/guix.texi:9777 #, no-wrap msgid "set-paths" msgstr "" #. type: table #: doc/guix.texi:9780 msgid "" "Define search path environment variables for all the input packages, " "including @env{PATH} (@pxref{Search Paths})." msgstr "" #. type: table #: doc/guix.texi:9785 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:9786 #, no-wrap msgid "patch-source-shebangs" msgstr "" #. type: table #: doc/guix.texi:9790 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: table #: doc/guix.texi:9795 msgid "" "Run the @file{configure} script with a number of default options, such as " "@option{--prefix=/gnu/store/@dots{}}, as well as the options specified by " "the @code{#:configure-flags} argument." msgstr "" #. type: table #: doc/guix.texi:9800 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: table #: doc/guix.texi:9806 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: table #: doc/guix.texi:9809 msgid "Run @code{make install} with the flags listed in @code{#:make-flags}." msgstr "" #. type: item #: doc/guix.texi:9810 #, no-wrap msgid "patch-shebangs" msgstr "" #. type: table #: doc/guix.texi:9812 msgid "Patch shebangs on the installed executable files." msgstr "" #. type: item #: doc/guix.texi:9813 #, no-wrap msgid "strip" msgstr "" #. type: table #: doc/guix.texi:9817 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: anchor{#1} #: doc/guix.texi:9820 msgid "phase-validate-runpath" msgstr "" #. type: item #: doc/guix.texi:9820 #, no-wrap msgid "validate-runpath" msgstr "" #. type: table #: doc/guix.texi:9823 msgid "" "Validate the @code{RUNPATH} of ELF binaries, unless @code{#:validate-" "runpath?} is false (@pxref{Build Systems})." msgstr "" #. type: table #: doc/guix.texi:9831 msgid "" "This validation step consists in making sure that all the shared libraries " "needed by an ELF binary, which are listed as @code{DT_NEEDED} entries in its " "@code{PT_DYNAMIC} segment, appear in the @code{DT_RUNPATH} entry of that " "binary. In other words, it ensures that running or using those binaries " "will not result in a ``file not found'' error at run time. @xref{Options, " "@option{-rpath},, ld, The GNU Linker}, for more information on " "@code{RUNPATH}." msgstr "" #. type: Plain text #: doc/guix.texi:9841 msgid "" "Other build systems have similar phases, with some variations. For example, " "@code{cmake-build-system} has same-named phases but its @code{configure} " "phases runs @code{cmake} instead of @code{./configure}. Others, such as " "@code{python-build-system}, have a wholly different list of standard " "phases. All this code runs on the @dfn{build side}: it is evaluated when " "you actually build the package, in a dedicated build process spawned by the " "build daemon (@pxref{Invoking guix-daemon})." msgstr "" #. type: Plain text #: doc/guix.texi:9848 msgid "" "Build phases are represented as association lists or " "``alists'' (@pxref{Association Lists,,, guile, GNU Guile Reference Manual}) " "where each key is a symbol for the name of the phase and the associated " "value is a procedure that accepts an arbitrary number of arguments. By " "convention, those procedures receive information about the build in the form " "of @dfn{keyword parameters}, which they can use or ignore." msgstr "" #. type: vindex #: doc/guix.texi:9849 #, no-wrap msgid "%standard-phases" msgstr "" #. type: Plain text #: doc/guix.texi:9855 msgid "" "For example, here is how @code{(guix build gnu-build-system)} defines " "@code{%standard-phases}, the variable holding its alist of build " "phases@footnote{We present a simplified view of those build phases, but do " "take a look at @code{(guix build gnu-build-system)} to see all the details!}:" msgstr "" #. type: lisp #: doc/guix.texi:9858 #, no-wrap msgid "" ";; The build phases of 'gnu-build-system'.\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:9862 #, no-wrap msgid "" "(define* (unpack #:key source #:allow-other-keys)\n" " ;; Extract the source tarball.\n" " (invoke \"tar\" \"xvf\" source))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:9868 #, no-wrap msgid "" "(define* (configure #:key outputs #:allow-other-keys)\n" " ;; Run the 'configure' script. Install to output \"out\".\n" " (let ((out (assoc-ref outputs \"out\")))\n" " (invoke \"./configure\"\n" " (string-append \"--prefix=\" out))))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:9872 #, no-wrap msgid "" "(define* (build #:allow-other-keys)\n" " ;; Compile.\n" " (invoke \"make\"))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:9879 #, no-wrap msgid "" "(define* (check #:key (test-target \"check\") (tests? #true)\n" " #:allow-other-keys)\n" " ;; Run the test suite.\n" " (if tests?\n" " (invoke \"make\" test-target)\n" " (display \"test suite not run\\n\")))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:9883 #, no-wrap msgid "" "(define* (install #:allow-other-keys)\n" " ;; Install files to the prefix 'configure' specified.\n" " (invoke \"make\" \"install\"))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:9892 #, no-wrap msgid "" "(define %standard-phases\n" " ;; The list of standard phases (quite a few are omitted\n" " ;; for brevity). Each element is a symbol/procedure pair.\n" " (list (cons 'unpack unpack)\n" " (cons 'configure configure)\n" " (cons 'build build)\n" " (cons 'check check)\n" " (cons 'install install)))\n" msgstr "" #. type: Plain text #: doc/guix.texi:9902 msgid "" "This shows how @code{%standard-phases} is defined as a list of symbol/" "procedure pairs (@pxref{Pairs,,, guile, GNU Guile Reference Manual}). The " "first pair associates the @code{unpack} procedure with the @code{unpack} " "symbol---a name; the second pair defines the @code{configure} phase " "similarly, and so on. When building a package that uses @code{gnu-build-" "system} with its default list of phases, those phases are executed " "sequentially. You can see the name of each phase started and completed in " "the build log of packages that you build." msgstr "" #. type: Plain text #: doc/guix.texi:9908 msgid "" "Let's now look at the procedures themselves. Each one is defined with " "@code{define*}: @code{#:key} lists keyword parameters the procedure accepts, " "possibly with a default value, and @code{#:allow-other-keys} specifies that " "other keyword parameters are ignored (@pxref{Optional Arguments,,, guile, " "GNU Guile Reference Manual})." msgstr "" #. type: Plain text #: doc/guix.texi:9924 msgid "" "The @code{unpack} procedure honors the @code{source} parameter, which the " "build system uses to pass the file name of the source tarball (or version " "control checkout), and it ignores other parameters. The @code{configure} " "phase only cares about the @code{outputs} parameter, an alist mapping " "package output names to their store file name (@pxref{Packages with Multiple " "Outputs}). It extracts the file name of for @code{out}, the default output, " "and passes it to @command{./configure} as the installation prefix, meaning " "that @command{make install} will eventually copy all the files in that " "directory (@pxref{Configuration, configuration and makefile conventions,, " "standards, GNU Coding Standards}). @code{build} and @code{install} ignore " "all their arguments. @code{check} honors the @code{test-target} argument, " "which specifies the name of the Makefile target to run tests; it prints a " "message and skips tests when @code{tests?} is false." msgstr "" #. type: cindex #: doc/guix.texi:9925 #, no-wrap msgid "build phases, customizing" msgstr "" #. type: Plain text #: doc/guix.texi:9934 msgid "" "The list of phases used for a particular package can be changed with the " "@code{#:phases} parameter of the build system. Changing the set of build " "phases boils down to building a new alist of phases based on the " "@code{%standard-phases} alist described above. This can be done with " "standard alist procedures such as @code{alist-delete} (@pxref{SRFI-1 " "Association Lists,,, guile, GNU Guile Reference Manual}); however, it is " "more convenient to do so with @code{modify-phases} (@pxref{Build Utilities, " "@code{modify-phases}})." msgstr "" #. type: Plain text #: doc/guix.texi:9939 msgid "" "Here is an example of a package definition that removes the @code{configure} " "phase of @code{%standard-phases} and inserts a new phase before the " "@code{build} phase, called @code{set-prefix-in-makefile}:" msgstr "" #. type: lisp #: doc/guix.texi:9958 #, no-wrap msgid "" "(define-public example\n" " (package\n" " (name \"example\")\n" " ;; other fields omitted\n" " (build-system gnu-build-system)\n" " (arguments\n" " '(#:phases (modify-phases %standard-phases\n" " (delete 'configure)\n" " (add-before 'build 'set-prefix-in-makefile\n" " (lambda* (#:key outputs #:allow-other-keys)\n" " ;; Modify the makefile so that its\n" " ;; 'PREFIX' variable points to \"out\".\n" " (let ((out (assoc-ref outputs \"out\")))\n" " (substitute* \"Makefile\"\n" " ((\"PREFIX =.*\")\n" " (string-append \"PREFIX = \"\n" " out \"\\n\")))))))))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:9964 msgid "" "The new phase that is inserted is written as an anonymous procedure, " "introduced with @code{lambda*}; it honors the @code{outputs} parameter we " "have seen before. @xref{Build Utilities}, for more about the helpers used " "by this phase, and for more examples of @code{modify-phases}." msgstr "" #. type: cindex #: doc/guix.texi:9965 doc/guix.texi:11323 #, no-wrap msgid "code staging" msgstr "" #. type: cindex #: doc/guix.texi:9966 doc/guix.texi:11324 #, no-wrap msgid "staging, of code" msgstr "" #. type: Plain text #: doc/guix.texi:9973 msgid "" "Keep in mind that build phases are code evaluated at the time the package is " "actually built. This explains why the whole @code{modify-phases} expression " "above is quoted (it comes after the @code{'} or apostrophe): it is " "@dfn{staged} for later execution. @xref{G-Expressions}, for an explanation " "of code staging and the @dfn{code strata} involved." msgstr "" #. type: Plain text #: doc/guix.texi:9983 msgid "" "As soon as you start writing non-trivial package definitions " "(@pxref{Defining Packages}) or other build actions (@pxref{G-Expressions}), " "you will likely start looking for helpers for ``shell-like'' actions---" "creating directories, copying and deleting files recursively, manipulating " "build phases, and so on. The @code{(guix build utils)} module provides such " "utility procedures." msgstr "" #. type: Plain text #: doc/guix.texi:9987 msgid "" "Most build systems load @code{(guix build utils)} (@pxref{Build Systems}). " "Thus, when writing custom build phases for your package definitions, you can " "usually assume those procedures are in scope." msgstr "" #. type: Plain text #: doc/guix.texi:9992 msgid "" "When writing G-expressions, you can import @code{(guix build utils)} on the " "``build side'' using @code{with-imported-modules} and then put it in scope " "with the @code{use-modules} form (@pxref{Using Guile Modules,,, guile, GNU " "Guile Reference Manual}):" msgstr "" #. type: lisp #: doc/guix.texi:9999 #, no-wrap msgid "" "(with-imported-modules '((guix build utils)) ;import it\n" " (computed-file \"empty-tree\"\n" " #~(begin\n" " ;; Put it in scope.\n" " (use-modules (guix build utils))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:10002 #, no-wrap msgid "" " ;; Happily use its 'mkdir-p' procedure.\n" " (mkdir-p (string-append #$output \"/a/b/c\")))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:10006 msgid "" "The remainder of this section is the reference for most of the utility " "procedures provided by @code{(guix build utils)}." msgstr "" #. type: subsection #: doc/guix.texi:10009 #, no-wrap msgid "Dealing with Store File Names" msgstr "" #. type: Plain text #: doc/guix.texi:10012 msgid "This section documents procedures that deal with store file names." msgstr "" #. type: deffn #: doc/guix.texi:10013 #, no-wrap msgid "{Scheme Procedure} %store-directory" msgstr "" #. type: deffn #: doc/guix.texi:10015 msgid "Return the directory name of the store." msgstr "" #. type: deffn #: doc/guix.texi:10017 #, no-wrap msgid "{Scheme Procedure} store-file-name? @var{file}" msgstr "" #. type: deffn #: doc/guix.texi:10019 msgid "Return true if @var{file} is in the store." msgstr "" #. type: deffn #: doc/guix.texi:10021 #, no-wrap msgid "{Scheme Procedure} strip-store-file-name @var{file}" msgstr "" #. type: deffn #: doc/guix.texi:10024 msgid "" "Strip the @file{/gnu/store} and hash from @var{file}, a store file name. " "The result is typically a @code{\"@var{package}-@var{version}\"} string." msgstr "" #. type: deffn #: doc/guix.texi:10026 #, no-wrap msgid "{Scheme Procedure} package-name->name+version @var{name}" msgstr "" #. type: deffn #: doc/guix.texi:10031 msgid "" "Given @var{name}, a package name like @code{\"foo-0.9.1b\"}, return two " "values: @code{\"foo\"} and @code{\"0.9.1b\"}. When the version part is " "unavailable, @var{name} and @code{#f} are returned. The first hyphen " "followed by a digit is considered to introduce the version part." msgstr "" #. type: subsection #: doc/guix.texi:10033 #, no-wrap msgid "File Types" msgstr "" #. type: Plain text #: doc/guix.texi:10036 msgid "The procedures below deal with files and file types." msgstr "" #. type: deffn #: doc/guix.texi:10037 #, no-wrap msgid "{Scheme Procedure} directory-exists? @var{dir}" msgstr "" #. type: deffn #: doc/guix.texi:10039 msgid "Return @code{#t} if @var{dir} exists and is a directory." msgstr "" #. type: deffn #: doc/guix.texi:10041 #, no-wrap msgid "{Scheme Procedure} executable-file? @var{file}" msgstr "" #. type: deffn #: doc/guix.texi:10043 msgid "Return @code{#t} if @var{file} exists and is executable." msgstr "" #. type: deffn #: doc/guix.texi:10045 #, no-wrap msgid "{Scheme Procedure} symbolic-link? @var{file}" msgstr "" #. type: deffn #: doc/guix.texi:10047 msgid "Return @code{#t} if @var{file} is a symbolic link (aka. a ``symlink'')." msgstr "" #. type: deffn #: doc/guix.texi:10049 #, no-wrap msgid "{Scheme Procedure} elf-file? @var{file}" msgstr "" #. type: deffnx #: doc/guix.texi:10050 #, no-wrap msgid "{Scheme Procedure} ar-file? @var{file}" msgstr "" #. type: deffnx #: doc/guix.texi:10051 #, no-wrap msgid "{Scheme Procedure} gzip-file? @var{file}" msgstr "" #. type: deffn #: doc/guix.texi:10054 msgid "" "Return @code{#t} if @var{file} is, respectively, an ELF file, an @code{ar} " "archive (such as a @file{.a} static library), or a gzip file." msgstr "" #. type: deffn #: doc/guix.texi:10056 #, no-wrap msgid "{Scheme Procedure} reset-gzip-timestamp @var{file} [#:keep-mtime? #t]" msgstr "" #. type: deffn #: doc/guix.texi:10060 msgid "" "If @var{file} is a gzip file, reset its embedded timestamp (as with " "@command{gzip --no-name}) and return true. Otherwise return @code{#f}. " "When @var{keep-mtime?} is true, preserve @var{file}'s modification time." msgstr "" #. type: subsection #: doc/guix.texi:10062 #, no-wrap msgid "File Manipulation" msgstr "" #. type: Plain text #: doc/guix.texi:10069 msgid "" "The following procedures and macros help create, modify, and delete files. " "They provide functionality comparable to common shell utilities such as " "@command{mkdir -p}, @command{cp -r}, @command{rm -r}, and @command{sed}. " "They complement Guile's extensive, but low-level, file system interface " "(@pxref{POSIX,,, guile, GNU Guile Reference Manual})." msgstr "" #. type: deffn #: doc/guix.texi:10070 #, no-wrap msgid "{Scheme Syntax} with-directory-excursion @var{directory} @var{body}@dots{}" msgstr "" #. type: deffn #: doc/guix.texi:10072 msgid "Run @var{body} with @var{directory} as the process's current directory." msgstr "" #. type: deffn #: doc/guix.texi:10079 msgid "" "Essentially, this macro changes the current directory to @var{directory} " "before evaluating @var{body}, using @code{chdir} (@pxref{Processes,,, guile, " "GNU Guile Reference Manual}). It changes back to the initial directory when " "the dynamic extent of @var{body} is left, be it @i{via} normal procedure " "return or @i{via} a non-local exit such as an exception." msgstr "" #. type: deffn #: doc/guix.texi:10081 #, no-wrap msgid "{Scheme Procedure} mkdir-p @var{dir}" msgstr "" #. type: deffn #: doc/guix.texi:10083 msgid "Create directory @var{dir} and all its ancestors." msgstr "" #. type: deffn #: doc/guix.texi:10085 #, no-wrap msgid "{Scheme Procedure} install-file @var{file} @var{directory}" msgstr "" #. type: deffn #: doc/guix.texi:10088 msgid "" "Create @var{directory} if it does not exist and copy @var{file} in there " "under the same name." msgstr "" #. type: deffn #: doc/guix.texi:10090 #, no-wrap msgid "{Scheme Procedure} make-file-writable @var{file}" msgstr "" #. type: deffn #: doc/guix.texi:10092 msgid "Make @var{file} writable for its owner." msgstr "" #. type: deffn #: doc/guix.texi:10094 #, no-wrap msgid "{Scheme Procedure} copy-recursively @var{source} @var{destination} @" msgstr "" #. type: deffn #: doc/guix.texi:10103 msgid "" "[#:log (current-output-port)] [#:follow-symlinks? #f] @ [#:copy-file copy-" "file] [#:keep-mtime? #f] [#:keep-permissions? #t] Copy @var{source} " "directory to @var{destination}. Follow symlinks if @var{follow-symlinks?} " "is true; otherwise, just preserve them. Call @var{copy-file} to copy " "regular files. When @var{keep-mtime?} is true, keep the modification time " "of the files in @var{source} on those of @var{destination}. When @var{keep-" "permissions?} is true, preserve file permissions. Write verbose output to " "the @var{log} port." msgstr "" #. type: deffn #: doc/guix.texi:10105 #, no-wrap msgid "{Scheme Procedure} delete-file-recursively @var{dir} @" msgstr "" #. type: deffn #: doc/guix.texi:10110 msgid "" "[#:follow-mounts? #f] Delete @var{dir} recursively, like @command{rm -rf}, " "without following symlinks. Don't follow mount points either, unless " "@var{follow-mounts?} is true. Report but ignore errors." msgstr "" #. type: deffn #: doc/guix.texi:10112 #, no-wrap msgid "{Scheme Syntax} substitute* @var{file} @" msgstr "" #. type: deffn #: doc/guix.texi:10117 msgid "" "((@var{regexp} @var{match-var}@dots{}) @var{body}@dots{}) @dots{} Substitute " "@var{regexp} in @var{file} by the string returned by @var{body}. @var{body} " "is evaluated with each @var{match-var} bound to the corresponding positional " "regexp sub-expression. For example:" msgstr "" #. type: lisp #: doc/guix.texi:10124 #, no-wrap msgid "" "(substitute* file\n" " ((\"hello\")\n" " \"good morning\\n\")\n" " ((\"foo([a-z]+)bar(.*)$\" all letters end)\n" " (string-append \"baz\" letters end)))\n" msgstr "" #. type: deffn #: doc/guix.texi:10130 msgid "" "Here, anytime a line of @var{file} contains @code{hello}, it is replaced by " "@code{good morning}. Anytime a line of @var{file} matches the second " "regexp, @code{all} is bound to the complete match, @code{letters} is bound " "to the first sub-expression, and @code{end} is bound to the last one." msgstr "" #. type: deffn #: doc/guix.texi:10133 msgid "" "When one of the @var{match-var} is @code{_}, no variable is bound to the " "corresponding match substring." msgstr "" #. type: deffn #: doc/guix.texi:10136 msgid "" "Alternatively, @var{file} may be a list of file names, in which case they " "are all subject to the substitutions." msgstr "" #. type: deffn #: doc/guix.texi:10139 msgid "" "Be careful about using @code{$} to match the end of a line; by itself it " "won't match the terminating newline of a line." msgstr "" #. type: subsection #: doc/guix.texi:10141 #, no-wrap msgid "File Search" msgstr "" #. type: cindex #: doc/guix.texi:10143 #, no-wrap msgid "file, searching" msgstr "" #. type: Plain text #: doc/guix.texi:10145 msgid "This section documents procedures to search and filter files." msgstr "" #. type: deffn #: doc/guix.texi:10146 #, no-wrap msgid "{Scheme Procedure} file-name-predicate @var{regexp}" msgstr "" #. type: deffn #: doc/guix.texi:10149 msgid "" "Return a predicate that returns true when passed a file name whose base name " "matches @var{regexp}." msgstr "" #. type: deffn #: doc/guix.texi:10151 #, no-wrap msgid "{Scheme Procedure} find-files @var{dir} [@var{pred}] @" msgstr "" #. type: deffn #: doc/guix.texi:10162 msgid "" "[#:stat lstat] [#:directories? #f] [#:fail-on-error? #f] Return the " "lexicographically sorted list of files under @var{dir} for which @var{pred} " "returns true. @var{pred} is passed two arguments: the absolute file name, " "and its stat buffer; the default predicate always returns true. @var{pred} " "can also be a regular expression, in which case it is equivalent to " "@code{(file-name-predicate @var{pred})}. @var{stat} is used to obtain file " "information; using @code{lstat} means that symlinks are not followed. If " "@var{directories?} is true, then directories will also be included. If " "@var{fail-on-error?} is true, raise an exception upon error." msgstr "" #. type: Plain text #: doc/guix.texi:10166 msgid "" "Here are a few examples where we assume that the current directory is the " "root of the Guix source tree:" msgstr "" #. type: lisp #: doc/guix.texi:10171 #, no-wrap msgid "" ";; List all the regular files in the current directory.\n" "(find-files \".\")\n" "@result{} (\"./.dir-locals.el\" \"./.gitignore\" @dots{})\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:10175 #, no-wrap msgid "" ";; List all the .scm files under gnu/services.\n" "(find-files \"gnu/services\" \"\\\\.scm$\")\n" "@result{} (\"gnu/services/admin.scm\" \"gnu/services/audio.scm\" @dots{})\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:10179 #, no-wrap msgid "" ";; List ar files in the current directory.\n" "(find-files \".\" (lambda (file stat) (ar-file? file)))\n" "@result{} (\"./libformat.a\" \"./libstore.a\" @dots{})\n" msgstr "" #. type: deffn #: doc/guix.texi:10181 #, no-wrap msgid "{Scheme Procedure} which @var{program}" msgstr "" #. type: deffn #: doc/guix.texi:10184 msgid "" "Return the complete file name for @var{program} as found in @code{$PATH}, or " "@code{#f} if @var{program} could not be found." msgstr "" #. type: deffn #: doc/guix.texi:10186 #, no-wrap msgid "{Scheme Procedure} search-input-file @var{inputs} @var{name}" msgstr "" #. type: deffnx #: doc/guix.texi:10187 #, no-wrap msgid "{Scheme Procedure} search-input-directory @var{inputs} @var{name}" msgstr "" #. type: deffn #: doc/guix.texi:10192 msgid "" "Return the complete file name for @var{name} as found in @var{inputs}; " "@code{search-input-file} searches for a regular file and @code{search-input-" "directory} searches for a directory. If @var{name} could not be found, an " "exception is raised." msgstr "" #. type: deffn #: doc/guix.texi:10196 msgid "" "Here, @var{inputs} must be an association list like @code{inputs} and " "@code{native-inputs} as available to build phases (@pxref{Build Phases})." msgstr "" #. type: Plain text #: doc/guix.texi:10200 msgid "" "Here is a (simplified) example of how @code{search-input-file} is used in a " "build phase of the @code{wireguard-tools} package:" msgstr "" #. type: lisp #: doc/guix.texi:10209 #, no-wrap msgid "" "(add-after 'install 'wrap-wg-quick\n" " (lambda* (#:key inputs outputs #:allow-other-keys)\n" " (let ((coreutils (string-append (assoc-ref inputs \"coreutils\")\n" " \"/bin\")))\n" " (wrap-program (search-input-file outputs \"bin/wg-quick\")\n" " #:sh (search-input-file inputs \"bin/bash\")\n" " `(\"PATH\" \":\" prefix ,(list coreutils))))))\n" msgstr "" #. type: subsection #: doc/guix.texi:10211 #, no-wrap msgid "Program Invocation" msgstr "" #. type: cindex #: doc/guix.texi:10213 #, no-wrap msgid "program invocation, from Scheme" msgstr "" #. type: cindex #: doc/guix.texi:10214 #, no-wrap msgid "invoking programs, from Scheme" msgstr "" #. type: Plain text #: doc/guix.texi:10218 msgid "" "You'll find handy procedures to spawn processes in this module, essentially " "convenient wrappers around Guile's @code{system*} (@pxref{Processes, " "@code{system*},, guile, GNU Guile Reference Manual})." msgstr "" #. type: deffn #: doc/guix.texi:10219 #, no-wrap msgid "{Scheme Procedure} invoke @var{program} @var{args}@dots{}" msgstr "" #. type: deffn #: doc/guix.texi:10223 msgid "" "Invoke @var{program} with the given @var{args}. Raise an @code{&invoke-" "error} exception if the exit code is non-zero; otherwise return @code{#t}." msgstr "" #. type: deffn #: doc/guix.texi:10227 msgid "" "The advantage compared to @code{system*} is that you do not need to check " "the return value. This reduces boilerplate in shell-script-like snippets " "for instance in package build phases." msgstr "" #. type: deffn #: doc/guix.texi:10229 #, no-wrap msgid "{Scheme Procedure} invoke-error? @var{c}" msgstr "" #. type: deffn #: doc/guix.texi:10231 msgid "Return true if @var{c} is an @code{&invoke-error} condition." msgstr "" #. type: deffn #: doc/guix.texi:10233 #, no-wrap msgid "{Scheme Procedure} invoke-error-program @var{c}" msgstr "" #. type: deffnx #: doc/guix.texi:10234 #, no-wrap msgid "{Scheme Procedure} invoke-error-arguments @var{c}" msgstr "" #. type: deffnx #: doc/guix.texi:10235 #, no-wrap msgid "{Scheme Procedure} invoke-error-exit-status @var{c}" msgstr "" #. type: deffnx #: doc/guix.texi:10236 #, no-wrap msgid "{Scheme Procedure} invoke-error-term-signal @var{c}" msgstr "" #. type: deffnx #: doc/guix.texi:10237 #, no-wrap msgid "{Scheme Procedure} invoke-error-stop-signal @var{c}" msgstr "" #. type: deffn #: doc/guix.texi:10239 msgid "Access specific fields of @var{c}, an @code{&invoke-error} condition." msgstr "" #. type: deffn #: doc/guix.texi:10241 #, no-wrap msgid "{Scheme Procedure} report-invoke-error @var{c} [@var{port}]" msgstr "" #. type: deffn #: doc/guix.texi:10244 msgid "" "Report to @var{port} (by default the current error port) about @var{c}, an " "@code{&invoke-error} condition, in a human-friendly way." msgstr "" #. type: deffn #: doc/guix.texi:10246 msgid "Typical usage would look like this:" msgstr "" #. type: lisp #: doc/guix.texi:10250 #, no-wrap msgid "" "(use-modules (srfi srfi-34) ;for 'guard'\n" " (guix build utils))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:10254 #, no-wrap msgid "" "(guard (c ((invoke-error? c)\n" " (report-invoke-error c)))\n" " (invoke \"date\" \"--imaginary-option\"))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:10256 #, no-wrap msgid "@print{} command \"date\" \"--imaginary-option\" failed with status 1\n" msgstr "" #. type: deffn #: doc/guix.texi:10259 #, no-wrap msgid "{Scheme Procedure} invoke/quiet @var{program} @var{args}@dots{}" msgstr "" #. type: deffn #: doc/guix.texi:10265 msgid "" "Invoke @var{program} with @var{args} and capture @var{program}'s standard " "output and standard error. If @var{program} succeeds, print nothing and " "return the unspecified value; otherwise, raise a @code{&message} error " "condition that includes the status code and the output of @var{program}." msgstr "" #. type: deffn #: doc/guix.texi:10267 msgid "Here's an example:" msgstr "" #. type: lisp #: doc/guix.texi:10272 #, no-wrap msgid "" "(use-modules (srfi srfi-34) ;for 'guard'\n" " (srfi srfi-35) ;for 'message-condition?'\n" " (guix build utils))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:10277 #, no-wrap msgid "" "(guard (c ((message-condition? c)\n" " (display (condition-message c))))\n" " (invoke/quiet \"date\") ;all is fine\n" " (invoke/quiet \"date\" \"--imaginary-option\"))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:10279 #, no-wrap msgid "" "@print{} 'date --imaginary-option' exited with status 1; output follows:\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:10282 #, no-wrap msgid "" " date: unrecognized option '--imaginary-option'\n" " Try 'date --help' for more information.\n" msgstr "" #. type: Plain text #: doc/guix.texi:10294 msgid "" "The @code{(guix build utils)} also contains tools to manipulate build phases " "as used by build systems (@pxref{Build Systems}). Build phases are " "represented as association lists or ``alists'' (@pxref{Association Lists,,, " "guile, GNU Guile Reference Manual}) where each key is a symbol naming the " "phase and the associated value is a procedure (@pxref{Build Phases})." msgstr "" #. type: Plain text #: doc/guix.texi:10298 msgid "" "Guile core and the @code{(srfi srfi-1)} module both provide tools to " "manipulate alists. The @code{(guix build utils)} module complements those " "with tools written with build phases in mind." msgstr "" #. type: cindex #: doc/guix.texi:10299 #, no-wrap msgid "build phases, modifying" msgstr "" #. type: deffn #: doc/guix.texi:10300 #, no-wrap msgid "{Scheme Syntax} modify-phases @var{phases} @var{clause}@dots{}" msgstr "" #. type: deffn #: doc/guix.texi:10303 msgid "" "Modify @var{phases} sequentially as per each @var{clause}, which may have " "one of the following forms:" msgstr "" #. type: lisp #: doc/guix.texi:10309 #, no-wrap msgid "" "(delete @var{old-phase-name})\n" "(replace @var{old-phase-name} @var{new-phase})\n" "(add-before @var{old-phase-name} @var{new-phase-name} @var{new-phase})\n" "(add-after @var{old-phase-name} @var{new-phase-name} @var{new-phase})\n" msgstr "" #. type: deffn #: doc/guix.texi:10313 msgid "" "Where every @var{phase-name} above is an expression evaluating to a symbol, " "and @var{new-phase} an expression evaluating to a procedure." msgstr "" #. type: Plain text #: doc/guix.texi:10324 msgid "" "The example below is taken from the definition of the @code{grep} package. " "It adds a phase to run after the @code{install} phase, called @code{fix-" "egrep-and-fgrep}. That phase is a procedure (@code{lambda*} is for " "anonymous procedures) that takes a @code{#:outputs} keyword argument and " "ignores extra keyword arguments (@pxref{Optional Arguments,,, guile, GNU " "Guile Reference Manual}, for more on @code{lambda*} and optional and keyword " "arguments.) The phase uses @code{substitute*} to modify the installed " "@file{egrep} and @file{fgrep} scripts so that they refer to @code{grep} by " "its absolute file name:" msgstr "" #. type: lisp #: doc/guix.texi:10337 #, no-wrap msgid "" "(modify-phases %standard-phases\n" " (add-after 'install 'fix-egrep-and-fgrep\n" " ;; Patch 'egrep' and 'fgrep' to execute 'grep' via its\n" " ;; absolute file name instead of searching for it in $PATH.\n" " (lambda* (#:key outputs #:allow-other-keys)\n" " (let* ((out (assoc-ref outputs \"out\"))\n" " (bin (string-append out \"/bin\")))\n" " (substitute* (list (string-append bin \"/egrep\")\n" " (string-append bin \"/fgrep\"))\n" " ((\"^exec grep\")\n" " (string-append \"exec \" bin \"/grep\")))))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:10344 msgid "" "In the example below, phases are modified in two ways: the standard " "@code{configure} phase is deleted, presumably because the package does not " "have a @file{configure} script or anything similar, and the default " "@code{install} phase is replaced by one that manually copies the executable " "files to be installed:" msgstr "" #. type: lisp #: doc/guix.texi:10356 #, no-wrap msgid "" "(modify-phases %standard-phases\n" " (delete 'configure) ;no 'configure' script\n" " (replace 'install\n" " (lambda* (#:key outputs #:allow-other-keys)\n" " ;; The package's Makefile doesn't provide an \"install\"\n" " ;; rule so do it by ourselves.\n" " (let ((bin (string-append (assoc-ref outputs \"out\")\n" " \"/bin\")))\n" " (install-file \"footswitch\" bin)\n" " (install-file \"scythe\" bin)))))\n" msgstr "" #. type: subsection #: doc/guix.texi:10360 #, no-wrap msgid "Wrappers" msgstr "" #. type: cindex #: doc/guix.texi:10362 #, no-wrap msgid "program wrappers" msgstr "" #. type: cindex #: doc/guix.texi:10363 #, no-wrap msgid "wrapping programs" msgstr "" #. type: Plain text #: doc/guix.texi:10369 msgid "" "It is not unusual for a command to require certain environment variables to " "be set for proper functioning, typically search paths (@pxref{Search " "Paths}). Failing to do that, the command might fail to find files or other " "commands it relies on, or it might pick the ``wrong'' ones---depending on " "the environment in which it runs. Examples include:" msgstr "" #. type: itemize #: doc/guix.texi:10373 msgid "a shell script that assumes all the commands it uses are in @env{PATH};" msgstr "" #. type: itemize #: doc/guix.texi:10377 msgid "" "a Guile program that assumes all its modules are in @env{GUILE_LOAD_PATH} " "and @env{GUILE_LOAD_COMPILED_PATH};" msgstr "" #. type: itemize #: doc/guix.texi:10381 msgid "" "a Qt application that expects to find certain plugins in " "@env{QT_PLUGIN_PATH}." msgstr "" #. type: Plain text #: doc/guix.texi:10389 msgid "" "For a package writer, the goal is to make sure commands always work the same " "rather than depend on some external settings. One way to achieve that is to " "@dfn{wrap} commands in a thin script that sets those environment variables, " "thereby ensuring that those run-time dependencies are always found. The " "wrapper would be used to set @env{PATH}, @env{GUILE_LOAD_PATH}, or " "@env{QT_PLUGIN_PATH} in the examples above." msgstr "" #. type: Plain text #: doc/guix.texi:10392 msgid "" "To ease that task, the @code{(guix build utils)} module provides a couple of " "helpers to wrap commands." msgstr "" #. type: deffn #: doc/guix.texi:10393 #, no-wrap msgid "{Scheme Procedure} wrap-program @var{program} @" msgstr "" #. type: deffn #: doc/guix.texi:10396 msgid "" "[#:sh @var{sh}] [#:rest @var{variables}] Make a wrapper for @var{program}. " "@var{variables} should look like this:" msgstr "" #. type: lisp #: doc/guix.texi:10399 #, no-wrap msgid "'(@var{variable} @var{delimiter} @var{position} @var{list-of-directories})\n" msgstr "" #. type: deffn #: doc/guix.texi:10403 msgid "" "where @var{delimiter} is optional. @code{:} will be used if @var{delimiter} " "is not given." msgstr "" #. type: deffn #: doc/guix.texi:10405 msgid "For example, this call:" msgstr "" #. type: lisp #: doc/guix.texi:10411 #, no-wrap msgid "" "(wrap-program \"foo\"\n" " '(\"PATH\" \":\" = (\"/gnu/.../bar/bin\"))\n" " '(\"CERT_PATH\" suffix (\"/gnu/.../baz/certs\"\n" " \"/qux/certs\")))\n" msgstr "" #. type: deffn #: doc/guix.texi:10415 msgid "" "will copy @file{foo} to @file{.foo-real} and create the file @file{foo} with " "the following contents:" msgstr "" #. type: example #: doc/guix.texi:10421 #, no-wrap msgid "" "#!location/of/bin/bash\n" "export PATH=\"/gnu/.../bar/bin\"\n" "export CERT_PATH=\"$CERT_PATH$@{CERT_PATH:+:@}/gnu/.../baz/certs:/qux/certs\"\n" "exec -a $0 location/of/.foo-real \"$@@\"\n" msgstr "" #. type: deffn #: doc/guix.texi:10426 msgid "" "If @var{program} has previously been wrapped by @code{wrap-program}, the " "wrapper is extended with definitions for @var{variables}. If it is not, " "@var{sh} will be used as the interpreter." msgstr "" #. type: deffn #: doc/guix.texi:10428 #, no-wrap msgid "{Scheme Procedure} wrap-script @var{program} @" msgstr "" #. type: deffn #: doc/guix.texi:10436 msgid "" "[#:guile @var{guile}] [#:rest @var{variables}] Wrap the script @var{program} " "such that @var{variables} are set first. The format of @var{variables} is " "the same as in the @code{wrap-program} procedure. This procedure differs " "from @code{wrap-program} in that it does not create a separate shell " "script. Instead, @var{program} is modified directly by prepending a Guile " "script, which is interpreted as a comment in the script's language." msgstr "" #. type: deffn #: doc/guix.texi:10439 msgid "" "Special encoding comments as supported by Python are recreated on the second " "line." msgstr "" #. type: deffn #: doc/guix.texi:10442 msgid "" "Note that this procedure can only be used once per file as Guile scripts are " "not supported." msgstr "" #. type: cindex #: doc/guix.texi:10447 #, no-wrap msgid "search path" msgstr "" #. type: Plain text #: doc/guix.texi:10454 msgid "" "Many programs and libraries look for input data in a @dfn{search path}, a " "list of directories: shells like Bash look for executables in the command " "search path, a C compiler looks for @file{.h} files in its header search " "path, the Python interpreter looks for @file{.py} files in its search path, " "the spell checker has a search path for dictionaries, and so on." msgstr "" #. type: Plain text #: doc/guix.texi:10462 msgid "" "Search paths can usually be defined or overridden @i{via} environment " "variables (@pxref{Environment Variables,,, libc, The GNU C Library Reference " "Manual}). For example, the search paths mentioned above can be changed by " "defining the @env{PATH}, @env{C_INCLUDE_PATH}, @env{PYTHONPATH} (or " "@env{GUIX_PYTHONPATH}), and @env{DICPATH} environment variables---you know, " "all these something-PATH variables that you need to get right or things " "``won't be found''." msgstr "" #. type: Plain text #: doc/guix.texi:10472 msgid "" "You may have noticed from the command line that Guix ``knows'' which search " "path environment variables should be defined, and how. When you install " "packages in your default profile, the file @file{~/.guix-profile/etc/" "profile} is created, which you can ``source'' from the shell to set those " "variables. Likewise, if you ask @command{guix shell} to create an " "environment containing Python and NumPy, a Python library, and if you pass " "it the @option{--search-paths} option, it will tell you about @env{PATH} and " "@env{GUIX_PYTHONPATH} (@pxref{Invoking guix shell}):" msgstr "" #. type: example #: doc/guix.texi:10477 #, no-wrap msgid "" "$ guix shell python python-numpy --pure --search-paths\n" "export PATH=\"/gnu/store/@dots{}-profile/bin\"\n" "export GUIX_PYTHONPATH=\"/gnu/store/@dots{}-profile/lib/python3.9/site-packages\"\n" msgstr "" #. type: Plain text #: doc/guix.texi:10481 msgid "" "When you omit @option{--search-paths}, it defines these environment " "variables right away, such that Python can readily find NumPy:" msgstr "" #. type: example #: doc/guix.texi:10490 #, no-wrap msgid "" "$ guix shell python python-numpy -- python3\n" "Python 3.9.6 (default, Jan 1 1970, 00:00:01)\n" "[GCC 10.3.0] on linux\n" "Type \"help\", \"copyright\", \"credits\" or \"license\" for more information.\n" ">>> import numpy\n" ">>> numpy.version.version\n" "'1.20.3'\n" msgstr "" #. type: Plain text #: doc/guix.texi:10495 msgid "" "For this to work, the definition of the @code{python} package " "@emph{declares} the search path it cares about and its associated " "environment variable, @env{GUIX_PYTHONPATH}. It looks like this:" msgstr "" #. type: lisp #: doc/guix.texi:10505 #, no-wrap msgid "" "(package\n" " (name \"python\")\n" " (version \"3.9.9\")\n" " ;; some fields omitted...\n" " (native-search-paths\n" " (list (search-path-specification\n" " (variable \"GUIX_PYTHONPATH\")\n" " (files (list \"lib/python/3.9/site-packages\"))))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:10520 msgid "" "What this @code{native-search-paths} field says is that, when the " "@code{python} package is used, the @env{GUIX_PYTHONPATH} environment " "variable must be defined to include all the @file{lib/python/3.9/site-" "packages} sub-directories encountered in its environment. (The " "@code{native-} bit means that, if we are in a cross-compilation environment, " "only native inputs may be added to the search path; @pxref{package " "Reference, @code{search-paths}}.) In the NumPy example above, the profile " "where @code{python} appears contains exactly one such sub-directory, and " "@env{GUIX_PYTHONPATH} is set to that. When there are several @file{lib/" "python/3.9/site-packages}---this is the case in package build environments---" "they are all added to @env{GUIX_PYTHONPATH}, separated by colons (@code{:})." msgstr "" #. type: quotation #: doc/guix.texi:10527 msgid "" "Notice that @env{GUIX_PYTHONPATH} is specified as part of the definition of " "the @code{python} package, and @emph{not} as part of that of @code{python-" "numpy}. This is because this environment variable ``belongs'' to Python, " "not NumPy: Python actually reads the value of that variable and honors it." msgstr "" #. type: quotation #: doc/guix.texi:10531 msgid "" "Corollary: if you create a profile that does not contain @code{python}, " "@code{GUIX_PYTHONPATH} will @emph{not} be defined, even if it contains " "packages that provide @file{.py} files:" msgstr "" #. type: example #: doc/guix.texi:10535 #, no-wrap msgid "" "$ guix shell python-numpy --search-paths --pure\n" "export PATH=\"/gnu/store/@dots{}-profile/bin\"\n" msgstr "" #. type: quotation #: doc/guix.texi:10539 msgid "" "This makes a lot of sense if we look at this profile in isolation: no " "software in this profile would read @env{GUIX_PYTHONPATH}." msgstr "" #. type: Plain text #: doc/guix.texi:10549 msgid "" "Of course, there are many variations on that theme: some packages honor more " "than one search path, some use separators other than colon, some accumulate " "several directories in their search path, and so on. A more complex example " "is the search path of libxml2: the value of the @env{XML_CATALOG_FILES} " "environment variable is space-separated, it must contain a list of " "@file{catalog.xml} files (not directories), which are to be found in " "@file{xml} sub-directories---nothing less. The search path specification " "looks like this:" msgstr "" #. type: lisp #: doc/guix.texi:10561 #, no-wrap msgid "" "(package\n" " (name \"libxml2\")\n" " ;; some fields omitted\n" " (native-search-paths\n" " (list (search-path-specification\n" " (variable \"XML_CATALOG_FILES\")\n" " (separator \" \")\n" " (files '(\"xml\"))\n" " (file-pattern \"^catalog\\\\.xml$\")\n" " (file-type 'regular)))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:10564 msgid "Worry not, search path specifications are usually not this tricky." msgstr "" #. type: Plain text #: doc/guix.texi:10568 msgid "" "The @code{(guix search-paths)} module defines the data type of search path " "specifications and a number of helper procedures. Below is the reference of " "search path specifications." msgstr "" #. type: deftp #: doc/guix.texi:10569 #, no-wrap msgid "{Data Type} search-path-specification" msgstr "" #. type: deftp #: doc/guix.texi:10571 msgid "The data type for search path specifications." msgstr "" #. type: code{#1} #: doc/guix.texi:10573 #, no-wrap msgid "variable" msgstr "" #. type: table #: doc/guix.texi:10575 msgid "The name of the environment variable for this search path (a string)." msgstr "" #. type: code{#1} #: doc/guix.texi:10576 doc/guix.texi:19165 #, no-wrap msgid "files" msgstr "" #. type: table #: doc/guix.texi:10579 msgid "" "The list of sub-directories (strings) that should be added to the search " "path." msgstr "" #. type: item #: doc/guix.texi:10580 #, no-wrap msgid "@code{separator} (default: @code{\":\"})" msgstr "" #. type: table #: doc/guix.texi:10582 msgid "The string used to separate search path components." msgstr "" #. type: table #: doc/guix.texi:10590 msgid "" "As a special case, a @code{separator} value of @code{#f} specifies a " "``single-component search path''---in other words, a search path that cannot " "contain more than one element. This is useful in some cases, such as the " "@code{SSL_CERT_DIR} variable (honored by OpenSSL, cURL, and a few other " "packages) or the @code{ASPELL_DICT_DIR} variable (honored by the GNU Aspell " "spell checker), both of which must point to a single directory." msgstr "" #. type: item #: doc/guix.texi:10591 #, no-wrap msgid "@code{file-type} (default: @code{'directory})" msgstr "" #. type: table #: doc/guix.texi:10595 msgid "" "The type of file being matched---@code{'directory} or @code{'regular}, " "though it can be any symbol returned by @code{stat:type} (@pxref{File " "System, @code{stat},, guile, GNU Guile Reference Manual})." msgstr "" #. type: table #: doc/guix.texi:10598 msgid "" "In the libxml2 example above, we would match regular files; in the Python " "example, we would match directories." msgstr "" #. type: item #: doc/guix.texi:10599 #, no-wrap msgid "@code{file-pattern} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:10603 msgid "" "This must be either @code{#f} or a regular expression specifying files to be " "matched @emph{within} the sub-directories specified by the @code{files} " "field." msgstr "" #. type: table #: doc/guix.texi:10605 msgid "Again, the libxml2 example shows a situation where this is needed." msgstr "" #. type: Plain text #: doc/guix.texi:10611 msgid "" "Some search paths are not tied by a single package but to many packages. To " "reduce duplications, some of them are pre-defined in @code{(guix search-" "paths)}." msgstr "" #. type: defvr #: doc/guix.texi:10612 #, no-wrap msgid "{Scheme Variable} $SSL_CERT_DIR" msgstr "" #. type: defvrx #: doc/guix.texi:10613 #, no-wrap msgid "{Scheme Variable} $SSL_CERT_FILE" msgstr "" #. type: defvr #: doc/guix.texi:10616 msgid "" "These two search paths indicate where X.509 certificates can be found " "(@pxref{X.509 Certificates})." msgstr "" #. type: Plain text #: doc/guix.texi:10619 msgid "These pre-defined search paths can be used as in the following example:" msgstr "" #. type: lisp #: doc/guix.texi:10625 #, no-wrap msgid "" "(package\n" " (name \"curl\")\n" " ;; some fields omitted ...\n" " (native-search-paths (list $SSL_CERT_DIR $SSL_CERT_FILE)))\n" msgstr "" #. type: Plain text #: doc/guix.texi:10630 msgid "" "How do you turn search path specifications on one hand and a bunch of " "directories on the other hand in a set of environment variable definitions? " "That's the job of @code{evaluate-search-paths}." msgstr "" #. type: deffn #: doc/guix.texi:10631 #, no-wrap msgid "{Scheme Procedure} evaluate-search-paths @var{search-paths} @" msgstr "" #. type: deffn #: doc/guix.texi:10637 msgid "" "@var{directories} [@var{getenv}] Evaluate @var{search-paths}, a list of " "search-path specifications, for @var{directories}, a list of directory " "names, and return a list of specification/value pairs. Use @var{getenv} to " "determine the current settings and report only settings not already " "effective." msgstr "" #. type: Plain text #: doc/guix.texi:10641 msgid "" "The @code{(guix profiles)} provides a higher-level helper procedure, " "@code{load-profile}, that sets the environment variables of a profile." msgstr "" #. type: cindex #: doc/guix.texi:10646 #, no-wrap msgid "store items" msgstr "" #. type: cindex #: doc/guix.texi:10647 #, no-wrap msgid "store paths" msgstr "" #. type: Plain text #: doc/guix.texi:10658 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:10663 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:10668 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:10672 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:10679 msgid "" "The @code{(guix store)} module provides procedures to connect to the daemon, " "and to perform RPCs. These are described below. By default, @code{open-" "connection}, and thus all the @command{guix} commands, connect to the local " "daemon or to the URI specified by the @env{GUIX_DAEMON_SOCKET} environment " "variable." msgstr "" #. type: defvr #: doc/guix.texi:10680 #, no-wrap msgid "{Environment Variable} GUIX_DAEMON_SOCKET" msgstr "" #. type: defvr #: doc/guix.texi:10685 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:10687 doc/guix.texi:28996 #, no-wrap msgid "file" msgstr "" #. type: itemx #: doc/guix.texi:10688 #, no-wrap msgid "unix" msgstr "" #. type: table #: doc/guix.texi:10692 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:10693 doc/contributing.texi:2102 #, no-wrap msgid "guix" msgstr "" #. type: table #: doc/guix.texi:10701 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:10704 #, no-wrap msgid "guix://master.guix.example.org:1234\n" msgstr "" #. type: table #: doc/guix.texi:10709 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:10713 msgid "" "The @option{--listen} option of @command{guix-daemon} can be used to " "instruct it to listen for TCP connections (@pxref{Invoking guix-daemon, " "@option{--listen}})." msgstr "" #. type: item #: doc/guix.texi:10714 #, no-wrap msgid "ssh" msgstr "" #. type: cindex #: doc/guix.texi:10715 #, no-wrap msgid "SSH access to build daemons" msgstr "" #. type: table #: doc/guix.texi:10721 msgid "" "These URIs allow you to connect to a remote daemon over SSH@. This feature " "requires Guile-SSH (@pxref{Requirements}) and a working @command{guile} " "binary in @env{PATH} on the destination machine. It supports public key and " "GSSAPI authentication. A typical URL might look like this:" msgstr "" #. type: example #: doc/guix.texi:10724 #, no-wrap msgid "ssh://charlie@@guix.example.org:22\n" msgstr "" #. type: table #: doc/guix.texi:10728 msgid "" "As for @command{guix copy}, the usual OpenSSH client configuration files are " "honored (@pxref{Invoking guix copy})." msgstr "" #. type: defvr #: doc/guix.texi:10731 msgid "Additional URI schemes may be supported in the future." msgstr "" #. type: quotation #: doc/guix.texi:10738 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:10741 #, no-wrap msgid "{Scheme Procedure} open-connection [@var{uri}] [#:reserve-space? #t]" msgstr "" #. type: deffn #: doc/guix.texi:10746 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:10749 msgid "" "@var{file} defaults to @code{%default-socket-path}, which is the normal " "location given the options that were passed to @command{configure}." msgstr "" #. type: deffn #: doc/guix.texi:10751 #, no-wrap msgid "{Scheme Procedure} close-connection @var{server}" msgstr "" #. type: deffn #: doc/guix.texi:10753 msgid "Close the connection to @var{server}." msgstr "" #. type: defvr #: doc/guix.texi:10755 #, no-wrap msgid "{Scheme Variable} current-build-output-port" msgstr "" #. type: defvr #: doc/guix.texi:10758 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:10762 msgid "" "Procedures that make RPCs all take a server object as their first argument." msgstr "" #. type: deffn #: doc/guix.texi:10763 #, no-wrap msgid "{Scheme Procedure} valid-path? @var{server} @var{path}" msgstr "" #. type: cindex #: doc/guix.texi:10764 #, no-wrap msgid "invalid store items" msgstr "" #. type: deffn #: doc/guix.texi:10769 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:10772 msgid "" "A @code{&store-protocol-error} condition is raised if @var{path} is not " "prefixed by the store directory (@file{/gnu/store})." msgstr "" #. type: deffn #: doc/guix.texi:10774 #, no-wrap msgid "{Scheme Procedure} add-text-to-store @var{server} @var{name} @var{text} [@var{references}]" msgstr "" #. type: deffn #: doc/guix.texi:10778 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:10780 #, no-wrap msgid "{Scheme Procedure} build-derivations @var{store} @var{derivations} @" msgstr "" #. type: deffn #: doc/guix.texi:10785 msgid "" "[@var{mode}] Build @var{derivations}, a list of @code{} objects, " "@file{.drv} file names, or derivation/output pairs, using the specified " "@var{mode}---@code{(build-mode normal)} by default." msgstr "" #. type: Plain text #: doc/guix.texi:10791 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:10794 msgid "This section is currently incomplete." msgstr "" #. type: cindex #: doc/guix.texi:10798 #, no-wrap msgid "derivations" msgstr "" #. type: Plain text #: doc/guix.texi:10802 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:10807 msgid "" "The outputs of the derivation---derivations produce at least one file or " "directory in the store, but may produce more." msgstr "" #. type: cindex #: doc/guix.texi:10809 #, no-wrap msgid "build-time dependencies" msgstr "" #. type: cindex #: doc/guix.texi:10810 #, no-wrap msgid "dependencies, build-time" msgstr "" #. type: itemize #: doc/guix.texi:10814 msgid "" "The inputs of the derivations---i.e., its build-time dependencies---which " "may be other derivations or plain files in the store (patches, build " "scripts, etc.)." msgstr "" #. type: itemize #: doc/guix.texi:10817 msgid "The system type targeted by the derivation---e.g., @code{x86_64-linux}." msgstr "" #. type: itemize #: doc/guix.texi:10821 msgid "" "The file name of a build script in the store, along with the arguments to be " "passed." msgstr "" #. type: itemize #: doc/guix.texi:10824 msgid "A list of environment variables to be defined." msgstr "" #. type: cindex #: doc/guix.texi:10827 #, no-wrap msgid "derivation path" msgstr "" #. type: Plain text #: doc/guix.texi:10835 msgid "" "Derivations allow clients of the daemon to communicate build actions to the " "store. They exist in two forms: as an in-memory representation, both on the " "client- and daemon-side, and as files in the store whose name end in @file{." "drv}---these files are referred to as @dfn{derivation paths}. Derivations " "paths can be passed to the @code{build-derivations} procedure to perform the " "build actions they prescribe (@pxref{The Store})." msgstr "" #. type: cindex #: doc/guix.texi:10836 #, no-wrap msgid "fixed-output derivations" msgstr "" #. type: Plain text #: doc/guix.texi:10843 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: item #: doc/guix.texi:10844 doc/guix.texi:14896 #, no-wrap msgid "references" msgstr "" #. type: cindex #: doc/guix.texi:10845 #, no-wrap msgid "run-time dependencies" msgstr "" #. type: cindex #: doc/guix.texi:10846 #, no-wrap msgid "dependencies, run-time" msgstr "" #. type: Plain text #: doc/guix.texi:10853 msgid "" "The outputs of derivations---i.e., the build results---have a set of " "@dfn{references}, as reported by the @code{references} RPC or the " "@command{guix gc --references} command (@pxref{Invoking guix gc}). " "References are the set of run-time dependencies of the build results. " "References are a subset of the inputs of the derivation; this subset is " "automatically computed by the build daemon by scanning all the files in the " "outputs." msgstr "" #. type: Plain text #: doc/guix.texi:10858 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:10859 #, no-wrap msgid "{Scheme Procedure} derivation @var{store} @var{name} @var{builder} @" msgstr "" #. type: deffn #: doc/guix.texi:10868 msgid "" "@var{args} [#:outputs '(\"out\")] [#:hash #f] [#:hash-algo #f] @ [#:" "recursive? #f] [#:inputs '()] [#:env-vars '()] @ [#:system (%current-" "system)] [#:references-graphs #f] @ [#:allowed-references #f] [#:disallowed-" "references #f] @ [#:leaked-env-vars #f] [#:local-build? #f] @ [#:" "substitutable? #t] [#:properties '()] Build a derivation with the given " "arguments, and return the resulting @code{} object." msgstr "" #. type: deffn #: doc/guix.texi:10875 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:10880 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:10885 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:10892 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:10897 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:10902 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: deffn #: doc/guix.texi:10905 msgid "" "@var{properties} must be an association list describing ``properties'' of " "the derivation. It is kept as-is, uninterpreted, in the derivation." msgstr "" #. type: Plain text #: doc/guix.texi:10911 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:10916 #, no-wrap msgid "" "(use-modules (guix utils)\n" " (guix store)\n" " (guix derivations))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:10925 #, 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{} # /gnu/store/@dots{}-foo>\n" msgstr "" #. type: Plain text #: doc/guix.texi:10932 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:10937 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:10938 #, no-wrap msgid "{Scheme Procedure} build-expression->derivation @var{store} @" msgstr "" #. type: deffn #: doc/guix.texi:10954 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:10962 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:10966 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:10971 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:10976 msgid "" "Here's an example of a single-output derivation that creates a directory " "containing one file:" msgstr "" #. type: lisp #: doc/guix.texi:10984 #, 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:10986 #, no-wrap msgid "@result{} # @dots{}>\n" msgstr "" #. type: cindex #: doc/guix.texi:10992 #, no-wrap msgid "monad" msgstr "" #. type: Plain text #: doc/guix.texi:10998 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:11004 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:11005 #, no-wrap msgid "monadic values" msgstr "" #. type: cindex #: doc/guix.texi:11006 #, no-wrap msgid "monadic functions" msgstr "" #. type: Plain text #: doc/guix.texi:11016 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:11018 msgid "Consider this ``normal'' procedure:" msgstr "" #. type: lisp #: doc/guix.texi:11027 #, 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:11031 msgid "" "Using @code{(guix monads)} and @code{(guix gexp)}, it may be rewritten as a " "monadic function:" msgstr "" #. type: lisp #: doc/guix.texi:11039 #, 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:11046 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:11050 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: lisp #: doc/guix.texi:11056 #, 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:11065 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: lisp #: doc/guix.texi:11069 #, no-wrap msgid "" "(run-with-store (open-connection) (sh-symlink))\n" "@result{} /gnu/store/...-sh-symlink\n" msgstr "" #. type: Plain text #: doc/guix.texi:11076 msgid "" "Note that the @code{(guix monad-repl)} module extends the Guile REPL with " "new ``commands'' to make it easier to deal with monadic procedures: " "@code{run-in-store}, and @code{enter-store-monad} (@pxref{Using Guix " "Interactively}). The former is used to ``run'' a single monadic value " "through the store:" msgstr "" #. type: example #: doc/guix.texi:11080 #, no-wrap msgid "" "scheme@@(guile-user)> ,run-in-store (package->derivation hello)\n" "$1 = # @dots{}>\n" msgstr "" #. type: Plain text #: doc/guix.texi:11084 msgid "" "The latter enters a recursive REPL, where all the return values are " "automatically run through the store:" msgstr "" #. type: example #: doc/guix.texi:11093 #, no-wrap msgid "" "scheme@@(guile-user)> ,enter-store-monad\n" "store-monad@@(guile-user) [1]> (package->derivation hello)\n" "$2 = # @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:11098 msgid "" "Note that non-monadic values cannot be returned in the @code{store-monad} " "REPL." msgstr "" #. type: Plain text #: doc/guix.texi:11101 msgid "" "Other meta-commands are available at the REPL, such as @code{,build} to " "build a file-like object (@pxref{Using Guix Interactively})." msgstr "" #. type: Plain text #: doc/guix.texi:11104 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:11105 #, no-wrap msgid "{Scheme Syntax} with-monad @var{monad} @var{body} ..." msgstr "" #. type: deffn #: doc/guix.texi:11108 msgid "" "Evaluate any @code{>>=} or @code{return} forms in @var{body} as being in " "@var{monad}." msgstr "" #. type: deffn #: doc/guix.texi:11110 #, no-wrap msgid "{Scheme Syntax} return @var{val}" msgstr "" #. type: deffn #: doc/guix.texi:11112 msgid "Return a monadic value that encapsulates @var{val}." msgstr "" #. type: deffn #: doc/guix.texi:11114 #, no-wrap msgid "{Scheme Syntax} >>= @var{mval} @var{mproc} ..." msgstr "" #. type: deffn #: doc/guix.texi:11121 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: lisp #: doc/guix.texi:11129 #, 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: lisp #: doc/guix.texi:11132 #, no-wrap msgid "" "@result{} 4\n" "@result{} some-state\n" msgstr "" #. type: deffn #: doc/guix.texi:11135 #, no-wrap msgid "{Scheme Syntax} mlet @var{monad} ((@var{var} @var{mval}) ...) @" msgstr "" #. type: deffn #: doc/guix.texi:11137 msgid "@var{body} ..." msgstr "" #. type: deffnx #: doc/guix.texi:11137 #, no-wrap msgid "{Scheme Syntax} mlet* @var{monad} ((@var{var} @var{mval}) ...) @" msgstr "" #. type: deffn #: doc/guix.texi:11149 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:11152 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:11154 #, no-wrap msgid "{Scheme System} mbegin @var{monad} @var{mexp} ..." msgstr "" #. type: deffn #: doc/guix.texi:11158 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:11162 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:11164 #, no-wrap msgid "{Scheme System} mwhen @var{condition} @var{mexp0} @var{mexp*} ..." msgstr "" #. type: deffn #: doc/guix.texi:11169 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:11171 #, no-wrap msgid "{Scheme System} munless @var{condition} @var{mexp0} @var{mexp*} ..." msgstr "" #. type: deffn #: doc/guix.texi:11176 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:11178 #, no-wrap msgid "state monad" msgstr "" #. type: Plain text #: doc/guix.texi:11182 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:11183 #, no-wrap msgid "{Scheme Variable} %state-monad" msgstr "" #. type: defvr #: doc/guix.texi:11186 msgid "" "The state monad. Procedures in the state monad can access and change the " "state that is threaded." msgstr "" #. type: defvr #: doc/guix.texi:11190 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: lisp #: doc/guix.texi:11197 #, 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: lisp #: doc/guix.texi:11201 #, 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:11205 msgid "" "When ``run'' through @code{%state-monad}, we obtain that additional state " "value, which is the number of @code{square} calls." msgstr "" #. type: deffn #: doc/guix.texi:11207 #, no-wrap msgid "{Monadic Procedure} current-state" msgstr "" #. type: deffn #: doc/guix.texi:11209 msgid "Return the current state as a monadic value." msgstr "" #. type: deffn #: doc/guix.texi:11211 #, no-wrap msgid "{Monadic Procedure} set-current-state @var{value}" msgstr "" #. type: deffn #: doc/guix.texi:11214 msgid "" "Set the current state to @var{value} and return the previous state as a " "monadic value." msgstr "" #. type: deffn #: doc/guix.texi:11216 #, no-wrap msgid "{Monadic Procedure} state-push @var{value}" msgstr "" #. type: deffn #: doc/guix.texi:11219 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:11221 #, no-wrap msgid "{Monadic Procedure} state-pop" msgstr "" #. type: deffn #: doc/guix.texi:11224 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:11226 #, no-wrap msgid "{Scheme Procedure} run-with-state @var{mval} [@var{state}]" msgstr "" #. type: deffn #: doc/guix.texi:11229 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:11233 msgid "" "The main interface to the store monad, provided by the @code{(guix store)} " "module, is as follows." msgstr "" #. type: defvr #: doc/guix.texi:11234 #, no-wrap msgid "{Scheme Variable} %store-monad" msgstr "" #. type: defvr #: doc/guix.texi:11236 msgid "The store monad---an alias for @code{%state-monad}." msgstr "" #. type: defvr #: doc/guix.texi:11240 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:11242 #, no-wrap msgid "{Scheme Procedure} run-with-store @var{store} @var{mval} [#:guile-for-build] [#:system (%current-system)]" msgstr "" #. type: deffn #: doc/guix.texi:11245 msgid "" "Run @var{mval}, a monadic value in the store monad, in @var{store}, an open " "store connection." msgstr "" #. type: deffn #: doc/guix.texi:11247 #, no-wrap msgid "{Monadic Procedure} text-file @var{name} @var{text} [@var{references}]" msgstr "" #. type: deffn #: doc/guix.texi:11251 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:11253 #, no-wrap msgid "{Monadic Procedure} binary-file @var{name} @var{data} [@var{references}]" msgstr "" #. type: deffn #: doc/guix.texi:11257 msgid "" "Return as a monadic value the absolute file name in the store of the file " "containing @var{data}, a bytevector. @var{references} is a list of store " "items that the resulting binary file refers to; it defaults to the empty " "list." msgstr "" #. type: deffn #: doc/guix.texi:11259 #, no-wrap msgid "{Monadic Procedure} interned-file @var{file} [@var{name}] @" msgstr "" #. type: deffn #: doc/guix.texi:11264 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:11268 doc/guix.texi:11691 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:11273 doc/guix.texi:11696 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:11275 msgid "The example below adds a file to the store, under two different names:" msgstr "" #. type: lisp #: doc/guix.texi:11281 #, 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: lisp #: doc/guix.texi:11283 #, no-wrap msgid "@result{} (\"/gnu/store/rwm@dots{}-README\" \"/gnu/store/44i@dots{}-LEGU-MIN\")\n" msgstr "" #. type: Plain text #: doc/guix.texi:11289 msgid "" "The @code{(guix packages)} module exports the following package-related " "monadic procedures:" msgstr "" #. type: deffn #: doc/guix.texi:11290 #, no-wrap msgid "{Monadic Procedure} package-file @var{package} [@var{file}] @" msgstr "" #. type: deffn #: doc/guix.texi:11298 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:11302 msgid "" "Note that this procedure does @emph{not} build @var{package}. Thus, the " "result might or might not designate an existing file. We recommend not " "using this procedure unless you know what you are doing." msgstr "" #. type: deffn #: doc/guix.texi:11304 #, no-wrap msgid "{Monadic Procedure} package->derivation @var{package} [@var{system}]" msgstr "" #. type: deffnx #: doc/guix.texi:11305 #, no-wrap msgid "{Monadic Procedure} package->cross-derivation @var{package} @" msgstr "" #. type: deffn #: doc/guix.texi:11309 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:11315 #, no-wrap msgid "G-expression" msgstr "" #. type: cindex #: doc/guix.texi:11316 #, no-wrap msgid "build code quoting" msgstr "" #. type: Plain text #: doc/guix.texi:11322 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:11325 #, no-wrap msgid "strata of code" msgstr "" #. type: Plain text #: doc/guix.texi:11337 msgid "" "It should come as no surprise that we like to write these build actions in " "Scheme. When we do that, we end up with two @dfn{strata} of Scheme " "code@footnote{The term @dfn{stratum} in this context was coined by Manuel " "Serrano et al.@: in the context of their work on Hop. Oleg Kiselyov, who " "has written insightful @url{http://okmij.org/ftp/meta-programming/#meta-" "scheme, essays and code on this topic}, refers to this kind of code " "generation as @dfn{staging}.}: the ``host code''---code that defines " "packages, talks to the daemon, etc.---and the ``build code''---code that " "actually performs build actions, such as making directories, invoking " "@command{make}, and so on (@pxref{Build Phases})." msgstr "" #. type: Plain text #: doc/guix.texi:11344 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:11353 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:11358 msgid "" "Gexps are meant to be written to a file and run or manipulated by other " "processes." msgstr "" #. type: itemize #: doc/guix.texi:11363 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:11368 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:11370 doc/guix.texi:11926 #, no-wrap msgid "lowering, of high-level objects in gexps" msgstr "" #. type: Plain text #: doc/guix.texi:11380 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:11382 msgid "To illustrate the idea, here is an example of a gexp:" msgstr "" #. type: lisp #: doc/guix.texi:11390 #, 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:11395 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: lisp #: doc/guix.texi:11398 #, no-wrap msgid "(gexp->derivation \"the-thing\" build-exp)\n" msgstr "" #. type: Plain text #: doc/guix.texi:11406 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:11407 #, no-wrap msgid "cross compilation" msgstr "" #. type: Plain text #: doc/guix.texi:11413 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: lisp #: doc/guix.texi:11424 #, no-wrap msgid "" "(gexp->derivation \"vi\"\n" " #~(begin\n" " (mkdir #$output)\n" " (mkdir (string-append #$output \"/bin\"))\n" " (system* (string-append #+coreutils \"/bin/ln\")\n" " \"-s\"\n" " (string-append #$emacs \"/bin/emacs\")\n" " (string-append #$output \"/bin/vi\")))\n" " #:target \"aarch64-linux-gnu\")\n" msgstr "" #. type: Plain text #: doc/guix.texi:11430 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:11431 #, no-wrap msgid "imported modules, for gexps" msgstr "" #. type: findex #: doc/guix.texi:11432 #, no-wrap msgid "with-imported-modules" msgstr "" #. type: Plain text #: doc/guix.texi:11437 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: lisp #: doc/guix.texi:11448 #, 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:11454 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:11455 #, no-wrap msgid "module closure" msgstr "" #. type: findex #: doc/guix.texi:11456 #, no-wrap msgid "source-module-closure" msgstr "" #. type: Plain text #: doc/guix.texi:11463 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: lisp #: doc/guix.texi:11466 #, no-wrap msgid "" "(use-modules (guix modules)) ;for 'source-module-closure'\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:11475 #, no-wrap msgid "" "(with-imported-modules (source-module-closure\n" " '((guix build utils)\n" " (gnu build image)))\n" " (gexp->derivation \"something-with-vms\"\n" " #~(begin\n" " (use-modules (guix build utils)\n" " (gnu build image))\n" " @dots{})))\n" msgstr "" #. type: cindex #: doc/guix.texi:11477 #, no-wrap msgid "extensions, for gexps" msgstr "" #. type: findex #: doc/guix.texi:11478 #, no-wrap msgid "with-extensions" msgstr "" #. type: Plain text #: doc/guix.texi:11483 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: lisp #: doc/guix.texi:11486 #, no-wrap msgid "" "(use-modules (gnu packages guile)) ;for 'guile-json'\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:11492 #, 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:11495 msgid "The syntactic form to construct gexps is summarized below." msgstr "" #. type: deffn #: doc/guix.texi:11496 #, no-wrap msgid "{Scheme Syntax} #~@var{exp}" msgstr "" #. type: deffnx #: doc/guix.texi:11497 #, no-wrap msgid "{Scheme Syntax} (gexp @var{exp})" msgstr "" #. type: deffn #: doc/guix.texi:11500 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:11502 #, no-wrap msgid "#$@var{obj}" msgstr "" #. type: itemx #: doc/guix.texi:11503 #, no-wrap msgid "(ungexp @var{obj})" msgstr "" #. type: table #: doc/guix.texi:11508 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:11511 msgid "" "If @var{obj} is a list, it is traversed and references to supported objects " "are substituted similarly." msgstr "" #. type: table #: doc/guix.texi:11514 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:11516 msgid "If @var{obj} is another kind of object, it is inserted as is." msgstr "" #. type: item #: doc/guix.texi:11517 #, no-wrap msgid "#$@var{obj}:@var{output}" msgstr "" #. type: itemx #: doc/guix.texi:11518 #, no-wrap msgid "(ungexp @var{obj} @var{output})" msgstr "" #. type: table #: doc/guix.texi:11522 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:11523 #, no-wrap msgid "#+@var{obj}" msgstr "" #. type: itemx #: doc/guix.texi:11524 #, no-wrap msgid "#+@var{obj}:output" msgstr "" #. type: itemx #: doc/guix.texi:11525 #, no-wrap msgid "(ungexp-native @var{obj})" msgstr "" #. type: itemx #: doc/guix.texi:11526 #, no-wrap msgid "(ungexp-native @var{obj} @var{output})" msgstr "" #. type: table #: doc/guix.texi:11529 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:11530 #, no-wrap msgid "#$output[:@var{output}]" msgstr "" #. type: itemx #: doc/guix.texi:11531 #, no-wrap msgid "(ungexp output [@var{output}])" msgstr "" #. type: table #: doc/guix.texi:11534 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:11536 msgid "This only makes sense for gexps passed to @code{gexp->derivation}." msgstr "" #. type: item #: doc/guix.texi:11537 #, no-wrap msgid "#$@@@var{lst}" msgstr "" #. type: itemx #: doc/guix.texi:11538 #, no-wrap msgid "(ungexp-splicing @var{lst})" msgstr "" #. type: table #: doc/guix.texi:11541 msgid "" "Like the above, but splices the contents of @var{lst} inside the containing " "list." msgstr "" #. type: item #: doc/guix.texi:11542 #, no-wrap msgid "#+@@@var{lst}" msgstr "" #. type: itemx #: doc/guix.texi:11543 #, no-wrap msgid "(ungexp-native-splicing @var{lst})" msgstr "" #. type: table #: doc/guix.texi:11546 msgid "" "Like the above, but refers to native builds of the objects listed in " "@var{lst}." msgstr "" #. type: deffn #: doc/guix.texi:11551 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:11553 #, no-wrap msgid "{Scheme Syntax} with-imported-modules @var{modules} @var{body}@dots{}" msgstr "" #. type: deffn #: doc/guix.texi:11556 msgid "" "Mark the gexps defined in @var{body}@dots{} as requiring @var{modules} in " "their execution environment." msgstr "" #. type: deffn #: doc/guix.texi:11560 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: lisp #: doc/guix.texi:11566 #, 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:11571 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:11575 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:11577 #, no-wrap msgid "{Scheme Syntax} with-extensions @var{extensions} @var{body}@dots{}" msgstr "" #. type: deffn #: doc/guix.texi:11582 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:11587 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:11589 #, no-wrap msgid "{Scheme Procedure} gexp? @var{obj}" msgstr "" #. type: deffn #: doc/guix.texi:11591 msgid "Return @code{#t} if @var{obj} is a G-expression." msgstr "" #. type: Plain text #: doc/guix.texi:11597 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:11598 #, no-wrap msgid "{Monadic Procedure} gexp->derivation @var{name} @var{exp} @" msgstr "" #. type: deffn #: doc/guix.texi:11616 msgid "" "[#:system (%current-system)] [#:target #f] [#:graft? #t] @ [#:hash #f] [#:" "hash-algo #f] @ [#:recursive? #f] [#:env-vars '()] [#:modules '()] @ [#:" "module-path @code{%load-path}] @ [#:effective-version \"2.2\"] @ [#:" "references-graphs #f] [#:allowed-references #f] @ [#:disallowed-references " "#f] @ [#:leaked-env-vars #f] @ [#:script-name (string-append @var{name} \"-" "builder\")] @ [#:deprecation-warnings #f] @ [#:local-build? #f] [#:" "substitutable? #t] @ [#:properties '()] [#:guile-for-build #f] Return a " "derivation @var{name} that runs @var{exp} (a gexp) with @var{guile-for-" "build} (a derivation) on @var{system}; @var{exp} is stored in a file called " "@var{script-name}. When @var{target} is true, it is used as the cross-" "compilation target triplet for packages referred to by @var{exp}." msgstr "" #. type: deffn #: doc/guix.texi:11624 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:11627 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:11630 msgid "" "@var{graft?} determines whether packages referred to by @var{exp} should be " "grafted when applicable." msgstr "" #. type: deffn #: doc/guix.texi:11633 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:11640 #, 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:11646 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:11652 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:11655 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:11657 msgid "The other arguments are as for @code{derivation} (@pxref{Derivations})." msgstr "" #. type: cindex #: doc/guix.texi:11659 #, no-wrap msgid "file-like objects" msgstr "" #. type: Plain text #: doc/guix.texi:11664 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: lisp #: doc/guix.texi:11668 #, 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:11677 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:11678 #, no-wrap msgid "{Scheme Procedure} local-file @var{file} [@var{name}] @" msgstr "" #. type: deffn #: doc/guix.texi:11687 msgid "" "[#:recursive? #f] [#:select? (const #t)] Return an object representing local " "file @var{file} to add to the store; this object can be used in a gexp. If " "@var{file} is a literal string denoting a relative file name, it is looked " "up relative to the source file where it appears; if @var{file} is not a " "literal string, it is looked up relative to the current working directory at " "run time. @var{file} will be added to the store under @var{name}--by " "default the base name of @var{file}." msgstr "" #. type: deffn #: doc/guix.texi:11699 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:11701 #, no-wrap msgid "{Scheme Procedure} plain-file @var{name} @var{content}" msgstr "" #. type: deffn #: doc/guix.texi:11704 msgid "" "Return an object representing a text file called @var{name} with the given " "@var{content} (a string or a bytevector) to be added to the store." msgstr "" #. type: deffn #: doc/guix.texi:11706 msgid "This is the declarative counterpart of @code{text-file}." msgstr "" #. type: deffn #: doc/guix.texi:11708 #, no-wrap msgid "{Scheme Procedure} computed-file @var{name} @var{gexp} @" msgstr "" #. type: deffn #: doc/guix.texi:11714 msgid "" "[#:local-build? #t] [#:options '()] Return an object representing the store " "item @var{name}, a file or directory computed by @var{gexp}. When " "@var{local-build?} is true (the default), the derivation is built locally. " "@var{options} is a list of additional arguments to pass to @code{gexp-" ">derivation}." msgstr "" #. type: deffn #: doc/guix.texi:11716 msgid "This is the declarative counterpart of @code{gexp->derivation}." msgstr "" #. type: deffn #: doc/guix.texi:11718 #, no-wrap msgid "{Monadic Procedure} gexp->script @var{name} @var{exp} @" msgstr "" #. type: deffn #: doc/guix.texi:11724 msgid "" "[#:guile (default-guile)] [#:module-path %load-path] @ [#:system (%current-" "system)] [#:target #f] Return an executable script @var{name} that runs " "@var{exp} using @var{guile}, with @var{exp}'s imported modules in its search " "path. Look up @var{exp}'s modules in @var{module-path}." msgstr "" #. type: deffn #: doc/guix.texi:11727 msgid "" "The example below builds a script that simply invokes the @command{ls} " "command:" msgstr "" #. type: lisp #: doc/guix.texi:11730 #, no-wrap msgid "" "(use-modules (guix gexp) (gnu packages base))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:11734 #, no-wrap msgid "" "(gexp->script \"list-files\"\n" " #~(execl #$(file-append coreutils \"/bin/ls\")\n" " \"ls\"))\n" msgstr "" #. type: deffn #: doc/guix.texi:11739 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:11744 #, 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:11747 #, no-wrap msgid "{Scheme Procedure} program-file @var{name} @var{exp} @" msgstr "" #. type: deffn #: doc/guix.texi:11752 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:11754 msgid "This is the declarative counterpart of @code{gexp->script}." msgstr "" #. type: deffn #: doc/guix.texi:11756 #, no-wrap msgid "{Monadic Procedure} gexp->file @var{name} @var{exp} @" msgstr "" #. type: deffn #: doc/guix.texi:11763 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:11768 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:11771 msgid "" "The resulting file holds references to all the dependencies of @var{exp} or " "a subset thereof." msgstr "" #. type: deffn #: doc/guix.texi:11773 #, no-wrap msgid "{Scheme Procedure} scheme-file @var{name} @var{exp} @" msgstr "" #. type: deffn #: doc/guix.texi:11777 msgid "" "[#:splice? #f] [#:set-load-path? #t] Return an object representing the " "Scheme file @var{name} that contains @var{exp}." msgstr "" #. type: deffn #: doc/guix.texi:11779 msgid "This is the declarative counterpart of @code{gexp->file}." msgstr "" #. type: deffn #: doc/guix.texi:11781 #, no-wrap msgid "{Monadic Procedure} text-file* @var{name} @var{text} @dots{}" msgstr "" #. type: deffn #: doc/guix.texi:11787 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:11792 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: lisp #: doc/guix.texi:11800 #, 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:11805 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:11807 #, no-wrap msgid "{Scheme Procedure} mixed-text-file @var{name} @var{text} @dots{}" msgstr "" #. type: deffn #: doc/guix.texi:11811 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: lisp #: doc/guix.texi:11815 #, no-wrap msgid "" "(mixed-text-file \"profile\"\n" " \"export PATH=\" coreutils \"/bin:\" grep \"/bin\")\n" msgstr "" #. type: deffn #: doc/guix.texi:11818 msgid "This is the declarative counterpart of @code{text-file*}." msgstr "" #. type: deffn #: doc/guix.texi:11820 #, no-wrap msgid "{Scheme Procedure} file-union @var{name} @var{files}" msgstr "" #. type: deffn #: doc/guix.texi:11825 msgid "" "Return a @code{} 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: lisp #: doc/guix.texi:11832 #, 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=auto'\"))))\n" msgstr "" #. type: deffn #: doc/guix.texi:11835 msgid "This yields an @code{etc} directory containing these two files." msgstr "" #. type: deffn #: doc/guix.texi:11837 #, no-wrap msgid "{Scheme Procedure} directory-union @var{name} @var{things}" msgstr "" #. type: deffn #: doc/guix.texi:11840 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: lisp #: doc/guix.texi:11843 #, no-wrap msgid "(directory-union \"guile+emacs\" (list guile emacs))\n" msgstr "" #. type: deffn #: doc/guix.texi:11846 msgid "" "yields a directory that is the union of the @code{guile} and @code{emacs} " "packages." msgstr "" #. type: deffn #: doc/guix.texi:11848 #, no-wrap msgid "{Scheme Procedure} file-append @var{obj} @var{suffix} @dots{}" msgstr "" #. type: deffn #: doc/guix.texi:11852 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:11854 msgid "As an example, consider this gexp:" msgstr "" #. type: lisp #: doc/guix.texi:11859 #, no-wrap msgid "" "(gexp->script \"run-uname\"\n" " #~(system* #$(file-append coreutils\n" " \"/bin/uname\")))\n" msgstr "" #. type: deffn #: doc/guix.texi:11862 msgid "The same effect could be achieved with:" msgstr "" #. type: lisp #: doc/guix.texi:11867 #, no-wrap msgid "" "(gexp->script \"run-uname\"\n" " #~(system* (string-append #$coreutils\n" " \"/bin/uname\")))\n" msgstr "" #. type: deffn #: doc/guix.texi:11873 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: deffn #: doc/guix.texi:11875 #, no-wrap msgid "{Scheme Syntax} let-system @var{system} @var{body}@dots{}" msgstr "" #. type: deffnx #: doc/guix.texi:11876 #, no-wrap msgid "{Scheme Syntax} let-system (@var{system} @var{target}) @var{body}@dots{}" msgstr "" #. type: deffn #: doc/guix.texi:11879 msgid "" "Bind @var{system} to the currently targeted system---e.g., @code{\"x86_64-" "linux\"}---within @var{body}." msgstr "" #. type: deffn #: doc/guix.texi:11884 msgid "" "In the second case, additionally bind @var{target} to the current cross-" "compilation target---a GNU triplet such as @code{\"arm-linux-gnueabihf\"}---" "or @code{#f} if we are not cross-compiling." msgstr "" #. type: deffn #: doc/guix.texi:11887 msgid "" "@code{let-system} is useful in the occasional case where the object spliced " "into the gexp depends on the target system, as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:11898 #, no-wrap msgid "" "#~(system*\n" " #+(let-system system\n" " (cond ((string-prefix? \"armhf-\" system)\n" " (file-append qemu \"/bin/qemu-system-arm\"))\n" " ((string-prefix? \"x86_64-\" system)\n" " (file-append qemu \"/bin/qemu-system-x86_64\"))\n" " (else\n" " (error \"dunno!\"))))\n" " \"-net\" \"user\" #$image)\n" msgstr "" #. type: deffn #: doc/guix.texi:11901 #, no-wrap msgid "{Scheme Syntax} with-parameters ((@var{parameter} @var{value}) @dots{}) @var{exp}" msgstr "" #. type: deffn #: doc/guix.texi:11907 msgid "" "This macro is similar to the @code{parameterize} form for dynamically-bound " "@dfn{parameters} (@pxref{Parameters,,, guile, GNU Guile Reference Manual}). " "The key difference is that it takes effect when the file-like object " "returned by @var{exp} is lowered to a derivation or store item." msgstr "" #. type: deffn #: doc/guix.texi:11910 msgid "" "A typical use of @code{with-parameters} is to force the system in effect for " "a given object:" msgstr "" #. type: lisp #: doc/guix.texi:11914 #, no-wrap msgid "" "(with-parameters ((%current-system \"i686-linux\"))\n" " coreutils)\n" msgstr "" #. type: deffn #: doc/guix.texi:11918 msgid "" "The example above returns an object that corresponds to the i686 build of " "Coreutils, regardless of the current value of @code{%current-system}." msgstr "" #. type: Plain text #: doc/guix.texi:11925 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:11931 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:11932 #, no-wrap msgid "{Monadic Procedure} lower-object @var{obj} [@var{system}] @" msgstr "" #. type: deffn #: doc/guix.texi:11938 msgid "" "[#:target #f] Return as a value in @code{%store-monad} the derivation or " "store item corresponding to @var{obj} for @var{system}, cross-compiling for " "@var{target} if @var{target} is true. @var{obj} must be an object that has " "an associated gexp compiler, such as a @code{}." msgstr "" #. type: deffn #: doc/guix.texi:11940 #, no-wrap msgid "{Procedure} gexp->approximate-sexp @var{gexp}" msgstr "" #. type: deffn #: doc/guix.texi:11948 msgid "" "Sometimes, it may be useful to convert a G-exp into a S-exp. For example, " "some linters (@pxref{Invoking guix lint}) peek into the build phases of a " "package to detect potential problems. This conversion can be achieved with " "this procedure. However, some information can be lost in the process. More " "specifically, lowerable objects will be silently replaced with some " "arbitrary object -- currently the list @code{(*approximate*)}, but this may " "change." msgstr "" #. type: section #: doc/guix.texi:11951 #, no-wrap msgid "Invoking @command{guix repl}" msgstr "" #. type: command{#1} #: doc/guix.texi:11953 #, no-wrap msgid "guix repl" msgstr "" #. type: cindex #: doc/guix.texi:11954 #, no-wrap msgid "REPL, read-eval-print loop, script" msgstr "" #. type: Plain text #: doc/guix.texi:11964 msgid "" "The @command{guix repl} command makes it easier to program Guix in Guile by " "launching a Guile @dfn{read-eval-print loop} (REPL) for interactive " "programming (@pxref{Using Guile Interactively,,, guile, GNU Guile Reference " "Manual}), or by running Guile scripts (@pxref{Running Guile Scripts,,, " "guile, GNU Guile Reference Manual}). Compared to just launching the " "@command{guile} command, @command{guix repl} guarantees that all the Guix " "modules and all its dependencies are available in the search path." msgstr "" #. type: example #: doc/guix.texi:11969 #, no-wrap msgid "guix repl @var{options} [@var{file} @var{args}]\n" msgstr "" #. type: Plain text #: doc/guix.texi:11973 msgid "" "When a @var{file} argument is provided, @var{file} is executed as a Guile " "scripts:" msgstr "" #. type: example #: doc/guix.texi:11976 #, no-wrap msgid "guix repl my-script.scm\n" msgstr "" #. type: Plain text #: doc/guix.texi:11980 msgid "" "To pass arguments to the script, use @code{--} to prevent them from being " "interpreted as arguments to @command{guix repl} itself:" msgstr "" #. type: example #: doc/guix.texi:11983 #, no-wrap msgid "guix repl -- my-script.scm --input=foo.txt\n" msgstr "" #. type: Plain text #: doc/guix.texi:11988 msgid "" "To make a script executable directly from the shell, using the guix " "executable that is on the user's search path, add the following two lines at " "the top of the script:" msgstr "" #. type: example #: doc/guix.texi:11992 #, no-wrap msgid "" "@code{#!/usr/bin/env -S guix repl --}\n" "@code{!#}\n" msgstr "" #. type: Plain text #: doc/guix.texi:11996 msgid "" "Without a file name argument, a Guile REPL is started, allowing for " "interactive use (@pxref{Using Guix Interactively}):" msgstr "" #. type: example #: doc/guix.texi:12002 #, no-wrap msgid "" "$ guix repl\n" "scheme@@(guile-user)> ,use (gnu packages base)\n" "scheme@@(guile-user)> coreutils\n" "$1 = #\n" msgstr "" #. type: Plain text #: doc/guix.texi:12009 msgid "" "In addition, @command{guix repl} implements a simple machine-readable REPL " "protocol for use by @code{(guix inferior)}, a facility to interact with " "@dfn{inferiors}, separate processes running a potentially different revision " "of Guix." msgstr "" #. type: Plain text #: doc/guix.texi:12011 msgid "The available options are as follows:" msgstr "" #. type: item #: doc/guix.texi:12013 doc/guix.texi:14966 #, no-wrap msgid "--type=@var{type}" msgstr "" #. type: itemx #: doc/guix.texi:12014 doc/guix.texi:14967 doc/guix.texi:38780 #, no-wrap msgid "-t @var{type}" msgstr "" #. type: table #: doc/guix.texi:12016 msgid "" "Start a REPL of the given @var{TYPE}, which can be one of the following:" msgstr "" #. type: item #: doc/guix.texi:12018 #, no-wrap msgid "guile" msgstr "" #. type: table #: doc/guix.texi:12020 msgid "This is default, and it spawns a standard full-featured Guile REPL." msgstr "" #. type: item #: doc/guix.texi:12020 #, no-wrap msgid "machine" msgstr "" #. type: table #: doc/guix.texi:12023 msgid "" "Spawn a REPL that uses the machine-readable protocol. This is the protocol " "that the @code{(guix inferior)} module speaks." msgstr "" #. type: table #: doc/guix.texi:12029 msgid "" "By default, @command{guix repl} reads from standard input and writes to " "standard output. When this option is passed, it will instead listen for " "connections on @var{endpoint}. Here are examples of valid options:" msgstr "" #. type: item #: doc/guix.texi:12031 #, no-wrap msgid "--listen=tcp:37146" msgstr "" #. type: table #: doc/guix.texi:12033 msgid "Accept connections on localhost on port 37146." msgstr "" #. type: item #: doc/guix.texi:12034 #, no-wrap msgid "--listen=unix:/tmp/socket" msgstr "" #. type: table #: doc/guix.texi:12036 msgid "Accept connections on the Unix-domain socket @file{/tmp/socket}." msgstr "" #. type: item #: doc/guix.texi:12038 doc/guix.texi:12269 doc/guix.texi:14234 #: doc/guix.texi:14384 doc/guix.texi:14601 doc/guix.texi:14746 #: doc/guix.texi:15014 #, no-wrap msgid "--load-path=@var{directory}" msgstr "" #. type: itemx #: doc/guix.texi:12039 doc/guix.texi:12270 doc/guix.texi:14235 #: doc/guix.texi:14385 doc/guix.texi:14602 doc/guix.texi:14747 #: doc/guix.texi:15015 #, no-wrap msgid "-L @var{directory}" msgstr "" #. type: table #: doc/guix.texi:12042 doc/guix.texi:12273 doc/guix.texi:14238 #: doc/guix.texi:14388 doc/guix.texi:14605 doc/guix.texi:14750 #: doc/guix.texi:15018 msgid "" "Add @var{directory} to the front of the package module search path " "(@pxref{Package Modules})." msgstr "" #. type: table #: doc/guix.texi:12045 msgid "" "This allows users to define their own packages and make them visible to the " "script or REPL." msgstr "" #. type: itemx #: doc/guix.texi:12046 doc/guix.texi:12795 #, no-wrap msgid "-q" msgstr "" #. type: table #: doc/guix.texi:12049 msgid "" "Inhibit loading of the @file{~/.guile} file. By default, that configuration " "file is loaded when spawning a @code{guile} REPL." msgstr "" #. type: cindex #: doc/guix.texi:12054 #, no-wrap msgid "interactive use" msgstr "" #. type: cindex #: doc/guix.texi:12055 #, no-wrap msgid "REPL, read-eval-print loop" msgstr "" #. type: Plain text #: doc/guix.texi:12061 msgid "" "The @command{guix repl} command gives you access to a warm and friendly " "@dfn{read-eval-print loop} (REPL) (@pxref{Invoking guix repl}). If you're " "getting into Guix programming---defining your own packages, writing " "manifests, defining services for Guix System or Guix Home, etc.---you will " "surely find it convenient to toy with ideas at the REPL." msgstr "" #. type: Plain text #: doc/guix.texi:12067 msgid "" "If you use Emacs, the most convenient way to do that is with Geiser " "(@pxref{The Perfect Setup}), but you do not have to use Emacs to enjoy the " "REPL@. When using @command{guix repl} or @command{guile} in the terminal, " "we recommend using Readline for completion and Colorized to get colorful " "output. To do that, you can run:" msgstr "" #. type: example #: doc/guix.texi:12070 #, no-wrap msgid "guix install guile guile-readline guile-colorized\n" msgstr "" #. type: Plain text #: doc/guix.texi:12075 msgid "" "... and then create a @file{.guile} file in your home directory containing " "this:" msgstr "" #. type: lisp #: doc/guix.texi:12078 #, no-wrap msgid "" "(use-modules (ice-9 readline) (ice-9 colorized))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:12081 #, no-wrap msgid "" "(activate-readline)\n" "(activate-colorized)\n" msgstr "" #. type: Plain text #: doc/guix.texi:12085 msgid "" "The REPL lets you evaluate Scheme code; you type a Scheme expression at the " "prompt, and the REPL prints what it evaluates to:" msgstr "" #. type: example #: doc/guix.texi:12092 #, no-wrap msgid "" "$ guix repl\n" "scheme@@(guix-user)> (+ 2 3)\n" "$1 = 5\n" "scheme@@(guix-user)> (string-append \"a\" \"b\")\n" "$2 = \"ab\"\n" msgstr "" #. type: Plain text #: doc/guix.texi:12103 msgid "" "It becomes interesting when you start fiddling with Guix at the REPL. The " "first thing you'll want to do is to ``import'' the @code{(guix)} module, " "which gives access to the main part of the programming interface, and " "perhaps a bunch of useful Guix modules. You could type @code{(use-modules " "(guix))}, which is valid Scheme code to import a module (@pxref{Using Guile " "Modules,,, guile, GNU Guile Reference Manual}), but the REPL provides the " "@code{use} @dfn{command} as a shorthand notation (@pxref{REPL Commands,,, " "guile, GNU Guile Reference Manual}):" msgstr "" #. type: example #: doc/guix.texi:12107 #, no-wrap msgid "" "scheme@@(guix-user)> ,use (guix)\n" "scheme@@(guix-user)> ,use (gnu packages base)\n" msgstr "" #. type: Plain text #: doc/guix.texi:12112 msgid "" "Notice that REPL commands are introduced by a leading comma. A REPL command " "like @code{use} is not valid Scheme code; it's interpreted specially by the " "REPL." msgstr "" #. type: Plain text #: doc/guix.texi:12121 msgid "" "Guix extends the Guile REPL with additional commands for convenience. Among " "those, the @code{build} command comes in handy: it ensures that the given " "file-like object is built, building it if needed, and returns its output " "file name(s). In the example below, we build the @code{coreutils} and " "@code{grep} packages, as well as a ``computed file'' (@pxref{G-Expressions, " "@code{computed-file}}), and we use the @code{scandir} procedure to list the " "files in Grep's @code{/bin} directory:" msgstr "" #. type: example #: doc/guix.texi:12134 #, no-wrap msgid "" "scheme@@(guix-user)> ,build coreutils\n" "$1 = \"/gnu/store/@dots{}-coreutils-8.32-debug\"\n" "$2 = \"/gnu/store/@dots{}-coreutils-8.32\"\n" "scheme@@(guix-user)> ,build grep\n" "$3 = \"/gnu/store/@dots{}-grep-3.6\"\n" "scheme@@(guix-user)> ,build (computed-file \"x\" #~(mkdir #$output))\n" "building /gnu/store/@dots{}-x.drv...\n" "$4 = \"/gnu/store/@dots{}-x\"\n" "scheme@@(guix-user)> ,use(ice-9 ftw)\n" "scheme@@(guix-user)> (scandir (string-append $3 \"/bin\"))\n" "$5 = (\".\" \"..\" \"egrep\" \"fgrep\" \"grep\")\n" msgstr "" #. type: Plain text #: doc/guix.texi:12139 msgid "" "At a lower-level, a useful command is @code{lower}: it takes a file-like " "object and ``lowers'' it into a derivation (@pxref{Derivations}) or a store " "file:" msgstr "" #. type: example #: doc/guix.texi:12145 #, no-wrap msgid "" "scheme@@(guix-user)> ,lower grep\n" "$6 = # /gnu/store/@dots{}-grep-3.6 7f0e639115f0>\n" "scheme@@(guix-user)> ,lower (plain-file \"x\" \"Hello!\")\n" "$7 = \"/gnu/store/@dots{}-x\"\n" msgstr "" #. type: Plain text #: doc/guix.texi:12149 msgid "" "The full list of REPL commands can be seen by typing @code{,help guix} and " "is given below for reference." msgstr "" #. type: deffn #: doc/guix.texi:12150 #, no-wrap msgid "{REPL command} build @var{object}" msgstr "" #. type: deffn #: doc/guix.texi:12153 msgid "" "Lower @var{object} and build it if it's not already built, returning its " "output file name(s)." msgstr "" #. type: deffn #: doc/guix.texi:12155 #, no-wrap msgid "{REPL command} lower @var{object}" msgstr "" #. type: deffn #: doc/guix.texi:12157 msgid "Lower @var{object} into a derivation or store file name and return it." msgstr "" #. type: deffn #: doc/guix.texi:12159 #, no-wrap msgid "{REPL command} verbosity @var{level}" msgstr "" #. type: deffn #: doc/guix.texi:12161 msgid "Change build verbosity to @var{level}." msgstr "" #. type: deffn #: doc/guix.texi:12165 msgid "" "This is similar to the @option{--verbosity} command-line option " "(@pxref{Common Build Options}): level 0 means total silence, level 1 shows " "build events only, and higher levels print build logs." msgstr "" #. type: deffn #: doc/guix.texi:12167 #, no-wrap msgid "{REPL command} run-in-store @var{exp}" msgstr "" #. type: deffn #: doc/guix.texi:12170 msgid "" "Run @var{exp}, a monadic expresssion, through the store monad. @xref{The " "Store Monad}, for more information." msgstr "" #. type: deffn #: doc/guix.texi:12172 #, no-wrap msgid "{REPL command} enter-store-monad" msgstr "" #. type: deffn #: doc/guix.texi:12175 msgid "" "Enter a new REPL to evaluate monadic expressions (@pxref{The Store Monad}). " "You can quit this ``inner'' REPL by typing @code{,q}." msgstr "" #. type: Plain text #: doc/guix.texi:12185 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:12208 #, no-wrap msgid "package building" msgstr "" #. type: command{#1} #: doc/guix.texi:12209 #, no-wrap msgid "guix build" msgstr "" #. type: Plain text #: doc/guix.texi:12215 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: example #: doc/guix.texi:12220 #, no-wrap msgid "guix build @var{options} @var{package-or-derivation}@dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:12225 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:12228 #, no-wrap msgid "guix build emacs guile\n" msgstr "" #. type: Plain text #: doc/guix.texi:12231 msgid "Similarly, the following command builds all the available packages:" msgstr "" #. type: example #: doc/guix.texi:12235 #, no-wrap msgid "" "guix build --quiet --keep-going \\\n" " $(guix package -A | awk '@{ print $1 \"@@\" $2 @}')\n" msgstr "" #. type: Plain text #: doc/guix.texi:12243 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:12248 msgid "" "Alternatively, the @option{--expression} option may be used to specify a " "Scheme expression that evaluates to a package; this is useful when " "disambiguating among several same-named packages or package variants is " "needed." msgstr "" #. type: Plain text #: doc/guix.texi:12251 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:12266 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: table #: doc/guix.texi:12276 doc/guix.texi:14241 doc/guix.texi:14608 #: doc/guix.texi:14753 doc/guix.texi:15021 msgid "" "This allows users to define their own packages and make them visible to the " "command-line tools." msgstr "" #. type: item #: doc/guix.texi:12277 #, no-wrap msgid "--keep-failed" msgstr "" #. type: itemx #: doc/guix.texi:12278 #, no-wrap msgid "-K" msgstr "" #. type: table #: doc/guix.texi:12284 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: table #: doc/guix.texi:12288 msgid "" "This option implies @option{--no-offload}, and it has no effect when " "connecting to a remote daemon with a @code{guix://} URI (@pxref{The Store, " "the @env{GUIX_DAEMON_SOCKET} variable})." msgstr "" #. type: item #: doc/guix.texi:12289 #, no-wrap msgid "--keep-going" msgstr "" #. type: itemx #: doc/guix.texi:12290 #, no-wrap msgid "-k" msgstr "" #. type: table #: doc/guix.texi:12293 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:12296 msgid "" "The default behavior is to stop as soon as one of the specified derivations " "has failed." msgstr "" #. type: table #: doc/guix.texi:12300 msgid "Do not build the derivations." msgstr "" #. type: anchor{#1} #: doc/guix.texi:12302 msgid "fallback-option" msgstr "" #. type: item #: doc/guix.texi:12302 #, no-wrap msgid "--fallback" msgstr "" #. type: table #: doc/guix.texi:12305 msgid "" "When substituting a pre-built binary fails, fall back to building packages " "locally (@pxref{Substitution Failure})." msgstr "" #. type: anchor{#1} #: doc/guix.texi:12311 msgid "client-substitute-urls" msgstr "" #. type: table #: doc/guix.texi:12311 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:12315 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:12318 msgid "" "When @var{urls} is the empty string, substitutes are effectively disabled." msgstr "" #. type: item #: doc/guix.texi:12324 #, no-wrap msgid "--no-grafts" msgstr "" #. type: table #: doc/guix.texi:12328 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:12329 #, no-wrap msgid "--rounds=@var{n}" msgstr "" #. type: table #: doc/guix.texi:12332 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:12337 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:12353 msgid "" "By default, the daemon's setting is honored (@pxref{Invoking guix-daemon, " "@option{--max-silent-time}})." msgstr "" #. type: table #: doc/guix.texi:12360 msgid "" "By default, the daemon's setting is honored (@pxref{Invoking guix-daemon, " "@option{--timeout}})." msgstr "" #. type: cindex #: doc/guix.texi:12363 #, no-wrap msgid "verbosity, of the command-line tools" msgstr "" #. type: cindex #: doc/guix.texi:12364 #, no-wrap msgid "build logs, verbosity" msgstr "" #. type: item #: doc/guix.texi:12365 #, no-wrap msgid "-v @var{level}" msgstr "" #. type: itemx #: doc/guix.texi:12366 #, no-wrap msgid "--verbosity=@var{level}" msgstr "" #. type: table #: doc/guix.texi:12371 msgid "" "Use the given verbosity @var{level}, an integer. Choosing 0 means that no " "output is produced, 1 is for quiet output; 2 is similar to 1 but it " "additionally displays download URLs; 3 shows all the build log output on " "standard error." msgstr "" #. type: table #: doc/guix.texi:12376 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:12382 msgid "" "Allow at most @var{n} build jobs in parallel. @xref{Invoking guix-daemon, " "@option{--max-jobs}}, for details about this option and the equivalent " "@command{guix-daemon} option." msgstr "" #. type: item #: doc/guix.texi:12383 #, no-wrap msgid "--debug=@var{level}" msgstr "" #. type: table #: doc/guix.texi:12387 msgid "" "Produce debugging output coming from the build daemon. @var{level} must be " "an integer between 0 and 5; higher means more verbose output. Setting a " "level of 4 or more may be helpful when debugging setup issues with the build " "daemon." msgstr "" #. type: Plain text #: doc/guix.texi:12394 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:12398 msgid "" "In addition to options explicitly passed on the command line, @command{guix " "build} and other @command{guix} commands that support building honor the " "@env{GUIX_BUILD_OPTIONS} environment variable." msgstr "" #. type: defvr #: doc/guix.texi:12399 #, no-wrap msgid "{Environment Variable} GUIX_BUILD_OPTIONS" msgstr "" #. type: defvr #: doc/guix.texi:12404 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:12407 #, no-wrap msgid "$ export GUIX_BUILD_OPTIONS=\"--no-substitutes -c 2 -L /foo/bar\"\n" msgstr "" #. type: defvr #: doc/guix.texi:12411 msgid "" "These options are parsed independently, and the result is appended to the " "parsed command-line options." msgstr "" #. type: cindex #: doc/guix.texi:12417 #, no-wrap msgid "package variants" msgstr "" #. type: Plain text #: doc/guix.texi:12425 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: Plain text #: doc/guix.texi:12429 msgid "" "Package transformation options are preserved across upgrades: @command{guix " "upgrade} attempts to apply transformation options initially used when " "creating the profile to the upgraded packages." msgstr "" #. type: Plain text #: doc/guix.texi:12434 msgid "" "The available options are listed below. Most commands support them and also " "support a @option{--help-transform} option that lists all the available " "options and a synopsis (these options are not shown in the @option{--help} " "output for brevity)." msgstr "" #. type: cindex #: doc/guix.texi:12437 #, no-wrap msgid "performance, tuning code" msgstr "" #. type: cindex #: doc/guix.texi:12438 #, no-wrap msgid "optimization, of package code" msgstr "" #. type: cindex #: doc/guix.texi:12439 #, no-wrap msgid "tuning, of package code" msgstr "" #. type: cindex #: doc/guix.texi:12440 #, no-wrap msgid "SIMD support" msgstr "" #. type: cindex #: doc/guix.texi:12441 #, no-wrap msgid "tunable packages" msgstr "" #. type: cindex #: doc/guix.texi:12442 #, no-wrap msgid "package multi-versioning" msgstr "" #. type: item #: doc/guix.texi:12443 #, no-wrap msgid "--tune[=@var{cpu}]" msgstr "" #. type: table #: doc/guix.texi:12447 msgid "" "Use versions of the packages marked as ``tunable'' optimized for @var{cpu}. " "When @var{cpu} is @code{native}, or when it is omitted, tune for the CPU on " "which the @command{guix} command is running." msgstr "" #. type: table #: doc/guix.texi:12453 msgid "" "Valid @var{cpu} names are those recognized by the underlying compiler, by " "default the GNU Compiler Collection. On x86_64 processors, this includes " "CPU names such as @code{nehalem}, @code{haswell}, and @code{skylake} " "(@pxref{x86 Options, @code{-march},, gcc, Using the GNU Compiler Collection " "(GCC)})." msgstr "" #. type: table #: doc/guix.texi:12460 msgid "" "As new generations of CPUs come out, they augment the standard instruction " "set architecture (ISA) with additional instructions, in particular " "instructions for single-instruction/multiple-data (SIMD) parallel " "processing. For example, while Core2 and Skylake CPUs both implement the " "x86_64 ISA, only the latter supports AVX2 SIMD instructions." msgstr "" #. type: table #: doc/guix.texi:12467 msgid "" "The primary gain one can expect from @option{--tune} is for programs that " "can make use of those SIMD capabilities @emph{and} that do not already have " "a mechanism to select the right optimized code at run time. Packages that " "have the @code{tunable?} property set are considered @dfn{tunable packages} " "by the @option{--tune} option; a package definition with the property set " "looks like this:" msgstr "" #. type: lisp #: doc/guix.texi:12472 #, no-wrap msgid "" "(package\n" " (name \"hello-simd\")\n" " ;; ...\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:12476 #, no-wrap msgid "" " ;; This package may benefit from SIMD extensions so\n" " ;; mark it as \"tunable\".\n" " (properties '((tunable? . #t))))\n" msgstr "" #. type: table #: doc/guix.texi:12481 msgid "" "Other packages are not considered tunable. This allows Guix to use generic " "binaries in the cases where tuning for a specific CPU is unlikely to provide " "any gain." msgstr "" #. type: table #: doc/guix.texi:12487 msgid "" "Tuned packages are built with @code{-march=@var{CPU}}; under the hood, the " "@option{-march} option is passed to the actual wrapper by a compiler " "wrapper. Since the build machine may not be able to run code for the target " "CPU micro-architecture, the test suite is not run when building a tuned " "package." msgstr "" #. type: table #: doc/guix.texi:12491 msgid "" "To reduce rebuilds to the minimum, tuned packages are @emph{grafted} onto " "packages that depend on them (@pxref{Security Updates, grafts}). Thus, " "using @option{--no-grafts} cancels the effect of @option{--tune}." msgstr "" #. type: table #: doc/guix.texi:12497 msgid "" "We call this technique @dfn{package multi-versioning}: several variants of " "tunable packages may be built, one for each CPU variant. It is the coarse-" "grain counterpart of @dfn{function multi-versioning} as implemented by the " "GNU tool chain (@pxref{Function Multiversioning,,, gcc, Using the GNU " "Compiler Collection (GCC)})." msgstr "" #. type: item #: doc/guix.texi:12498 #, no-wrap msgid "--with-source=@var{source}" msgstr "" #. type: itemx #: doc/guix.texi:12499 #, no-wrap msgid "--with-source=@var{package}=@var{source}" msgstr "" #. type: itemx #: doc/guix.texi:12500 #, no-wrap msgid "--with-source=@var{package}@@@var{version}=@var{source}" msgstr "" #. type: table #: doc/guix.texi:12505 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:12511 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:12514 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:12519 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:12522 #, no-wrap msgid "guix build ed --with-source=mirror://gnu/ed/ed-1.4.tar.gz\n" msgstr "" #. type: table #: doc/guix.texi:12527 msgid "" "As a developer, @option{--with-source} makes it easy to test release " "candidates, and even to test their impact on packages that depend on them:" msgstr "" #. type: example #: doc/guix.texi:12530 #, no-wrap msgid "guix build elogind --with-source=@dots{}/shepherd-0.9.0rc1.tar.gz \n" msgstr "" #. type: table #: doc/guix.texi:12533 msgid "@dots{} or to build from a checkout in a pristine environment:" msgstr "" #. type: example #: doc/guix.texi:12537 #, 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:12539 #, no-wrap msgid "--with-input=@var{package}=@var{replacement}" msgstr "" #. type: table #: doc/guix.texi:12544 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:12548 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:12551 #, no-wrap msgid "guix build --with-input=guile=guile@@2.0 guix\n" msgstr "" #. type: table #: doc/guix.texi:12556 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:12559 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:12560 #, no-wrap msgid "--with-graft=@var{package}=@var{replacement}" msgstr "" #. type: table #: doc/guix.texi:12566 msgid "" "This is similar to @option{--with-input} but with an important difference: " "instead of rebuilding the whole dependency chain, @var{replacement} is built " "and then @dfn{grafted} onto the binaries that were initially referring to " "@var{package}. @xref{Security Updates}, for more information on grafts." msgstr "" #. type: table #: doc/guix.texi:12570 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:12573 #, no-wrap msgid "guix build --with-graft=gnutls=gnutls@@3.5.4 wget\n" msgstr "" #. type: table #: doc/guix.texi:12582 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: cindex #: doc/guix.texi:12583 doc/guix.texi:42706 #, no-wrap msgid "debugging info, rebuilding" msgstr "" #. type: item #: doc/guix.texi:12584 #, no-wrap msgid "--with-debug-info=@var{package}" msgstr "" #. type: table #: doc/guix.texi:12589 msgid "" "Build @var{package} in a way that preserves its debugging info and graft it " "onto packages that depend on it. This is useful if @var{package} does not " "already provide debugging info as a @code{debug} output (@pxref{Installing " "Debugging Files})." msgstr "" #. type: table #: doc/guix.texi:12595 msgid "" "For example, suppose you're experiencing a crash in Inkscape and would like " "to see what's up in GLib, a library deep down in Inkscape's dependency " "graph. GLib lacks a @code{debug} output, so debugging is tough. " "Fortunately, you rebuild GLib with debugging info and tack it on Inkscape:" msgstr "" #. type: example #: doc/guix.texi:12598 doc/guix.texi:42737 #, no-wrap msgid "guix install inkscape --with-debug-info=glib\n" msgstr "" #. type: table #: doc/guix.texi:12602 msgid "" "Only GLib needs to be recompiled so this takes a reasonable amount of time. " "@xref{Installing Debugging Files}, for more info." msgstr "" #. type: quotation #: doc/guix.texi:12608 msgid "" "Under the hood, this option works by passing the @samp{#:strip-binaries? #f} " "to the build system of the package of interest (@pxref{Build Systems}). " "Most build systems support that option but some do not. In that case, an " "error is raised." msgstr "" #. type: quotation #: doc/guix.texi:12612 msgid "" "Likewise, if a C/C++ package is built without @code{-g} (which is rarely the " "case), debugging info will remain unavailable even when @code{#:strip-" "binaries?} is false." msgstr "" #. type: cindex #: doc/guix.texi:12614 #, no-wrap msgid "tool chain, changing the build tool chain of a package" msgstr "" #. type: item #: doc/guix.texi:12615 #, no-wrap msgid "--with-c-toolchain=@var{package}=@var{toolchain}" msgstr "" #. type: table #: doc/guix.texi:12619 msgid "" "This option changes the compilation of @var{package} and everything that " "depends on it so that they get built with @var{toolchain} instead of the " "default GNU tool chain for C/C++." msgstr "" #. type: example #: doc/guix.texi:12626 #, no-wrap msgid "" "guix build octave-cli \\\n" " --with-c-toolchain=fftw=gcc-toolchain@@10 \\\n" " --with-c-toolchain=fftwf=gcc-toolchain@@10\n" msgstr "" #. type: table #: doc/guix.texi:12633 msgid "" "The command above builds a variant of the @code{fftw} and @code{fftwf} " "packages using version 10 of @code{gcc-toolchain} instead of the default " "tool chain, and then builds a variant of the GNU@tie{}Octave command-line " "interface using them. GNU@tie{}Octave itself is also built with @code{gcc-" "toolchain@@10}." msgstr "" #. type: table #: doc/guix.texi:12637 msgid "" "This other example builds the Hardware Locality (@code{hwloc}) library and " "its dependents up to @code{intel-mpi-benchmarks} with the Clang C compiler:" msgstr "" #. type: example #: doc/guix.texi:12641 #, no-wrap msgid "" "guix build --with-c-toolchain=hwloc=clang-toolchain \\\n" " intel-mpi-benchmarks\n" msgstr "" #. type: quotation #: doc/guix.texi:12650 msgid "" "There can be application binary interface (ABI) incompatibilities among tool " "chains. This is particularly true of the C++ standard library and run-time " "support libraries such as that of OpenMP@. By rebuilding all dependents " "with the same tool chain, @option{--with-c-toolchain} minimizes the risks of " "incompatibility but cannot entirely eliminate them. Choose @var{package} " "wisely." msgstr "" #. type: item #: doc/guix.texi:12652 #, no-wrap msgid "--with-git-url=@var{package}=@var{url}" msgstr "" #. type: cindex #: doc/guix.texi:12653 #, no-wrap msgid "Git, using the latest commit" msgstr "" #. type: cindex #: doc/guix.texi:12654 #, no-wrap msgid "latest commit, building" msgstr "" #. type: table #: doc/guix.texi:12658 msgid "" "Build @var{package} from the latest commit of the @code{master} branch of " "the Git repository at @var{url}. Git sub-modules of the repository are " "fetched, recursively." msgstr "" #. type: table #: doc/guix.texi:12661 msgid "" "For example, the following command builds the NumPy Python library against " "the latest commit of the master branch of Python itself:" msgstr "" #. type: example #: doc/guix.texi:12665 #, no-wrap msgid "" "guix build python-numpy \\\n" " --with-git-url=python=https://github.com/python/cpython\n" msgstr "" #. type: table #: doc/guix.texi:12669 msgid "" "This option can also be combined with @option{--with-branch} or @option{--" "with-commit} (see below)." msgstr "" #. type: cindex #: doc/guix.texi:12670 doc/guix.texi:31939 #, no-wrap msgid "continuous integration" msgstr "" #. type: table #: doc/guix.texi:12676 msgid "" "Obviously, since it uses the latest commit of the given branch, the result " "of such a command varies over time. Nevertheless it is a convenient way to " "rebuild entire software stacks against the latest commit of one or more " "packages. This is particularly useful in the context of continuous " "integration (CI)." msgstr "" #. type: table #: doc/guix.texi:12680 msgid "" "Checkouts are kept in a cache under @file{~/.cache/guix/checkouts} to speed " "up consecutive accesses to the same repository. You may want to clean it up " "once in a while to save disk space." msgstr "" #. type: item #: doc/guix.texi:12681 #, no-wrap msgid "--with-branch=@var{package}=@var{branch}" msgstr "" #. type: table #: doc/guix.texi:12687 msgid "" "Build @var{package} from the latest commit of @var{branch}. If the " "@code{source} field of @var{package} is an origin with the @code{git-fetch} " "method (@pxref{origin Reference}) or a @code{git-checkout} object, the " "repository URL is taken from that @code{source}. Otherwise you have to use " "@option{--with-git-url} to specify the URL of the Git repository." msgstr "" #. type: table #: doc/guix.texi:12692 msgid "" "For instance, the following command builds @code{guile-sqlite3} from the " "latest commit of its @code{master} branch, and then builds @code{guix} " "(which depends on it) and @code{cuirass} (which depends on @code{guix}) " "against this specific @code{guile-sqlite3} build:" msgstr "" #. type: example #: doc/guix.texi:12695 #, no-wrap msgid "guix build --with-branch=guile-sqlite3=master cuirass\n" msgstr "" #. type: item #: doc/guix.texi:12697 #, no-wrap msgid "--with-commit=@var{package}=@var{commit}" msgstr "" #. type: table #: doc/guix.texi:12702 msgid "" "This is similar to @option{--with-branch}, except that it builds from " "@var{commit} rather than the tip of a branch. @var{commit} must be a valid " "Git commit SHA1 identifier, a tag, or a @command{git describe} style " "identifier such as @code{1.0-3-gabc123}." msgstr "" #. type: item #: doc/guix.texi:12703 #, no-wrap msgid "--with-patch=@var{package}=@var{file}" msgstr "" #. type: table #: doc/guix.texi:12710 msgid "" "Add @var{file} to the list of patches applied to @var{package}, where " "@var{package} is a spec such as @code{python@@3.8} or @code{glibc}. " "@var{file} must contain a patch; it is applied with the flags specified in " "the @code{origin} of @var{package} (@pxref{origin Reference}), which by " "default includes @code{-p1} (@pxref{patch Directories,,, diffutils, " "Comparing and Merging Files})." msgstr "" #. type: table #: doc/guix.texi:12713 msgid "" "As an example, the command below rebuilds Coreutils with the GNU C Library " "(glibc) patched with the given patch:" msgstr "" #. type: example #: doc/guix.texi:12716 #, no-wrap msgid "guix build coreutils --with-patch=glibc=./glibc-frob.patch\n" msgstr "" #. type: table #: doc/guix.texi:12720 msgid "" "In this example, glibc itself as well as everything that leads to Coreutils " "in the dependency graph is rebuilt." msgstr "" #. type: cindex #: doc/guix.texi:12721 #, no-wrap msgid "upstream, latest version" msgstr "" #. type: item #: doc/guix.texi:12722 #, no-wrap msgid "--with-latest=@var{package}" msgstr "" #. type: table #: doc/guix.texi:12727 msgid "" "So you like living on the bleeding edge? This option is for you! It replaces " "occurrences of @var{package} in the dependency graph with its latest " "upstream version, as reported by @command{guix refresh} (@pxref{Invoking " "guix refresh})." msgstr "" #. type: table #: doc/guix.texi:12731 msgid "" "It does so by determining the latest upstream release of @var{package} (if " "possible), downloading it, and authenticating it @emph{if} it comes with an " "OpenPGP signature." msgstr "" #. type: table #: doc/guix.texi:12734 msgid "" "As an example, the command below builds Guix against the latest version of " "Guile-JSON:" msgstr "" #. type: example #: doc/guix.texi:12737 #, no-wrap msgid "guix build guix --with-latest=guile-json\n" msgstr "" #. type: table #: doc/guix.texi:12746 msgid "" "There are limitations. First, in cases where the tool cannot or does not " "know how to authenticate source code, you are at risk of running malicious " "code; a warning is emitted in this case. Second, this option simply changes " "the source used in the existing package definitions, which is not always " "sufficient: there might be additional dependencies that need to be added, " "patches to apply, and more generally the quality assurance work that Guix " "developers normally do will be missing." msgstr "" #. type: table #: doc/guix.texi:12751 msgid "" "You've been warned! In all the other cases, it's a snappy way to stay on " "top. We encourage you to submit patches updating the actual package " "definitions once you have successfully tested an upgrade " "(@pxref{Contributing})." msgstr "" #. type: cindex #: doc/guix.texi:12752 #, no-wrap msgid "test suite, skipping" msgstr "" #. type: item #: doc/guix.texi:12753 #, no-wrap msgid "--without-tests=@var{package}" msgstr "" #. type: table #: doc/guix.texi:12759 msgid "" "Build @var{package} without running its tests. This can be useful in " "situations where you want to skip the lengthy test suite of a intermediate " "package, or if a package's test suite fails in a non-deterministic fashion. " "It should be used with care because running the test suite is a good way to " "ensure a package is working as intended." msgstr "" #. type: table #: doc/guix.texi:12763 msgid "" "Turning off tests leads to a different store item. Consequently, when using " "this option, anything that depends on @var{package} must be rebuilt, as in " "this example:" msgstr "" #. type: example #: doc/guix.texi:12766 #, no-wrap msgid "guix install --without-tests=python python-notebook\n" msgstr "" #. type: table #: doc/guix.texi:12772 msgid "" "The command above installs @code{python-notebook} on top of @code{python} " "built without running its test suite. To do so, it also rebuilds everything " "that depends on @code{python}, including @code{python-notebook} itself." msgstr "" #. type: table #: doc/guix.texi:12778 msgid "" "Internally, @option{--without-tests} relies on changing the @code{#:tests?} " "option of a package's @code{check} phase (@pxref{Build Systems}). Note that " "some packages use a customized @code{check} phase that does not respect a " "@code{#:tests? #f} setting. Therefore, @option{--without-tests} has no " "effect on these packages." msgstr "" #. type: Plain text #: doc/guix.texi:12785 msgid "" "Wondering how to achieve the same effect using Scheme code, for example in " "your manifest, or how to write your own package transformation? " "@xref{Defining Package Variants}, for an overview of the programming " "interfaces available." msgstr "" #. type: Plain text #: doc/guix.texi:12791 msgid "" "The command-line options presented below are specific to @command{guix " "build}." msgstr "" #. type: item #: doc/guix.texi:12794 #, no-wrap msgid "--quiet" msgstr "" #. type: table #: doc/guix.texi:12799 msgid "" "Build quietly, without displaying the build log; this is equivalent to " "@option{--verbosity=0}. Upon completion, the build log is kept in @file{/" "var} (or similar) and can always be retrieved using the @option{--log-file} " "option." msgstr "" #. type: table #: doc/guix.texi:12804 msgid "" "Build the package, derivation, or other file-like object that the code " "within @var{file} evaluates to (@pxref{G-Expressions, file-like objects})." msgstr "" #. type: table #: doc/guix.texi:12807 msgid "" "As an example, @var{file} might contain a package definition like this " "(@pxref{Defining Packages}):" msgstr "" #. type: table #: doc/guix.texi:12816 msgid "" "The @var{file} may also contain a JSON representation of one or more package " "definitions. Running @code{guix build -f} on @file{hello.json} with the " "following contents would result in building the packages @code{myhello} and " "@code{greeter}:" msgstr "" #. type: item #: doc/guix.texi:12821 #, no-wrap msgid "--manifest=@var{manifest}" msgstr "" #. type: itemx #: doc/guix.texi:12822 #, no-wrap msgid "-m @var{manifest}" msgstr "" #. type: table #: doc/guix.texi:12825 msgid "" "Build all packages listed in the given @var{manifest} (@pxref{profile-" "manifest, @option{--manifest}})." msgstr "" #. type: table #: doc/guix.texi:12829 msgid "Build the package or derivation @var{expr} evaluates to." msgstr "" #. type: table #: doc/guix.texi:12833 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:12837 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:12841 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:12842 #, no-wrap msgid "--source" msgstr "" #. type: itemx #: doc/guix.texi:12843 #, no-wrap msgid "-S" msgstr "" #. type: table #: doc/guix.texi:12846 msgid "" "Build the source derivations of the packages, rather than the packages " "themselves." msgstr "" #. type: table #: doc/guix.texi:12850 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:12854 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: cindex #: doc/guix.texi:12855 #, no-wrap msgid "source, verification" msgstr "" #. type: table #: doc/guix.texi:12861 msgid "" "As with other derivations, the result of building a source derivation can be " "verified using the @option{--check} option (@pxref{build-check}). This is " "useful to validate that a (potentially already built or substituted, thus " "cached) package source matches against its declared hash." msgstr "" #. type: table #: doc/guix.texi:12866 msgid "" "Note that @command{guix build -S} compiles the sources only of the specified " "packages. They do not include the sources of statically linked dependencies " "and by themselves are insufficient for reproducing the packages." msgstr "" #. type: item #: doc/guix.texi:12867 #, no-wrap msgid "--sources" msgstr "" #. type: table #: doc/guix.texi:12874 msgid "" "Fetch and return the source of @var{package-or-derivation} and all their " "dependencies, recursively. This is a handy way to obtain a local copy of " "all the source code needed to build @var{packages}, allowing you to " "eventually build them even without network access. It is an extension of " "the @option{--source} option and can accept one of the following optional " "argument values:" msgstr "" #. type: item #: doc/guix.texi:12876 doc/guix.texi:14807 #, no-wrap msgid "package" msgstr "" #. type: table #: doc/guix.texi:12879 msgid "" "This value causes the @option{--sources} option to behave in the same way as " "the @option{--source} option." msgstr "" #. type: item #: doc/guix.texi:12880 doc/guix.texi:22020 #, no-wrap msgid "all" msgstr "" #. type: table #: doc/guix.texi:12883 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:12889 #, 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:12891 #, no-wrap msgid "transitive" msgstr "" #. type: table #: doc/guix.texi:12895 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:12906 #, 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: table #: doc/guix.texi:12916 msgid "" "Attempt to build for @var{system}---e.g., @code{i686-linux}---instead of the " "system type of the build host. The @command{guix build} command allows you " "to repeat this option several times, in which case it builds for all the " "specified systems; other commands ignore extraneous @option{-s} options." msgstr "" #. type: quotation #: doc/guix.texi:12921 msgid "" "The @option{--system} flag is for @emph{native} compilation and must not be " "confused with cross-compilation. See @option{--target} below for " "information on cross-compilation." msgstr "" #. type: table #: doc/guix.texi:12928 msgid "" "An example use of this is on Linux-based systems, which can emulate " "different personalities. For instance, passing @option{--system=i686-linux} " "on an @code{x86_64-linux} system or @option{--system=armhf-linux} on an " "@code{aarch64-linux} system allows you to build packages in a complete 32-" "bit environment." msgstr "" #. type: quotation #: doc/guix.texi:12933 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:12939 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:12943 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: table #: doc/guix.texi:12949 msgid "" "Cross-build for @var{triplet}, which must be a valid GNU triplet, such as " "@code{\"aarch64-linux-gnu\"} (@pxref{Specifying Target Triplets, GNU " "configuration triplets,, autoconf, Autoconf})." msgstr "" #. type: item #: doc/guix.texi:12950 #, no-wrap msgid "--list-systems" msgstr "" #. type: table #: doc/guix.texi:12953 msgid "" "List all the supported systems, that can be passed as an argument to " "@option{--system}." msgstr "" #. type: item #: doc/guix.texi:12954 #, no-wrap msgid "--list-targets" msgstr "" #. type: table #: doc/guix.texi:12957 msgid "" "List all the supported targets, that can be passed as an argument to " "@option{--target}." msgstr "" #. type: anchor{#1} #: doc/guix.texi:12959 msgid "build-check" msgstr "" #. type: cindex #: doc/guix.texi:12960 #, no-wrap msgid "determinism, checking" msgstr "" #. type: cindex #: doc/guix.texi:12961 #, no-wrap msgid "reproducibility, checking" msgstr "" #. type: table #: doc/guix.texi:12965 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:12970 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:12975 #, no-wrap msgid "--repair" msgstr "" #. type: cindex #: doc/guix.texi:12976 #, no-wrap msgid "repairing store items" msgstr "" #. type: table #: doc/guix.texi:12980 msgid "" "Attempt to repair the specified store items, if they are corrupt, by re-" "downloading or rebuilding them." msgstr "" #. type: table #: doc/guix.texi:12982 msgid "This operation is not atomic and thus restricted to @code{root}." msgstr "" #. type: item #: doc/guix.texi:12983 #, no-wrap msgid "--derivations" msgstr "" #. type: table #: doc/guix.texi:12987 msgid "" "Return the derivation paths, not the output paths, of the given packages." msgstr "" #. type: cindex #: doc/guix.texi:12990 #, no-wrap msgid "GC roots, adding" msgstr "" #. type: cindex #: doc/guix.texi:12991 #, no-wrap msgid "garbage collector roots, adding" msgstr "" #. type: table #: doc/guix.texi:12994 doc/guix.texi:38811 msgid "" "Make @var{file} a symlink to the result, and register it as a garbage " "collector root." msgstr "" #. type: table #: doc/guix.texi:13000 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:13001 #, no-wrap msgid "--log-file" msgstr "" #. type: cindex #: doc/guix.texi:13002 #, no-wrap msgid "build logs, access" msgstr "" #. type: table #: doc/guix.texi:13006 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:13009 msgid "" "This works regardless of how packages or derivations are specified. For " "instance, the following invocations are equivalent:" msgstr "" #. type: example #: doc/guix.texi:13015 #, 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:13020 msgid "" "If a log is unavailable locally, and unless @option{--no-substitutes} is " "passed, the command looks for a corresponding log on one of the substitute " "servers (as specified with @option{--substitute-urls})." msgstr "" #. type: table #: doc/guix.texi:13023 msgid "" "So for instance, imagine you want to see the build log of GDB on " "@code{aarch64}, but you are actually on an @code{x86_64} machine:" msgstr "" #. type: example #: doc/guix.texi:13027 #, no-wrap msgid "" "$ guix build --log-file gdb -s aarch64-linux\n" "https://@value{SUBSTITUTE-SERVER-1}/log/@dots{}-gdb-7.10\n" msgstr "" #. type: table #: doc/guix.texi:13030 msgid "You can freely access a huge library of build logs!" msgstr "" #. type: cindex #: doc/guix.texi:13035 #, no-wrap msgid "build failures, debugging" msgstr "" #. type: Plain text #: doc/guix.texi:13041 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:13046 msgid "" "To that end, the first thing to do is to use the @option{--keep-failed} or " "@option{-K} option of @command{guix build}, which will keep the failed build " "tree in @file{/tmp} or whatever directory you specified as @env{TMPDIR} " "(@pxref{Common Build Options, @option{--keep-failed}})." msgstr "" #. type: Plain text #: doc/guix.texi:13052 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:13059 #, 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:13063 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:13069 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:13072 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:13080 #, no-wrap msgid "" "$ guix build -K foo\n" "@dots{}\n" "$ cd /tmp/guix-build-foo.drv-0\n" "$ guix shell --no-grafts -C -D foo strace gdb\n" "[env]# source ./environment-variables\n" "[env]# cd foo-1.2\n" msgstr "" #. type: Plain text #: doc/guix.texi:13089 msgid "" "Here, @command{guix shell -C} creates a container and spawns a new shell in " "it (@pxref{Invoking guix shell}). The @command{strace gdb} part adds the " "@command{strace} and @command{gdb} commands to the container, which you may " "find handy while debugging. The @option{--no-grafts} option makes sure we " "get the exact same environment, with ungrafted packages (@pxref{Security " "Updates}, for more info on grafts)." msgstr "" #. type: Plain text #: doc/guix.texi:13092 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:13095 #, no-wrap msgid "[env]# rm /bin/sh\n" msgstr "" #. type: Plain text #: doc/guix.texi:13099 msgid "" "(Don't worry, this is harmless: this is all happening in the throw-away " "container created by @command{guix shell}.)" msgstr "" #. type: Plain text #: doc/guix.texi:13102 msgid "" "The @command{strace} command is probably not in the search path, but we can " "run:" msgstr "" #. type: example #: doc/guix.texi:13105 #, no-wrap msgid "[env]# $GUIX_ENVIRONMENT/bin/strace -f -o log make check\n" msgstr "" #. type: Plain text #: doc/guix.texi:13110 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:13113 #, no-wrap msgid "Invoking @command{guix edit}" msgstr "" #. type: command{#1} #: doc/guix.texi:13115 #, no-wrap msgid "guix edit" msgstr "" #. type: cindex #: doc/guix.texi:13116 #, no-wrap msgid "package definition, editing" msgstr "" #. type: Plain text #: doc/guix.texi:13121 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:13124 #, no-wrap msgid "guix edit gcc@@4.9 vim\n" msgstr "" #. type: Plain text #: doc/guix.texi:13130 msgid "" "launches the program specified in the @env{VISUAL} or in the @env{EDITOR} " "environment variable to view the recipe of GCC@tie{}4.9.3 and that of Vim." msgstr "" #. type: Plain text #: doc/guix.texi:13136 msgid "" "If you are using a Guix Git checkout (@pxref{Building from Git}), or have " "created your own packages on @env{GUIX_PACKAGE_PATH} (@pxref{Package " "Modules}), you will be able to edit the package recipes. In other cases, " "you will be able to examine the read-only recipes for packages currently in " "the store." msgstr "" #. type: Plain text #: doc/guix.texi:13141 msgid "" "Instead of @env{GUIX_PACKAGE_PATH}, the command-line option @option{--load-" "path=@var{directory}} (or in short @option{-L @var{directory}}) allows you " "to add @var{directory} to the front of the package module search path and so " "make your own packages visible." msgstr "" #. type: section #: doc/guix.texi:13143 #, no-wrap msgid "Invoking @command{guix download}" msgstr "" #. type: command{#1} #: doc/guix.texi:13145 #, no-wrap msgid "guix download" msgstr "" #. type: cindex #: doc/guix.texi:13146 #, no-wrap msgid "downloading package sources" msgstr "" #. type: Plain text #: doc/guix.texi:13153 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:13160 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:13168 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:13173 msgid "" "@command{guix download} verifies HTTPS server certificates by loading the " "certificates of X.509 authorities from the directory pointed to by the " "@env{SSL_CERT_DIR} environment variable (@pxref{X.509 Certificates}), unless " "@option{--no-check-certificate} is used." msgstr "" #. type: Plain text #: doc/guix.texi:13175 doc/guix.texi:15125 msgid "The following options are available:" msgstr "" #. type: item #: doc/guix.texi:13177 doc/guix.texi:13221 #, no-wrap msgid "--hash=@var{algorithm}" msgstr "" #. type: itemx #: doc/guix.texi:13178 doc/guix.texi:13222 #, no-wrap msgid "-H @var{algorithm}" msgstr "" #. type: table #: doc/guix.texi:13181 msgid "" "Compute a hash using the specified @var{algorithm}. @xref{Invoking guix " "hash}, for more information." msgstr "" #. type: item #: doc/guix.texi:13182 doc/guix.texi:13231 #, no-wrap msgid "--format=@var{fmt}" msgstr "" #. type: itemx #: doc/guix.texi:13183 doc/guix.texi:13232 #, no-wrap msgid "-f @var{fmt}" msgstr "" #. type: table #: doc/guix.texi:13186 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:13187 #, no-wrap msgid "--no-check-certificate" msgstr "" #. type: table #: doc/guix.texi:13189 msgid "Do not validate the X.509 certificates of HTTPS servers." msgstr "" #. type: table #: doc/guix.texi:13193 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:13194 #, no-wrap msgid "--output=@var{file}" msgstr "" #. type: itemx #: doc/guix.texi:13195 #, no-wrap msgid "-o @var{file}" msgstr "" #. type: table #: doc/guix.texi:13198 msgid "" "Save the downloaded file to @var{file} instead of adding it to the store." msgstr "" #. type: section #: doc/guix.texi:13201 #, no-wrap msgid "Invoking @command{guix hash}" msgstr "" #. type: command{#1} #: doc/guix.texi:13203 #, no-wrap msgid "guix hash" msgstr "" #. type: Plain text #: doc/guix.texi:13208 msgid "" "The @command{guix hash} command computes the hash of a file. It is " "primarily a convenience tool for anyone contributing to the distribution: it " "computes the cryptographic hash of one or more files, which can be used in " "the definition of a package (@pxref{Defining Packages})." msgstr "" #. type: example #: doc/guix.texi:13213 #, no-wrap msgid "guix hash @var{option} @var{file} ...\n" msgstr "" #. type: Plain text #: doc/guix.texi:13218 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:13225 msgid "" "Compute a hash using the specified @var{algorithm}, @code{sha256} by default." msgstr "" #. type: table #: doc/guix.texi:13230 msgid "" "@var{algorithm} must be the name of a cryptographic hash algorithm supported " "by Libgcrypt @i{via} Guile-Gcrypt---e.g., @code{sha512} or @code{sha3-256} " "(@pxref{Hash Functions,,, guile-gcrypt, Guile-Gcrypt Reference Manual})." msgstr "" #. type: table #: doc/guix.texi:13234 msgid "Write the hash in the format specified by @var{fmt}." msgstr "" #. type: table #: doc/guix.texi:13237 msgid "" "Supported formats: @code{base64}, @code{nix-base32}, @code{base32}, " "@code{base16} (@code{hex} and @code{hexadecimal} can be used as well)." msgstr "" #. type: table #: doc/guix.texi:13241 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:13247 msgid "" "The @option{--recursive} option is deprecated in favor of @option{--" "serializer=nar} (see below); @option{-r} remains accepted as a convenient " "shorthand." msgstr "" #. type: item #: doc/guix.texi:13248 #, no-wrap msgid "--serializer=@var{type}" msgstr "" #. type: itemx #: doc/guix.texi:13249 #, no-wrap msgid "-S @var{type}" msgstr "" #. type: table #: doc/guix.texi:13251 msgid "Compute the hash on @var{file} using @var{type} serialization." msgstr "" #. type: table #: doc/guix.texi:13253 msgid "@var{type} may be one of the following:" msgstr "" #. type: item #: doc/guix.texi:13255 doc/guix.texi:15484 doc/guix.texi:19574 #: doc/guix.texi:22017 #, no-wrap msgid "none" msgstr "" #. type: table #: doc/guix.texi:13257 msgid "This is the default: it computes the hash of a file's contents." msgstr "" #. type: item #: doc/guix.texi:13258 #, no-wrap msgid "nar" msgstr "" #. type: table #: doc/guix.texi:13268 msgid "" "Compute the hash of a ``normalized archive'' (or ``nar'') 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 have no impact on the hash " "(@pxref{Invoking guix archive}, for more info on the nar format)." msgstr "" #. type: item #: doc/guix.texi:13269 #, no-wrap msgid "git" msgstr "" #. type: table #: doc/guix.texi:13272 msgid "" "Compute the hash of the file or directory as a Git ``tree'', following the " "same method as the Git version control system." msgstr "" #. type: item #: doc/guix.texi:13274 #, no-wrap msgid "--exclude-vcs" msgstr "" #. type: itemx #: doc/guix.texi:13275 doc/guix.texi:14583 #, no-wrap msgid "-x" msgstr "" #. type: table #: doc/guix.texi:13278 msgid "" "When combined with @option{--recursive}, exclude version control system " "directories (@file{.bzr}, @file{.git}, @file{.hg}, etc.)." msgstr "" #. type: vindex #: doc/guix.texi:13279 #, no-wrap msgid "git-fetch" msgstr "" #. type: table #: doc/guix.texi:13283 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:13288 #, no-wrap msgid "" "$ git clone http://example.org/foo.git\n" "$ cd foo\n" "$ guix hash -x --serializer=nar .\n" msgstr "" #. type: cindex #: doc/guix.texi:13292 doc/guix.texi:13297 #, no-wrap msgid "Invoking @command{guix import}" msgstr "" #. type: cindex #: doc/guix.texi:13294 #, no-wrap msgid "importing packages" msgstr "" #. type: cindex #: doc/guix.texi:13295 #, no-wrap msgid "package import" msgstr "" #. type: cindex #: doc/guix.texi:13296 #, no-wrap msgid "package conversion" msgstr "" #. type: Plain text #: doc/guix.texi:13304 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:13309 #, no-wrap msgid "guix import @var{importer} @var{options}@dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:13314 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}." msgstr "" #. type: Plain text #: doc/guix.texi:13318 msgid "" "Some of the importers rely on the ability to run the @command{gpgv} " "command. For these, GnuPG must be installed and in @code{$PATH}; run " "@code{guix install gnupg} if needed." msgstr "" #. type: Plain text #: doc/guix.texi:13320 msgid "Currently, the available ``importers'' are:" msgstr "" #. type: item #: doc/guix.texi:13322 doc/guix.texi:14018 #, no-wrap msgid "gnu" msgstr "" #. type: table #: doc/guix.texi:13326 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:13329 msgid "" "Additional information such as the package dependencies and its license " "needs to be figured out manually." msgstr "" #. type: table #: doc/guix.texi:13332 msgid "" "For example, the following command returns a package definition for GNU@tie{}" "Hello:" msgstr "" #. type: example #: doc/guix.texi:13335 #, no-wrap msgid "guix import gnu hello\n" msgstr "" #. type: table #: doc/guix.texi:13338 doc/guix.texi:13585 doc/guix.texi:13635 #: doc/guix.texi:13664 msgid "Specific command-line options are:" msgstr "" #. type: item #: doc/guix.texi:13340 doc/guix.texi:14214 #, no-wrap msgid "--key-download=@var{policy}" msgstr "" #. type: table #: doc/guix.texi:13344 msgid "" "As for @command{guix refresh}, specify the policy to handle missing OpenPGP " "keys when verifying the package signature. @xref{Invoking guix refresh, " "@option{--key-download}}." msgstr "" #. type: item #: doc/guix.texi:13346 doc/guix.texi:13347 doc/guix.texi:14042 #, no-wrap msgid "pypi" msgstr "" #. type: table #: doc/guix.texi:13354 msgid "" "Import metadata from the @uref{https://pypi.python.org/, Python Package " "Index}. Information is taken from the JSON-formatted description available " "at @code{pypi.python.org} and usually includes all the relevant information, " "including package dependencies. For maximum efficiency, it is recommended " "to install the @command{unzip} utility, so that the importer can unzip " "Python wheels and gather data from them." msgstr "" #. type: table #: doc/guix.texi:13357 msgid "" "The command below imports metadata for the latest version of the " "@code{itsdangerous} Python package:" msgstr "" #. type: example #: doc/guix.texi:13360 #, no-wrap msgid "guix import pypi itsdangerous\n" msgstr "" #. type: table #: doc/guix.texi:13363 doc/guix.texi:13394 doc/guix.texi:13472 #: doc/guix.texi:13838 msgid "You can also ask for a specific version:" msgstr "" #. type: example #: doc/guix.texi:13366 #, no-wrap msgid "guix import pypi itsdangerous@@1.1.0\n" msgstr "" #. type: table #: doc/guix.texi:13374 doc/guix.texi:13405 doc/guix.texi:13437 #: doc/guix.texi:13608 doc/guix.texi:13649 doc/guix.texi:13700 #: doc/guix.texi:13725 doc/guix.texi:13750 doc/guix.texi:13766 #: doc/guix.texi:13814 doc/guix.texi:13850 doc/guix.texi:13877 #: doc/guix.texi:42910 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:13376 doc/guix.texi:13377 doc/guix.texi:14044 #, no-wrap msgid "gem" msgstr "" #. type: table #: doc/guix.texi:13386 msgid "" "Import metadata from @uref{https://rubygems.org/, RubyGems}. Information is " "taken from the JSON-formatted description available at @code{rubygems.org} " "and includes most relevant information, including runtime dependencies. " "There are some caveats, however. The metadata doesn't distinguish between " "synopses and descriptions, so the same string is used for both fields. " "Additionally, the details of non-Ruby dependencies required to build native " "extensions is unavailable and left as an exercise to the packager." msgstr "" #. type: table #: doc/guix.texi:13388 msgid "The command below imports metadata for the @code{rails} Ruby package:" msgstr "" #. type: example #: doc/guix.texi:13391 #, no-wrap msgid "guix import gem rails\n" msgstr "" #. type: example #: doc/guix.texi:13397 #, no-wrap msgid "guix import gem rails@@7.0.4\n" msgstr "" #. type: cindex #: doc/guix.texi:13407 doc/guix.texi:13408 #, no-wrap msgid "minetest" msgstr "" #. type: cindex #: doc/guix.texi:13409 #, no-wrap msgid "ContentDB" msgstr "" #. type: table #: doc/guix.texi:13418 msgid "" "Import metadata from @uref{https://content.minetest.net, ContentDB}. " "Information is taken from the JSON-formatted metadata provided through " "@uref{https://content.minetest.net/help/api/, ContentDB's API} and includes " "most relevant information, including dependencies. There are some caveats, " "however. The license information is often incomplete. The commit hash is " "sometimes missing. The descriptions are in the Markdown format, but Guix " "uses Texinfo instead. Texture packs and subgames are unsupported." msgstr "" #. type: table #: doc/guix.texi:13420 msgid "The command below imports metadata for the Mesecons mod by Jeija:" msgstr "" #. type: example #: doc/guix.texi:13423 #, no-wrap msgid "guix import minetest Jeija/mesecons\n" msgstr "" #. type: table #: doc/guix.texi:13426 msgid "The author name can also be left out:" msgstr "" #. type: example #: doc/guix.texi:13429 #, no-wrap msgid "guix import minetest mesecons\n" msgstr "" #. type: item #: doc/guix.texi:13439 doc/guix.texi:14040 #, no-wrap msgid "cpan" msgstr "" #. type: cindex #: doc/guix.texi:13440 #, no-wrap msgid "CPAN" msgstr "" #. type: table #: doc/guix.texi:13448 msgid "" "Import metadata from @uref{https://www.metacpan.org/, MetaCPAN}. " "Information is taken from the JSON-formatted metadata provided through " "@uref{https://fastapi.metacpan.org/, MetaCPAN's API} and includes most " "relevant information, such as module dependencies. License information " "should be checked closely. If Perl is available in the store, then the " "@code{corelist} utility will be used to filter core modules out of the list " "of dependencies." msgstr "" #. type: table #: doc/guix.texi:13451 msgid "" "The command command below imports metadata for the Acme::Boolean Perl module:" msgstr "" #. type: example #: doc/guix.texi:13454 #, no-wrap msgid "guix import cpan Acme::Boolean\n" msgstr "" #. type: item #: doc/guix.texi:13456 doc/guix.texi:14036 #, no-wrap msgid "cran" msgstr "" #. type: cindex #: doc/guix.texi:13457 #, no-wrap msgid "CRAN" msgstr "" #. type: cindex #: doc/guix.texi:13458 #, no-wrap msgid "Bioconductor" msgstr "" #. type: table #: doc/guix.texi:13462 msgid "" "Import metadata from @uref{https://cran.r-project.org/, CRAN}, the central " "repository for the @uref{https://r-project.org, GNU@tie{}R statistical and " "graphical environment}." msgstr "" #. type: table #: doc/guix.texi:13464 msgid "" "Information is extracted from the @file{DESCRIPTION} file of the package." msgstr "" #. type: table #: doc/guix.texi:13466 msgid "The command command below imports metadata for the Cairo R package:" msgstr "" #. type: example #: doc/guix.texi:13469 #, no-wrap msgid "guix import cran Cairo\n" msgstr "" #. type: example #: doc/guix.texi:13475 #, no-wrap msgid "guix import cran rasterVis@@0.50.3\n" msgstr "" #. type: table #: doc/guix.texi:13480 msgid "" "When @option{--recursive} is added, the importer will traverse the " "dependency graph of the given upstream package recursively and generate " "package expressions for all those packages that are not yet in Guix." msgstr "" #. type: table #: doc/guix.texi:13487 msgid "" "When @option{--style=specification} is added, the importer will generate " "package definitions whose inputs are package specifications instead of " "references to package variables. This is useful when generated package " "definitions are to be appended to existing user modules, as the list of used " "package modules need not be changed. The default is @option{--" "style=variable}." msgstr "" #. type: table #: doc/guix.texi:13492 msgid "" "When @option{--archive=bioconductor} is added, metadata is imported from " "@uref{https://www.bioconductor.org/, Bioconductor}, a repository of R " "packages for the analysis and comprehension of high-throughput genomic data " "in bioinformatics." msgstr "" #. type: table #: doc/guix.texi:13495 msgid "" "Information is extracted from the @file{DESCRIPTION} file contained in the " "package archive." msgstr "" #. type: table #: doc/guix.texi:13497 msgid "The command below imports metadata for the GenomicRanges R package:" msgstr "" #. type: example #: doc/guix.texi:13500 #, no-wrap msgid "guix import cran --archive=bioconductor GenomicRanges\n" msgstr "" #. type: table #: doc/guix.texi:13505 msgid "" "Finally, you can also import R packages that have not yet been published on " "CRAN or Bioconductor as long as they are in a git repository. Use @option{--" "archive=git} followed by the URL of the git repository:" msgstr "" #. type: example #: doc/guix.texi:13508 #, no-wrap msgid "guix import cran --archive=git https://github.com/immunogenomics/harmony\n" msgstr "" #. type: item #: doc/guix.texi:13510 #, no-wrap msgid "texlive" msgstr "" #. type: cindex #: doc/guix.texi:13511 #, no-wrap msgid "TeX Live" msgstr "" #. type: cindex #: doc/guix.texi:13512 #, no-wrap msgid "CTAN" msgstr "" #. type: table #: doc/guix.texi:13516 msgid "" "Import TeX package information from the TeX Live package database for TeX " "packages that are part of the @uref{https://www.tug.org/texlive/, TeX Live " "distribution}." msgstr "" #. type: table #: doc/guix.texi:13521 msgid "" "Information about the package is obtained from the TeX Live package " "database, a plain text file that is included in the @code{texlive-bin} " "package. The source code is downloaded from possibly multiple locations in " "the SVN repository of the Tex Live project." msgstr "" #. type: table #: doc/guix.texi:13524 msgid "" "The command command below imports metadata for the @code{fontspec} TeX " "package:" msgstr "" #. type: example #: doc/guix.texi:13527 #, no-wrap msgid "guix import texlive fontspec\n" msgstr "" #. type: cindex #: doc/guix.texi:13530 #, no-wrap msgid "JSON, import" msgstr "" #. type: table #: doc/guix.texi:13533 msgid "" "Import package metadata from a local JSON file. Consider the following " "example package definition in JSON format:" msgstr "" #. type: example #: doc/guix.texi:13546 #, 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\": [\"gettext\"]\n" "@}\n" msgstr "" #. type: table #: doc/guix.texi:13552 msgid "" "The field names are the same as for the @code{} 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:13555 msgid "" "The importer also supports a more explicit source definition using the " "common fields for @code{} records:" msgstr "" #. type: example #: doc/guix.texi:13568 #, 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:13572 msgid "" "The command below reads metadata from the JSON file @code{hello.json} and " "outputs a package expression:" msgstr "" #. type: example #: doc/guix.texi:13575 #, no-wrap msgid "guix import json hello.json\n" msgstr "" #. type: item #: doc/guix.texi:13577 doc/guix.texi:13578 doc/guix.texi:14048 #, no-wrap msgid "hackage" msgstr "" #. type: table #: doc/guix.texi:13583 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:13587 #, no-wrap msgid "--stdin" msgstr "" #. type: itemx #: doc/guix.texi:13588 #, no-wrap msgid "-s" msgstr "" #. type: table #: doc/guix.texi:13590 msgid "Read a Cabal file from standard input." msgstr "" #. type: item #: doc/guix.texi:13590 doc/guix.texi:13637 #, no-wrap msgid "--no-test-dependencies" msgstr "" #. type: table #: doc/guix.texi:13593 doc/guix.texi:13640 msgid "Do not include dependencies required only by the test suites." msgstr "" #. type: item #: doc/guix.texi:13593 #, no-wrap msgid "--cabal-environment=@var{alist}" msgstr "" #. type: itemx #: doc/guix.texi:13594 #, no-wrap msgid "-e @var{alist}" msgstr "" #. type: table #: doc/guix.texi:13603 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:13613 msgid "" "The command below imports metadata for the latest version of the HTTP " "Haskell package without including test dependencies and specifying the value " "of the flag @samp{network-uri} as @code{false}:" msgstr "" #. type: example #: doc/guix.texi:13616 #, no-wrap msgid "guix import hackage -t -e \"'((\\\"network-uri\\\" . false))\" HTTP\n" msgstr "" #. type: table #: doc/guix.texi:13620 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:13623 #, no-wrap msgid "guix import hackage mtl@@2.1.3.1\n" msgstr "" #. type: item #: doc/guix.texi:13625 doc/guix.texi:13626 doc/guix.texi:14050 #, no-wrap msgid "stackage" msgstr "" #. type: table #: doc/guix.texi:13633 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:13640 #, no-wrap msgid "--lts-version=@var{version}" msgstr "" #. type: itemx #: doc/guix.texi:13641 #, no-wrap msgid "-l @var{version}" msgstr "" #. type: table #: doc/guix.texi:13644 msgid "" "@var{version} is the desired LTS release version. If omitted the latest " "release is used." msgstr "" #. type: table #: doc/guix.texi:13653 msgid "" "The command below imports metadata for the HTTP Haskell package included in " "the LTS Stackage release version 7.18:" msgstr "" #. type: example #: doc/guix.texi:13656 #, no-wrap msgid "guix import stackage --lts-version=7.18 HTTP\n" msgstr "" #. type: item #: doc/guix.texi:13658 doc/guix.texi:13659 doc/guix.texi:14034 #, no-wrap msgid "elpa" msgstr "" #. type: table #: doc/guix.texi:13662 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:13666 #, no-wrap msgid "--archive=@var{repo}" msgstr "" #. type: itemx #: doc/guix.texi:13667 #, no-wrap msgid "-a @var{repo}" msgstr "" #. type: table #: doc/guix.texi:13671 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:13675 msgid "" "@uref{https://elpa.gnu.org/packages, GNU}, selected by the @code{gnu} " "identifier. This is the default." msgstr "" #. type: itemize #: doc/guix.texi:13681 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:13685 msgid "" "@uref{https://elpa.nongnu.org/nongnu/, NonGNU}, selected by the " "@code{nongnu} identifier." msgstr "" #. type: itemize #: doc/guix.texi:13689 msgid "" "@uref{https://stable.melpa.org/packages, MELPA-Stable}, selected by the " "@code{melpa-stable} identifier." msgstr "" #. type: itemize #: doc/guix.texi:13693 msgid "" "@uref{https://melpa.org/packages, MELPA}, selected by the @code{melpa} " "identifier." msgstr "" #. type: item #: doc/guix.texi:13702 doc/guix.texi:13703 doc/guix.texi:14052 #, no-wrap msgid "crate" msgstr "" #. type: table #: doc/guix.texi:13706 msgid "" "Import metadata from the crates.io Rust package repository @uref{https://" "crates.io, crates.io}, as in this example:" msgstr "" #. type: example #: doc/guix.texi:13709 #, no-wrap msgid "guix import crate blake2-rfc\n" msgstr "" #. type: table #: doc/guix.texi:13712 msgid "The crate importer also allows you to specify a version string:" msgstr "" #. type: example #: doc/guix.texi:13715 #, no-wrap msgid "guix import crate constant-time-eq@@0.1.0\n" msgstr "" #. type: Plain text #: doc/guix.texi:13718 doc/guix.texi:13743 doc/guix.texi:13759 #: doc/guix.texi:13807 doc/guix.texi:13844 doc/guix.texi:13870 #: doc/guix.texi:42903 msgid "Additional options include:" msgstr "" #. type: cindex #: doc/guix.texi:13727 doc/guix.texi:13728 #, no-wrap msgid "elm" msgstr "" #. type: table #: doc/guix.texi:13731 msgid "" "Import metadata from the Elm package repository @uref{https://package.elm-" "lang.org, package.elm-lang.org}, as in this example:" msgstr "" #. type: example #: doc/guix.texi:13734 #, no-wrap msgid "guix import elm elm-explorations/webgl\n" msgstr "" #. type: table #: doc/guix.texi:13737 msgid "The Elm importer also allows you to specify a version string:" msgstr "" #. type: example #: doc/guix.texi:13740 #, no-wrap msgid "guix import elm elm-explorations/webgl@@1.1.3\n" msgstr "" #. type: item #: doc/guix.texi:13752 #, no-wrap msgid "opam" msgstr "" #. type: cindex #: doc/guix.texi:13753 #, no-wrap msgid "OPAM" msgstr "" #. type: cindex #: doc/guix.texi:13754 #, no-wrap msgid "OCaml" msgstr "" #. type: table #: doc/guix.texi:13757 msgid "" "Import metadata from the @uref{https://opam.ocaml.org/, OPAM} package " "repository used by the OCaml community." msgstr "" #. type: item #: doc/guix.texi:13766 #, no-wrap msgid "--repo" msgstr "" #. type: table #: doc/guix.texi:13770 msgid "" "By default, packages are searched in the official OPAM repository. This " "option, which can be used more than once, lets you add other repositories " "which will be searched for packages. It accepts as valid arguments:" msgstr "" #. type: item #: doc/guix.texi:13772 #, no-wrap msgid "the name of a known repository - can be one of @code{opam}," msgstr "" #. type: itemize #: doc/guix.texi:13775 msgid "" "@code{coq} (equivalent to @code{coq-released}), @code{coq-core-dev}, " "@code{coq-extra-dev} or @code{grew}." msgstr "" #. type: item #: doc/guix.texi:13775 #, no-wrap msgid "the URL of a repository as expected by the" msgstr "" #. type: itemize #: doc/guix.texi:13779 msgid "" "@code{opam repository add} command (for instance, the URL equivalent of the " "above @code{opam} name would be @uref{https://opam.ocaml.org})." msgstr "" #. type: item #: doc/guix.texi:13779 #, no-wrap msgid "the path to a local copy of a repository (a directory containing a" msgstr "" #. type: itemize #: doc/guix.texi:13781 msgid "@file{packages/} sub-directory)." msgstr "" #. type: table #: doc/guix.texi:13786 msgid "" "Repositories are assumed to be passed to this option by order of " "preference. The additional repositories will not replace the default " "@code{opam} repository, which is always kept as a fallback." msgstr "" #. type: table #: doc/guix.texi:13791 msgid "" "Also, please note that versions are not compared across repositories. The " "first repository (from left to right) that has at least one version of a " "given package will prevail over any others, and the version imported will be " "the latest one found @emph{in this repository only}." msgstr "" #. type: cindex #: doc/guix.texi:13794 doc/guix.texi:13795 #, no-wrap msgid "go" msgstr "" #. type: table #: doc/guix.texi:13798 msgid "" "Import metadata for a Go module using @uref{https://proxy.golang.org, proxy." "golang.org}." msgstr "" #. type: example #: doc/guix.texi:13801 #, no-wrap msgid "guix import go gopkg.in/yaml.v2\n" msgstr "" #. type: table #: doc/guix.texi:13805 msgid "" "It is possible to use a package specification with a @code{@@VERSION} suffix " "to import a specific version." msgstr "" #. type: item #: doc/guix.texi:13814 #, no-wrap msgid "--pin-versions" msgstr "" #. type: table #: doc/guix.texi:13822 msgid "" "When using this option, the importer preserves the exact versions of the Go " "modules dependencies instead of using their latest available versions. This " "can be useful when attempting to import packages that recursively depend on " "former versions of themselves to build. When using this mode, the symbol of " "the package is made by appending the version to its name, so that multiple " "versions of the same package can coexist." msgstr "" #. type: item #: doc/guix.texi:13824 doc/guix.texi:13825 doc/guix.texi:14032 #, no-wrap msgid "egg" msgstr "" #. type: table #: doc/guix.texi:13832 msgid "" "Import metadata for @uref{https://wiki.call-cc.org/eggs, CHICKEN eggs}. The " "information is taken from @file{PACKAGE.egg} files found in the @uref{git://" "code.call-cc.org/eggs-5-all, eggs-5-all} Git repository. However, it does " "not provide all the information that we need, there is no ``description'' " "field, and the licenses used are not always precise (BSD is often used " "instead of BSD-N)." msgstr "" #. type: example #: doc/guix.texi:13835 #, no-wrap msgid "guix import egg sourcehut\n" msgstr "" #. type: example #: doc/guix.texi:13841 #, no-wrap msgid "guix import egg arrays@@1.0\n" msgstr "" #. type: cindex #: doc/guix.texi:13852 doc/guix.texi:13853 #, no-wrap msgid "hexpm" msgstr "" #. type: table #: doc/guix.texi:13856 msgid "" "Import metadata from the hex.pm Erlang and Elixir package repository " "@uref{https://hex.pm, hex.pm}, as in this example:" msgstr "" #. type: example #: doc/guix.texi:13859 #, no-wrap msgid "guix import hexpm stun\n" msgstr "" #. type: table #: doc/guix.texi:13862 msgid "The importer tries to determine the build system used by the package." msgstr "" #. type: table #: doc/guix.texi:13864 msgid "The hexpm importer also allows you to specify a version string:" msgstr "" #. type: example #: doc/guix.texi:13867 #, no-wrap msgid "guix import hexpm cf@@0.3.0\n" msgstr "" #. type: Plain text #: doc/guix.texi:13883 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:13885 #, no-wrap msgid "Invoking @command{guix refresh}" msgstr "" #. type: command{#1} #: doc/guix.texi:13887 #, no-wrap msgid "guix refresh" msgstr "" #. type: Plain text #: doc/guix.texi:13895 msgid "" "The primary audience of the @command{guix refresh} command is packagers. As " "a user, you may be interested in the @option{--with-latest} option, which " "can bring you package update superpowers built upon @command{guix refresh} " "(@pxref{Package Transformation Options, @option{--with-latest}}). By " "default, @command{guix refresh} reports any packages provided by the " "distribution that are outdated compared to the latest upstream version, like " "this:" msgstr "" #. type: example #: doc/guix.texi:13900 #, 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:13904 msgid "" "Alternatively, 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:13909 #, 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:13918 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: table #: doc/guix.texi:13923 msgid "" "Consider the packages specified, and all the packages upon which they depend." msgstr "" #. type: example #: doc/guix.texi:13931 #, no-wrap msgid "" "$ guix refresh --recursive coreutils\n" "gnu/packages/acl.scm:40:13: acl would be upgraded from 2.2.53 to 2.3.1\n" "gnu/packages/m4.scm:30:12: 1.4.18 is already the latest version of m4\n" "gnu/packages/xml.scm:68:2: warning: no updater for expat\n" "gnu/packages/multiprecision.scm:40:12: 6.1.2 is already the latest version of gmp\n" "@dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:13939 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: lisp #: doc/guix.texi:13946 #, 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:13955 msgid "" "When passed @option{--update}, it modifies distribution source files to " "update the version numbers and source tarball hashes of those package " "recipes (@pxref{Defining Packages}). This is achieved by downloading each " "package's latest source tarball and its associated OpenPGP signature, " "authenticating the downloaded tarball against its signature using " "@command{gpgv}, and finally computing its hash---note that GnuPG must be " "installed and in @code{$PATH}; run @code{guix install gnupg} if needed." msgstr "" #. type: Plain text #: doc/guix.texi:13961 msgid "" "When the public key used to sign the tarball is missing from the user's " "keyring, an attempt is made to automatically retrieve it from a public key " "server; when this is successful, the key is added to the user's keyring; " "otherwise, @command{guix refresh} reports an error." msgstr "" #. type: Plain text #: doc/guix.texi:13963 msgid "The following options are supported:" msgstr "" #. type: table #: doc/guix.texi:13971 doc/guix.texi:15002 msgid "This is useful to precisely refer to a package, as in this example:" msgstr "" #. type: example #: doc/guix.texi:13974 #, no-wrap msgid "guix refresh -l -e '(@@@@ (gnu packages commencement) glibc-final)'\n" msgstr "" #. type: table #: doc/guix.texi:13978 msgid "" "This command lists the dependents of the ``final'' libc (essentially all the " "packages)." msgstr "" #. type: item #: doc/guix.texi:13979 #, no-wrap msgid "--update" msgstr "" #. type: itemx #: doc/guix.texi:13980 #, no-wrap msgid "-u" msgstr "" #. type: table #: doc/guix.texi:13984 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:13987 #, no-wrap msgid "$ ./pre-inst-env guix refresh -s non-core -u\n" msgstr "" #. type: table #: doc/guix.texi:13990 msgid "@xref{Defining Packages}, for more information on package definitions." msgstr "" #. type: item #: doc/guix.texi:13991 #, no-wrap msgid "--select=[@var{subset}]" msgstr "" #. type: itemx #: doc/guix.texi:13992 #, no-wrap msgid "-s @var{subset}" msgstr "" #. type: table #: doc/guix.texi:13995 msgid "" "Select all the packages in @var{subset}, one of @code{core} or @code{non-" "core}." msgstr "" #. type: table #: doc/guix.texi:14002 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:14006 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:14011 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:14012 #, no-wrap msgid "--type=@var{updater}" msgstr "" #. type: itemx #: doc/guix.texi:14013 #, no-wrap msgid "-t @var{updater}" msgstr "" #. type: table #: doc/guix.texi:14016 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:14020 msgid "the updater for GNU packages;" msgstr "" #. type: item #: doc/guix.texi:14020 #, no-wrap msgid "savannah" msgstr "" #. type: table #: doc/guix.texi:14022 msgid "" "the updater for packages hosted at @uref{https://savannah.gnu.org, Savannah};" msgstr "" #. type: item #: doc/guix.texi:14022 #, no-wrap msgid "sourceforge" msgstr "" #. type: table #: doc/guix.texi:14024 msgid "" "the updater for packages hosted at @uref{https://sourceforge.net, " "SourceForge};" msgstr "" #. type: item #: doc/guix.texi:14024 #, no-wrap msgid "gnome" msgstr "" #. type: table #: doc/guix.texi:14026 msgid "the updater for GNOME packages;" msgstr "" #. type: item #: doc/guix.texi:14026 #, no-wrap msgid "kde" msgstr "" #. type: table #: doc/guix.texi:14028 msgid "the updater for KDE packages;" msgstr "" #. type: item #: doc/guix.texi:14028 #, no-wrap msgid "xorg" msgstr "" #. type: table #: doc/guix.texi:14030 msgid "the updater for X.org packages;" msgstr "" #. type: item #: doc/guix.texi:14030 #, no-wrap msgid "kernel.org" msgstr "" #. type: table #: doc/guix.texi:14032 msgid "the updater for packages hosted on kernel.org;" msgstr "" #. type: table #: doc/guix.texi:14034 msgid "the updater for @uref{https://wiki.call-cc.org/eggs/, Egg} packages;" msgstr "" #. type: table #: doc/guix.texi:14036 msgid "the updater for @uref{https://elpa.gnu.org/, ELPA} packages;" msgstr "" #. type: table #: doc/guix.texi:14038 msgid "the updater for @uref{https://cran.r-project.org/, CRAN} packages;" msgstr "" #. type: item #: doc/guix.texi:14038 #, no-wrap msgid "bioconductor" msgstr "" #. type: table #: doc/guix.texi:14040 msgid "" "the updater for @uref{https://www.bioconductor.org/, Bioconductor} R " "packages;" msgstr "" #. type: table #: doc/guix.texi:14042 msgid "the updater for @uref{https://www.cpan.org/, CPAN} packages;" msgstr "" #. type: table #: doc/guix.texi:14044 msgid "the updater for @uref{https://pypi.python.org, PyPI} packages." msgstr "" #. type: table #: doc/guix.texi:14046 msgid "the updater for @uref{https://rubygems.org, RubyGems} packages." msgstr "" #. type: item #: doc/guix.texi:14046 #, no-wrap msgid "github" msgstr "" #. type: table #: doc/guix.texi:14048 msgid "the updater for @uref{https://github.com, GitHub} packages." msgstr "" #. type: table #: doc/guix.texi:14050 msgid "the updater for @uref{https://hackage.haskell.org, Hackage} packages." msgstr "" #. type: table #: doc/guix.texi:14052 msgid "the updater for @uref{https://www.stackage.org, Stackage} packages." msgstr "" #. type: table #: doc/guix.texi:14054 msgid "the updater for @uref{https://crates.io, Crates} packages." msgstr "" #. type: item #: doc/guix.texi:14054 #, no-wrap msgid "launchpad" msgstr "" #. type: table #: doc/guix.texi:14056 msgid "the updater for @uref{https://launchpad.net, Launchpad} packages." msgstr "" #. type: item #: doc/guix.texi:14056 #, no-wrap msgid "generic-html" msgstr "" #. type: table #: doc/guix.texi:14059 msgid "" "a generic updater that crawls the HTML page where the source tarball of the " "package is hosted, when applicable." msgstr "" #. type: item #: doc/guix.texi:14060 #, no-wrap msgid "generic-git" msgstr "" #. type: table #: doc/guix.texi:14065 msgid "" "a generic updater for packages hosted on Git repositories. It tries to be " "smart about parsing Git tag names, but if it is not able to parse the tag " "name and compare tags correctly, users can define the following properties " "for a package." msgstr "" #. type: item #: doc/guix.texi:14067 #, no-wrap msgid "@code{release-tag-prefix}: a regular expression for matching a prefix of" msgstr "" #. type: itemize #: doc/guix.texi:14069 doc/guix.texi:14072 msgid "the tag name." msgstr "" #. type: item #: doc/guix.texi:14070 #, no-wrap msgid "@code{release-tag-suffix}: a regular expression for matching a suffix of" msgstr "" #. type: item #: doc/guix.texi:14073 #, no-wrap msgid "@code{release-tag-version-delimiter}: a string used as the delimiter in" msgstr "" #. type: itemize #: doc/guix.texi:14075 msgid "the tag name for separating the numbers of the version." msgstr "" #. type: item #: doc/guix.texi:14076 #, no-wrap msgid "@code{accept-pre-releases}: by default, the updater will ignore" msgstr "" #. type: itemize #: doc/guix.texi:14079 msgid "" "pre-releases; to make it also look for pre-releases, set the this property " "to @code{#t}." msgstr "" #. type: lisp #: doc/guix.texi:14090 #, no-wrap msgid "" "(package\n" " (name \"foo\")\n" " ;; ...\n" " (properties\n" " '((release-tag-prefix . \"^release0-\")\n" " (release-tag-suffix . \"[a-z]?$\")\n" " (release-tag-version-delimiter . \":\"))))\n" msgstr "" #. type: table #: doc/guix.texi:14097 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:14102 #, 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: item #: doc/guix.texi:14104 #, no-wrap msgid "--list-updaters" msgstr "" #. type: table #: doc/guix.texi:14106 msgid "List available updaters and exit (see @option{--type} above)." msgstr "" #. type: table #: doc/guix.texi:14109 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: Plain text #: doc/guix.texi:14113 msgid "" "In addition, @command{guix refresh} can be passed one or more package names, " "as in this example:" msgstr "" #. type: example #: doc/guix.texi:14116 #, no-wrap msgid "$ ./pre-inst-env guix refresh -u emacs idutils gcc@@4.8\n" msgstr "" #. type: Plain text #: doc/guix.texi:14123 msgid "" "The command above specifically updates the @code{emacs} and @code{idutils} " "packages. The @option{--select} option would have no effect in this case. " "You might also want to update definitions that correspond to the packages " "installed in your profile:" msgstr "" #. type: example #: doc/guix.texi:14127 #, no-wrap msgid "" "$ ./pre-inst-env guix refresh -u \\\n" " $(guix package --list-installed | cut -f1)\n" msgstr "" #. type: Plain text #: doc/guix.texi:14133 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:14136 #, no-wrap msgid "--list-dependent" msgstr "" #. type: itemx #: doc/guix.texi:14137 doc/guix.texi:14381 doc/guix.texi:14573 #, no-wrap msgid "-l" msgstr "" #. type: table #: doc/guix.texi:14140 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:14144 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:14150 msgid "" "Be aware that the @option{--list-dependent} option only @emph{approximates} " "the rebuilds that would be required as a result of an upgrade. More " "rebuilds might be required under some circumstances." msgstr "" #. type: example #: doc/guix.texi:14155 #, 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 emacs-geiser@@0.13 notmuch@@0.18 mu@@0.9.9.5 cflow@@1.4 idutils@@4.6 @dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:14159 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: item #: doc/guix.texi:14162 #, no-wrap msgid "--list-transitive" msgstr "" #. type: table #: doc/guix.texi:14164 msgid "List all the packages which one or more packages depend upon." msgstr "" #. type: example #: doc/guix.texi:14169 #, no-wrap msgid "" "$ guix refresh --list-transitive flex\n" "flex@@2.6.4 depends on the following 25 packages: perl@@5.28.0 help2man@@1.47.6\n" "bison@@3.0.5 indent@@2.2.10 tar@@1.30 gzip@@1.9 bzip2@@1.0.6 xz@@5.2.4 file@@5.33 @dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:14175 msgid "" "The command above lists a set of packages which, when changed, would cause " "@code{flex} to be rebuilt." msgstr "" #. type: Plain text #: doc/guix.texi:14177 msgid "The following options can be used to customize GnuPG operation:" msgstr "" #. type: item #: doc/guix.texi:14180 #, no-wrap msgid "--gpg=@var{command}" msgstr "" #. type: table #: doc/guix.texi:14183 msgid "" "Use @var{command} as the GnuPG 2.x command. @var{command} is searched for " "in @code{$PATH}." msgstr "" #. type: item #: doc/guix.texi:14184 #, no-wrap msgid "--keyring=@var{file}" msgstr "" #. type: table #: doc/guix.texi:14190 msgid "" "Use @var{file} as the keyring for upstream keys. @var{file} must be in the " "@dfn{keybox format}. Keybox files usually have a name ending in @file{.kbx} " "and the GNU@tie{}Privacy Guard (GPG) can manipulate these files " "(@pxref{kbxutil, @command{kbxutil},, gnupg, Using the GNU Privacy Guard}, " "for information on a tool to manipulate keybox files)." msgstr "" #. type: table #: doc/guix.texi:14196 msgid "" "When this option is omitted, @command{guix refresh} uses @file{~/.config/" "guix/upstream/trustedkeys.kbx} as the keyring for upstream signing keys. " "OpenPGP signatures are checked against keys from this keyring; missing keys " "are downloaded to this keyring as well (see @option{--key-download} below)." msgstr "" #. type: table #: doc/guix.texi:14199 msgid "" "You can export keys from your default GPG keyring into a keybox file using " "commands like this one:" msgstr "" #. type: example #: doc/guix.texi:14202 #, no-wrap msgid "gpg --export rms@@gnu.org | kbxutil --import-openpgp >> mykeyring.kbx\n" msgstr "" #. type: table #: doc/guix.texi:14205 msgid "Likewise, you can fetch keys to a specific keybox file like this:" msgstr "" #. type: example #: doc/guix.texi:14209 #, no-wrap msgid "" "gpg --no-default-keyring --keyring mykeyring.kbx \\\n" " --recv-keys @value{OPENPGP-SIGNING-KEY-ID}\n" msgstr "" #. type: table #: doc/guix.texi:14213 msgid "" "@xref{GPG Configuration Options, @option{--keyring},, gnupg, Using the GNU " "Privacy Guard}, for more information on GPG's @option{--keyring} option." msgstr "" #. type: table #: doc/guix.texi:14217 msgid "" "Handle missing OpenPGP keys according to @var{policy}, which may be one of:" msgstr "" #. type: item #: doc/guix.texi:14219 doc/guix.texi:14416 doc/guix.texi:25134 #, no-wrap msgid "always" msgstr "" #. type: table #: doc/guix.texi:14222 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:14223 doc/guix.texi:25136 #, no-wrap msgid "never" msgstr "" #. type: table #: doc/guix.texi:14225 msgid "Never try to download missing OpenPGP keys. Instead just bail out." msgstr "" #. type: item #: doc/guix.texi:14226 #, no-wrap msgid "interactive" msgstr "" #. type: table #: doc/guix.texi:14229 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:14231 #, no-wrap msgid "--key-server=@var{host}" msgstr "" #. type: table #: doc/guix.texi:14233 msgid "Use @var{host} as the OpenPGP key server when importing a public key." msgstr "" #. type: Plain text #: doc/guix.texi:14254 msgid "" "The @code{github} updater uses the @uref{https://developer.github.com/v3/, " "GitHub API} to query for new releases. When used repeatedly e.g.@: when " "refreshing all packages, GitHub will eventually refuse to answer any further " "API requests. By default 60 API requests per hour are allowed, and a full " "refresh on all GitHub packages in Guix requires more than this. " "Authentication with GitHub through the use of an API token alleviates these " "limits. To use an API token, set the environment variable " "@env{GUIX_GITHUB_TOKEN} to a token procured from @uref{https://github.com/" "settings/tokens} or otherwise." msgstr "" #. type: section #: doc/guix.texi:14257 #, no-wrap msgid "Invoking @command{guix style}" msgstr "" #. type: command{#1} #: doc/guix.texi:14259 #, no-wrap msgid "guix style" msgstr "" #. type: cindex #: doc/guix.texi:14260 #, no-wrap msgid "styling rules" msgstr "" #. type: cindex #: doc/guix.texi:14261 #, no-wrap msgid "lint, code style" msgstr "" #. type: cindex #: doc/guix.texi:14262 #, no-wrap msgid "format, code style" msgstr "" #. type: cindex #: doc/guix.texi:14263 #, no-wrap msgid "format conventions" msgstr "" #. type: Plain text #: doc/guix.texi:14270 msgid "" "The @command{guix style} command helps users and packagers alike style their " "package definitions and configuration files according to the latest " "fashionable trends. It can either reformat whole files, with the @option{--" "whole-file} option, or apply specific @dfn{styling rules} to individual " "package definitions. The command currently provides the following styling " "rules:" msgstr "" #. type: itemize #: doc/guix.texi:14275 msgid "" "formatting package definitions according to the project's conventions " "(@pxref{Formatting Code});" msgstr "" #. type: itemize #: doc/guix.texi:14278 msgid "rewriting package inputs to the ``new style'', as explained below." msgstr "" #. type: Plain text #: doc/guix.texi:14284 msgid "" "The way package inputs are written is going through a transition " "(@pxref{package Reference}, for more on package inputs). Until version " "1.3.0, package inputs were written using the ``old style'', where each input " "was given an explicit label, most of the time the package name:" msgstr "" #. type: lisp #: doc/guix.texi:14291 #, no-wrap msgid "" "(package\n" " ;; @dots{}\n" " ;; The \"old style\" (deprecated).\n" " (inputs `((\"libunistring\" ,libunistring)\n" " (\"libffi\" ,libffi))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:14295 msgid "" "Today, the old style is deprecated and the preferred style looks like this:" msgstr "" #. type: lisp #: doc/guix.texi:14301 #, no-wrap msgid "" "(package\n" " ;; @dots{}\n" " ;; The \"new style\".\n" " (inputs (list libunistring libffi)))\n" msgstr "" #. type: Plain text #: doc/guix.texi:14306 msgid "" "Likewise, uses of @code{alist-delete} and friends to manipulate inputs is " "now deprecated in favor of @code{modify-inputs} (@pxref{Defining Package " "Variants}, for more info on @code{modify-inputs})." msgstr "" #. type: Plain text #: doc/guix.texi:14311 msgid "" "In the vast majority of cases, this is a purely mechanical change on the " "surface syntax that does not even incur a package rebuild. Running " "@command{guix style -S inputs} can do that for you, whether you're working " "on packages in Guix proper or in an external channel." msgstr "" #. type: example #: doc/guix.texi:14316 #, no-wrap msgid "guix style [@var{options}] @var{package}@dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:14323 msgid "" "This causes @command{guix style} to analyze and rewrite the definition of " "@var{package}@dots{} or, when @var{package} is omitted, of @emph{all} the " "packages. The @option{--styling} or @option{-S} option allows you to select " "the style rule, the default rule being @code{format}---see below." msgstr "" #. type: Plain text #: doc/guix.texi:14325 msgid "To reformat entire source files, the syntax is:" msgstr "" #. type: example #: doc/guix.texi:14328 #, no-wrap msgid "guix style --whole-file @var{file}@dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:14331 doc/guix.texi:15690 msgid "The available options are listed below." msgstr "" #. type: table #: doc/guix.texi:14336 msgid "Show source file locations that would be edited but do not modify them." msgstr "" #. type: item #: doc/guix.texi:14337 #, no-wrap msgid "--whole-file" msgstr "" #. type: itemx #: doc/guix.texi:14338 #, no-wrap msgid "-f" msgstr "" #. type: table #: doc/guix.texi:14342 msgid "" "Reformat the given files in their entirety. In that case, subsequent " "arguments are interpreted as file names (rather than package names), and the " "@option{--styling} option has no effect." msgstr "" #. type: table #: doc/guix.texi:14345 msgid "" "As an example, here is how you might reformat your operating system " "configuration (you need write permissions for the file):" msgstr "" #. type: example #: doc/guix.texi:14348 #, no-wrap msgid "guix style -f /etc/config.scm\n" msgstr "" #. type: item #: doc/guix.texi:14350 #, no-wrap msgid "--styling=@var{rule}" msgstr "" #. type: itemx #: doc/guix.texi:14351 #, no-wrap msgid "-S @var{rule}" msgstr "" #. type: table #: doc/guix.texi:14353 msgid "Apply @var{rule}, one of the following styling rules:" msgstr "" #. type: code{#1} #: doc/guix.texi:14355 doc/guix.texi:42152 #, no-wrap msgid "format" msgstr "" #. type: table #: doc/guix.texi:14360 msgid "" "Format the given package definition(s)---this is the default styling rule. " "For example, a packager running Guix on a checkout (@pxref{Running Guix " "Before It Is Installed}) might want to reformat the definition of the " "Coreutils package like so:" msgstr "" #. type: example #: doc/guix.texi:14363 #, no-wrap msgid "./pre-inst-env guix style coreutils\n" msgstr "" #. type: item #: doc/guix.texi:14365 #, no-wrap msgid "inputs" msgstr "" #. type: table #: doc/guix.texi:14369 msgid "" "Rewrite package inputs to the ``new style'', as described above. This is " "how you would rewrite inputs of package @code{whatnot} in your own channel:" msgstr "" #. type: example #: doc/guix.texi:14372 #, no-wrap msgid "guix style -L ~/my/channel -S inputs whatnot\n" msgstr "" #. type: table #: doc/guix.texi:14378 msgid "" "Rewriting is done in a conservative way: preserving comments and bailing out " "if it cannot make sense of the code that appears in an inputs field. The " "@option{--input-simplification} option described below provides fine-grain " "control over when inputs should be simplified." msgstr "" #. type: item #: doc/guix.texi:14380 #, no-wrap msgid "--list-stylings" msgstr "" #. type: table #: doc/guix.texi:14383 msgid "List and describe the available styling rules and exit." msgstr "" #. type: table #: doc/guix.texi:14392 msgid "Style the package @var{expr} evaluates to." msgstr "" #. type: example #: doc/guix.texi:14397 #, no-wrap msgid "guix style -e '(@@ (gnu packages gcc) gcc-5)'\n" msgstr "" #. type: table #: doc/guix.texi:14400 msgid "styles the @code{gcc-5} package definition." msgstr "" #. type: item #: doc/guix.texi:14401 #, no-wrap msgid "--input-simplification=@var{policy}" msgstr "" #. type: table #: doc/guix.texi:14406 msgid "" "When using the @code{inputs} styling rule, with @samp{-S inputs}, this " "option specifies the package input simplification policy for cases where an " "input label does not match the corresponding package name. @var{policy} may " "be one of the following:" msgstr "" #. type: item #: doc/guix.texi:14408 #, no-wrap msgid "silent" msgstr "" #. type: table #: doc/guix.texi:14411 msgid "" "Simplify inputs only when the change is ``silent'', meaning that the package " "does not need to be rebuilt (its derivation is unchanged)." msgstr "" #. type: item #: doc/guix.texi:14412 #, no-wrap msgid "safe" msgstr "" #. type: table #: doc/guix.texi:14415 msgid "" "Simplify inputs only when that is ``safe'' to do: the package might need to " "be rebuilt, but the change is known to have no observable effect." msgstr "" #. type: table #: doc/guix.texi:14419 msgid "" "Simplify inputs even when input labels do not match package names, and even " "if that might have an observable effect." msgstr "" #. type: table #: doc/guix.texi:14423 msgid "" "The default is @code{silent}, meaning that input simplifications do not " "trigger any package rebuild." msgstr "" #. type: section #: doc/guix.texi:14426 #, no-wrap msgid "Invoking @command{guix lint}" msgstr "" #. type: command{#1} #: doc/guix.texi:14428 #, no-wrap msgid "guix lint" msgstr "" #. type: cindex #: doc/guix.texi:14429 #, no-wrap msgid "package, checking for errors" msgstr "" #. type: Plain text #: doc/guix.texi:14435 msgid "" "The @command{guix lint} command is meant to help package developers avoid " "common errors and use a consistent style. It runs a number of checks on a " "given set of packages in order to find common mistakes in their " "definitions. Available @dfn{checkers} include (see @option{--list-checkers} " "for a complete list):" msgstr "" #. type: table #: doc/guix.texi:14441 msgid "" "Validate certain typographical and stylistic rules about package " "descriptions and synopses." msgstr "" #. type: item #: doc/guix.texi:14442 #, no-wrap msgid "inputs-should-be-native" msgstr "" #. type: table #: doc/guix.texi:14444 msgid "Identify inputs that should most likely be native inputs." msgstr "" #. type: itemx #: doc/guix.texi:14447 #, no-wrap msgid "mirror-url" msgstr "" #. type: itemx #: doc/guix.texi:14448 #, no-wrap msgid "github-url" msgstr "" #. type: itemx #: doc/guix.texi:14449 #, no-wrap msgid "source-file-name" msgstr "" #. type: table #: doc/guix.texi:14456 msgid "" "Probe @code{home-page} and @code{source} URLs and report those that are " "invalid. Suggest a @code{mirror://} URL when applicable. If the " "@code{source} URL redirects to a GitHub URL, recommend usage of the GitHub " "URL@. Check that the source file name is meaningful, e.g.@: is not just a " "version number or ``git-checkout'', without a declared @code{file-name} " "(@pxref{origin Reference})." msgstr "" #. type: item #: doc/guix.texi:14457 #, no-wrap msgid "source-unstable-tarball" msgstr "" #. type: table #: doc/guix.texi:14461 msgid "" "Parse the @code{source} URL to determine if a tarball from GitHub is " "autogenerated or if it is a release tarball. Unfortunately GitHub's " "autogenerated tarballs are sometimes regenerated." msgstr "" #. type: table #: doc/guix.texi:14465 msgid "" "Check that the derivation of the given packages can be successfully computed " "for all the supported systems (@pxref{Derivations})." msgstr "" #. type: item #: doc/guix.texi:14466 #, no-wrap msgid "profile-collisions" msgstr "" #. type: table #: doc/guix.texi:14472 msgid "" "Check whether installing the given packages in a profile would lead to " "collisions. Collisions occur when several packages with the same name but a " "different version or a different store file name are propagated. " "@xref{package Reference, @code{propagated-inputs}}, for more information on " "propagated inputs." msgstr "" #. type: item #: doc/guix.texi:14473 #, no-wrap msgid "archival" msgstr "" #. type: cindex #: doc/guix.texi:14474 #, no-wrap msgid "Software Heritage, source code archive" msgstr "" #. type: cindex #: doc/guix.texi:14475 #, no-wrap msgid "archival of source code, Software Heritage" msgstr "" #. type: table #: doc/guix.texi:14478 msgid "" "Checks whether the package's source code is archived at @uref{https://www." "softwareheritage.org, Software Heritage}." msgstr "" #. type: table #: doc/guix.texi:14486 msgid "" "When the source code that is not archived comes from a version-control " "system (VCS)---e.g., it's obtained with @code{git-fetch}, send Software " "Heritage a ``save'' request so that it eventually archives it. This ensures " "that the source will remain available in the long term, and that Guix can " "fall back to Software Heritage should the source code disappear from its " "original host. The status of recent ``save'' requests can be @uref{https://" "archive.softwareheritage.org/save/#requests, viewed on-line}." msgstr "" #. type: table #: doc/guix.texi:14491 msgid "" "When source code is a tarball obtained with @code{url-fetch}, simply print a " "message when it is not archived. As of this writing, Software Heritage does " "not allow requests to save arbitrary tarballs; we are working on ways to " "ensure that non-VCS source code is also archived." msgstr "" #. type: table #: doc/guix.texi:14497 msgid "" "Software Heritage @uref{https://archive.softwareheritage.org/api/#rate-" "limiting, limits the request rate per IP address}. When the limit is " "reached, @command{guix lint} prints a message and the @code{archival} " "checker stops doing anything until that limit has been reset." msgstr "" #. type: item #: doc/guix.texi:14498 #, no-wrap msgid "cve" msgstr "" #. type: cindex #: doc/guix.texi:14499 doc/guix.texi:42921 #, no-wrap msgid "security vulnerabilities" msgstr "" #. type: cindex #: doc/guix.texi:14500 #, no-wrap msgid "CVE, Common Vulnerabilities and Exposures" msgstr "" #. type: table #: doc/guix.texi:14505 msgid "" "Report known vulnerabilities found in the Common Vulnerabilities and " "Exposures (CVE) databases of the current and past year @uref{https://nvd." "nist.gov/vuln/data-feeds, published by the US NIST}." msgstr "" #. type: table #: doc/guix.texi:14507 msgid "" "To view information about a particular vulnerability, visit pages such as:" msgstr "" #. type: indicateurl{#1} #: doc/guix.texi:14511 msgid "https://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-YYYY-ABCD" msgstr "" #. type: indicateurl{#1} #: doc/guix.texi:14513 msgid "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-YYYY-ABCD" msgstr "" #. type: table #: doc/guix.texi:14518 msgid "" "where @code{CVE-YYYY-ABCD} is the CVE identifier---e.g., " "@code{CVE-2015-7554}." msgstr "" #. type: table #: doc/guix.texi:14523 msgid "" "Package developers can specify in package recipes the @uref{https://nvd.nist." "gov/products/cpe,Common Platform Enumeration (CPE)} name and version of the " "package when they differ from the name or version that Guix uses, as in this " "example:" msgstr "" #. type: lisp #: doc/guix.texi:14531 #, 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:14538 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: lisp #: doc/guix.texi:14548 #, 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:14550 #, no-wrap msgid "formatting" msgstr "" #. type: table #: doc/guix.texi:14553 msgid "" "Warn about obvious source code formatting issues: trailing white space, use " "of tabulations, etc." msgstr "" #. type: item #: doc/guix.texi:14554 #, no-wrap msgid "input-labels" msgstr "" #. type: table #: doc/guix.texi:14560 msgid "" "Report old-style input labels that do not match the name of the " "corresponding package. This aims to help migrate from the ``old input " "style''. @xref{package Reference}, for more information on package inputs " "and input styles. @xref{Invoking guix style}, on how to migrate to the new " "style." msgstr "" #. type: example #: doc/guix.texi:14566 #, no-wrap msgid "guix lint @var{options} @var{package}@dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:14570 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:14572 #, no-wrap msgid "--list-checkers" msgstr "" #. type: table #: doc/guix.texi:14576 msgid "" "List and describe all the available checkers that will be run on packages " "and exit." msgstr "" #. type: item #: doc/guix.texi:14577 #, no-wrap msgid "--checkers" msgstr "" #. type: itemx #: doc/guix.texi:14578 #, no-wrap msgid "-c" msgstr "" #. type: table #: doc/guix.texi:14581 msgid "" "Only enable the checkers specified in a comma-separated list using the names " "returned by @option{--list-checkers}." msgstr "" #. type: item #: doc/guix.texi:14582 #, no-wrap msgid "--exclude" msgstr "" #. type: table #: doc/guix.texi:14586 msgid "" "Only disable the checkers specified in a comma-separated list using the " "names returned by @option{--list-checkers}." msgstr "" #. type: table #: doc/guix.texi:14592 msgid "This is useful to unambiguously designate packages, as in this example:" msgstr "" #. type: example #: doc/guix.texi:14595 #, no-wrap msgid "guix lint -c archival -e '(@@ (gnu packages guile) guile-3.0)'\n" msgstr "" #. type: item #: doc/guix.texi:14597 #, no-wrap msgid "--no-network" msgstr "" #. type: table #: doc/guix.texi:14600 msgid "Only enable the checkers that do not depend on Internet access." msgstr "" #. type: section #: doc/guix.texi:14612 #, no-wrap msgid "Invoking @command{guix size}" msgstr "" #. type: code{#1} #: doc/guix.texi:14614 doc/guix.texi:39186 #, no-wrap msgid "size" msgstr "" #. type: cindex #: doc/guix.texi:14615 #, no-wrap msgid "package size" msgstr "" #. type: command{#1} #: doc/guix.texi:14617 #, no-wrap msgid "guix size" msgstr "" #. type: Plain text #: doc/guix.texi:14624 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:14629 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:14642 #, 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:14648 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:14651 #, no-wrap msgid "$ guix gc -R /gnu/store/@dots{}-coreutils-8.23\n" msgstr "" #. type: Plain text #: doc/guix.texi:14659 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:14665 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:14668 msgid "" "Since the command also accepts store file names, assessing the size of a " "build result is straightforward:" msgstr "" #. type: example #: doc/guix.texi:14671 #, no-wrap msgid "guix size $(guix system build config.scm)\n" msgstr "" #. type: Plain text #: doc/guix.texi:14681 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:14686 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:14688 msgid "You can also specify several package names:" msgstr "" #. type: example #: doc/guix.texi:14698 #, 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:14704 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:14710 msgid "" "When looking at the profile returned by @command{guix size}, you may find " "yourself wondering why a given package shows up in the profile at all. To " "understand it, you can use @command{guix graph --path -t references} to " "display the shortest path between the two packages (@pxref{Invoking guix " "graph})." msgstr "" #. type: Plain text #: doc/guix.texi:14712 msgid "The available options are:" msgstr "" #. type: table #: doc/guix.texi:14718 msgid "" "Use substitute information from @var{urls}. @xref{client-substitute-urls, " "the same option for @code{guix build}}." msgstr "" #. type: item #: doc/guix.texi:14719 #, no-wrap msgid "--sort=@var{key}" msgstr "" #. type: table #: doc/guix.texi:14721 msgid "Sort lines according to @var{key}, one of the following options:" msgstr "" #. type: item #: doc/guix.texi:14723 #, no-wrap msgid "self" msgstr "" #. type: table #: doc/guix.texi:14725 msgid "the size of each item (the default);" msgstr "" #. type: table #: doc/guix.texi:14727 msgid "the total size of the item's closure." msgstr "" #. type: item #: doc/guix.texi:14729 #, no-wrap msgid "--map-file=@var{file}" msgstr "" #. type: table #: doc/guix.texi:14731 msgid "Write a graphical map of disk usage in PNG format to @var{file}." msgstr "" #. type: table #: doc/guix.texi:14733 msgid "For the example above, the map looks like this:" msgstr "" #. type: table #: doc/guix.texi:14736 msgid "" "@image{images/coreutils-size-map,5in,, map of Coreutils disk usage produced " "by @command{guix size}}" msgstr "" #. type: table #: doc/guix.texi:14741 msgid "" "This option requires that @uref{https://wingolog.org/software/guile-" "charting/, Guile-Charting} be installed and visible in Guile's module search " "path. When that is not the case, @command{guix size} fails as it tries to " "load it." msgstr "" #. type: table #: doc/guix.texi:14745 msgid "Consider packages for @var{system}---e.g., @code{x86_64-linux}." msgstr "" #. type: section #: doc/guix.texi:14756 #, no-wrap msgid "Invoking @command{guix graph}" msgstr "" #. type: cindex #: doc/guix.texi:14758 #, no-wrap msgid "DAG" msgstr "" #. type: command{#1} #: doc/guix.texi:14759 #, no-wrap msgid "guix graph" msgstr "" #. type: Plain text #: doc/guix.texi:14774 msgid "" "Packages and their dependencies form a @dfn{graph}, specifically a directed " "acyclic graph (DAG). It can quickly become difficult to have a mental model " "of the package DAG, so the @command{guix graph} command provides a visual " "representation of the DAG@. By default, @command{guix graph} emits a DAG " "representation in the input format of @uref{https://www.graphviz.org/, " "Graphviz}, so its output can be passed directly to the @command{dot} command " "of Graphviz. It can also emit an HTML page with embedded JavaScript code to " "display a ``chord diagram'' in a Web browser, using the @uref{https://d3js." "org/, d3.js} library, or emit Cypher queries to construct a graph in a graph " "database supporting the @uref{https://www.opencypher.org/, openCypher} query " "language. With @option{--path}, it simply displays the shortest path " "between two packages. The general syntax is:" msgstr "" #. type: example #: doc/guix.texi:14777 #, no-wrap msgid "guix graph @var{options} @var{package}@dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:14782 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:14785 #, no-wrap msgid "guix graph coreutils | dot -Tpdf > dag.pdf\n" msgstr "" #. type: Plain text #: doc/guix.texi:14788 msgid "The output looks like this:" msgstr "" #. type: Plain text #: doc/guix.texi:14790 msgid "" "@image{images/coreutils-graph,2in,,Dependency graph of the GNU Coreutils}" msgstr "" #. type: Plain text #: doc/guix.texi:14792 msgid "Nice little graph, no?" msgstr "" #. type: Plain text #: doc/guix.texi:14795 msgid "" "You may find it more pleasant to navigate the graph interactively with " "@command{xdot} (from the @code{xdot} package):" msgstr "" #. type: example #: doc/guix.texi:14798 #, no-wrap msgid "guix graph coreutils | xdot -\n" msgstr "" #. type: Plain text #: doc/guix.texi:14805 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:14811 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:14812 #, no-wrap msgid "reverse-package" msgstr "" #. type: table #: doc/guix.texi:14814 msgid "This shows the @emph{reverse} DAG of packages. For example:" msgstr "" #. type: example #: doc/guix.texi:14817 #, no-wrap msgid "guix graph --type=reverse-package ocaml\n" msgstr "" #. type: table #: doc/guix.texi:14822 msgid "" "...@: yields the graph of packages that @emph{explicitly} depend on OCaml " "(if you are also interested in cases where OCaml is an implicit dependency, " "see @code{reverse-bag} below)." msgstr "" #. type: table #: doc/guix.texi:14827 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:14828 #, no-wrap msgid "bag-emerged" msgstr "" #. type: table #: doc/guix.texi:14830 msgid "This is the package DAG, @emph{including} implicit inputs." msgstr "" #. type: table #: doc/guix.texi:14832 msgid "For instance, the following command:" msgstr "" #. type: example #: doc/guix.texi:14835 #, no-wrap msgid "guix graph --type=bag-emerged coreutils\n" msgstr "" #. type: table #: doc/guix.texi:14838 msgid "...@: yields this bigger graph:" msgstr "" #. type: table #: doc/guix.texi:14840 msgid "" "@image{images/coreutils-bag-graph,,5in,Detailed dependency graph of the GNU " "Coreutils}" msgstr "" #. type: table #: doc/guix.texi:14843 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:14847 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:14848 #, no-wrap msgid "bag" msgstr "" #. type: table #: doc/guix.texi:14851 msgid "" "Similar to @code{bag-emerged}, but this time including all the bootstrap " "dependencies." msgstr "" #. type: item #: doc/guix.texi:14852 #, no-wrap msgid "bag-with-origins" msgstr "" #. type: table #: doc/guix.texi:14854 msgid "Similar to @code{bag}, but also showing origins and their dependencies." msgstr "" #. type: item #: doc/guix.texi:14855 #, no-wrap msgid "reverse-bag" msgstr "" #. type: table #: doc/guix.texi:14858 msgid "" "This shows the @emph{reverse} DAG of packages. Unlike @code{reverse-" "package}, it also takes implicit dependencies into account. For example:" msgstr "" #. type: example #: doc/guix.texi:14861 #, no-wrap msgid "guix graph -t reverse-bag dune\n" msgstr "" #. type: table #: doc/guix.texi:14868 msgid "" "...@: yields the graph of all packages that depend on Dune, directly or " "indirectly. Since Dune is an @emph{implicit} dependency of many packages " "@i{via} @code{dune-build-system}, this shows a large number of packages, " "whereas @code{reverse-package} would show very few if any." msgstr "" #. type: table #: doc/guix.texi:14874 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:14877 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:14880 #, no-wrap msgid "guix graph -t derivation $(guix system build -d my-config.scm)\n" msgstr "" #. type: item #: doc/guix.texi:14882 #, no-wrap msgid "module" msgstr "" #. type: table #: doc/guix.texi:14886 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:14889 #, no-wrap msgid "guix graph -t module guile | xdot -\n" msgstr "" #. type: Plain text #: doc/guix.texi:14894 msgid "" "All the types above correspond to @emph{build-time dependencies}. The " "following graph type represents the @emph{run-time dependencies}:" msgstr "" #. type: table #: doc/guix.texi:14899 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:14902 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:14906 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:14909 #, no-wrap msgid "guix graph -t references $(readlink -f ~/.guix-profile)\n" msgstr "" #. type: item #: doc/guix.texi:14911 #, no-wrap msgid "referrers" msgstr "" #. type: table #: doc/guix.texi:14914 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:14920 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:14923 msgid "" "It can help determine what is preventing a store item from being garbage " "collected." msgstr "" #. type: cindex #: doc/guix.texi:14926 #, no-wrap msgid "shortest path, between packages" msgstr "" #. type: Plain text #: doc/guix.texi:14933 msgid "" "Often, the graph of the package you are interested in does not fit on your " "screen, and anyway all you want to know is @emph{why} that package actually " "depends on some seemingly unrelated package. The @option{--path} option " "instructs @command{guix graph} to display the shortest path between two " "packages (or derivations, or store items, etc.):" msgstr "" #. type: example #: doc/guix.texi:14947 #, no-wrap msgid "" "$ guix graph --path emacs libunistring\n" "emacs@@26.3\n" "mailutils@@3.9\n" "libunistring@@0.9.10\n" "$ guix graph --path -t derivation emacs libunistring\n" "/gnu/store/@dots{}-emacs-26.3.drv\n" "/gnu/store/@dots{}-mailutils-3.9.drv\n" "/gnu/store/@dots{}-libunistring-0.9.10.drv\n" "$ guix graph --path -t references emacs libunistring\n" "/gnu/store/@dots{}-emacs-26.3\n" "/gnu/store/@dots{}-libidn2-2.2.0\n" "/gnu/store/@dots{}-libunistring-0.9.10\n" msgstr "" #. type: Plain text #: doc/guix.texi:14955 msgid "" "Sometimes you still want to visualize the graph but would like to trim it so " "it can actually be displayed. One way to do it is via the @option{--max-" "depth} (or @option{-M}) option, which lets you specify the maximum depth of " "the graph. In the example below, we visualize only @code{libreoffice} and " "the nodes whose distance to @code{libreoffice} is at most 2:" msgstr "" #. type: example #: doc/guix.texi:14958 #, no-wrap msgid "guix graph -M 2 libreoffice | xdot -f fdp -\n" msgstr "" #. type: Plain text #: doc/guix.texi:14962 msgid "" "Mind you, that's still a big ball of spaghetti, but at least @command{dot} " "can render it quickly and it can be browsed somewhat." msgstr "" #. type: Plain text #: doc/guix.texi:14964 msgid "The available options are the following:" msgstr "" #. type: table #: doc/guix.texi:14970 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:14971 #, no-wrap msgid "--list-types" msgstr "" #. type: table #: doc/guix.texi:14973 msgid "List the supported graph types." msgstr "" #. type: item #: doc/guix.texi:14974 #, no-wrap msgid "--backend=@var{backend}" msgstr "" #. type: itemx #: doc/guix.texi:14975 #, no-wrap msgid "-b @var{backend}" msgstr "" #. type: table #: doc/guix.texi:14977 msgid "Produce a graph using the selected @var{backend}." msgstr "" #. type: item #: doc/guix.texi:14978 #, no-wrap msgid "--list-backends" msgstr "" #. type: table #: doc/guix.texi:14980 msgid "List the supported graph backends." msgstr "" #. type: table #: doc/guix.texi:14982 msgid "Currently, the available backends are Graphviz and d3.js." msgstr "" #. type: item #: doc/guix.texi:14983 #, no-wrap msgid "--path" msgstr "" #. type: table #: doc/guix.texi:14988 msgid "" "Display the shortest path between two nodes of the type specified by " "@option{--type}. The example below shows the shortest path between " "@code{libreoffice} and @code{llvm} according to the references of " "@code{libreoffice}:" msgstr "" #. type: example #: doc/guix.texi:14995 #, no-wrap msgid "" "$ guix graph --path -t references libreoffice llvm\n" "/gnu/store/@dots{}-libreoffice-6.4.2.2\n" "/gnu/store/@dots{}-libepoxy-1.5.4\n" "/gnu/store/@dots{}-mesa-19.3.4\n" "/gnu/store/@dots{}-llvm-9.0.1\n" msgstr "" #. type: example #: doc/guix.texi:15005 #, no-wrap msgid "guix graph -e '(@@@@ (gnu packages commencement) gnu-make-final)'\n" msgstr "" #. type: table #: doc/guix.texi:15010 msgid "Display the graph for @var{system}---e.g., @code{i686-linux}." msgstr "" #. type: table #: doc/guix.texi:15013 msgid "" "The package dependency graph is largely architecture-independent, but there " "are some architecture-dependent bits that this option allows you to " "visualize." msgstr "" #. type: Plain text #: doc/guix.texi:15029 msgid "" "On top of that, @command{guix graph} supports all the usual package " "transformation options (@pxref{Package Transformation Options}). This makes " "it easy to view the effect of a graph-rewriting transformation such as " "@option{--with-input}. For example, the command below outputs the graph of " "@code{git} once @code{openssl} has been replaced by @code{libressl} " "everywhere in the graph:" msgstr "" #. type: example #: doc/guix.texi:15032 #, no-wrap msgid "guix graph git --with-input=openssl=libressl\n" msgstr "" #. type: Plain text #: doc/guix.texi:15035 msgid "So many possibilities, so much fun!" msgstr "" #. type: section #: doc/guix.texi:15037 #, no-wrap msgid "Invoking @command{guix publish}" msgstr "" #. type: command{#1} #: doc/guix.texi:15039 #, no-wrap msgid "guix publish" msgstr "" #. type: Plain text #: doc/guix.texi:15043 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:15049 msgid "" "When @command{guix publish} runs, it spawns an HTTP server which allows " "anyone with network access to obtain substitutes from it. This means that " "any machine running Guix can also act as if it were a build farm, since the " "HTTP interface is compatible with Cuirass, the software behind the " "@code{@value{SUBSTITUTE-SERVER-1}} build farm." msgstr "" #. type: Plain text #: doc/guix.texi:15055 msgid "" "For security, each substitute is signed, allowing recipients to check their " "authenticity and integrity (@pxref{Substitutes}). Because @command{guix " "publish} uses the signing key of the system, which is only readable by the " "system administrator, it must be started as root; the @option{--user} option " "makes it drop root privileges early on." msgstr "" #. type: Plain text #: doc/guix.texi:15059 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: Plain text #: doc/guix.texi:15064 msgid "" "When the @option{--advertise} option is passed, the server advertises its " "availability on the local network using multicast DNS (mDNS) and DNS service " "discovery (DNS-SD), currently @i{via} Guile-Avahi (@pxref{Top,,, guile-" "avahi, Using Avahi in Guile Scheme Programs})." msgstr "" #. type: example #: doc/guix.texi:15069 #, no-wrap msgid "guix publish @var{options}@dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:15073 msgid "" "Running @command{guix publish} without any additional arguments will spawn " "an HTTP server on port 8080:" msgstr "" #. type: example #: doc/guix.texi:15076 #, no-wrap msgid "guix publish\n" msgstr "" #. type: cindex #: doc/guix.texi:15078 #, no-wrap msgid "socket activation, for @command{guix publish}" msgstr "" #. type: Plain text #: doc/guix.texi:15082 msgid "" "@command{guix publish} can also be started following the systemd ``socket " "activation'' protocol (@pxref{Service De- and Constructors, @code{make-" "systemd-constructor},, shepherd, The GNU Shepherd Manual})." msgstr "" #. type: Plain text #: doc/guix.texi:15085 msgid "" "Once a publishing server has been authorized, the daemon may download " "substitutes from it. @xref{Getting Substitutes from Other Servers}." msgstr "" #. type: Plain text #: doc/guix.texi:15093 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:15100 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:15103 #, no-wrap msgid "http://example.org/file/hello-2.10.tar.gz/sha256/0ssi1@dots{}ndq1i\n" msgstr "" #. type: Plain text #: doc/guix.texi:15107 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:15108 #, no-wrap msgid "build logs, publication" msgstr "" #. type: Plain text #: doc/guix.texi:15110 msgid "Build logs are available from @code{/log} URLs like:" msgstr "" #. type: example #: doc/guix.texi:15113 #, no-wrap msgid "http://example.org/log/gwspk@dots{}-guile-2.2.3\n" msgstr "" #. type: Plain text #: doc/guix.texi:15123 msgid "" "When @command{guix-daemon} is configured to save compressed build logs, as " "is the case by default (@pxref{Invoking guix-daemon}), @code{/log} URLs " "return the compressed log as-is, with an appropriate @code{Content-Type} and/" "or @code{Content-Encoding} header. We recommend running @command{guix-" "daemon} with @option{--log-compression=gzip} since Web browsers can " "automatically decompress it, which is not the case with Bzip2 compression." msgstr "" #. type: item #: doc/guix.texi:15127 #, no-wrap msgid "--port=@var{port}" msgstr "" #. type: itemx #: doc/guix.texi:15128 #, no-wrap msgid "-p @var{port}" msgstr "" #. type: table #: doc/guix.texi:15130 msgid "Listen for HTTP requests on @var{port}." msgstr "" #. type: item #: doc/guix.texi:15131 #, no-wrap msgid "--listen=@var{host}" msgstr "" #. type: table #: doc/guix.texi:15134 msgid "" "Listen on the network interface for @var{host}. The default is to accept " "connections from any interface." msgstr "" #. type: table #: doc/guix.texi:15139 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:15140 #, no-wrap msgid "--compression[=@var{method}[:@var{level}]]" msgstr "" #. type: itemx #: doc/guix.texi:15141 #, no-wrap msgid "-C [@var{method}[:@var{level}]]" msgstr "" #. type: table #: doc/guix.texi:15145 msgid "" "Compress data using the given @var{method} and @var{level}. @var{method} is " "one of @code{lzip}, @code{zstd}, and @code{gzip}; when @var{method} is " "omitted, @code{gzip} is used." msgstr "" #. type: table #: doc/guix.texi:15149 msgid "" "When @var{level} is zero, disable compression. The range 1 to 9 corresponds " "to different compression levels: 1 is the fastest, and 9 is the best (CPU-" "intensive). The default is 3." msgstr "" #. type: table #: doc/guix.texi:15156 msgid "" "Usually, @code{lzip} compresses noticeably better than @code{gzip} for a " "small increase in CPU usage; see @uref{https://nongnu.org/lzip/" "lzip_benchmark.html,benchmarks on the lzip Web page}. However, @code{lzip} " "achieves low decompression throughput (on the order of 50@tie{}MiB/s on " "modern hardware), which can be a bottleneck for someone who downloads over a " "fast network connection." msgstr "" #. type: table #: doc/guix.texi:15160 msgid "" "The compression ratio of @code{zstd} is between that of @code{lzip} and that " "of @code{gzip}; its main advantage is a @uref{https://facebook.github.io/" "zstd/,high decompression speed}." msgstr "" #. type: table #: doc/guix.texi:15169 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: table #: doc/guix.texi:15174 msgid "" "This option can be repeated, in which case every substitute gets compressed " "using all the selected methods, and all of them are advertised. This is " "useful when users may not support all the compression methods: they can " "select the one they support." msgstr "" #. type: item #: doc/guix.texi:15175 #, no-wrap msgid "--cache=@var{directory}" msgstr "" #. type: itemx #: doc/guix.texi:15176 #, no-wrap msgid "-c @var{directory}" msgstr "" #. type: table #: doc/guix.texi:15179 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:15187 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:15195 msgid "" "Conversely, when @option{--cache} is used, the first request for a store " "item (@i{via} a @code{.narinfo} URL) triggers a background process to " "@dfn{bake} the archive---computing its @code{.narinfo} and compressing the " "archive, if needed. Once the archive is cached in @var{directory}, " "subsequent requests succeed and are served directly from the cache, which " "guarantees that clients get the best possible bandwidth." msgstr "" #. type: table #: doc/guix.texi:15202 msgid "" "That first @code{.narinfo} request nonetheless returns 200, provided the " "requested store item is ``small enough'', below the cache bypass threshold---" "see @option{--cache-bypass-threshold} below. That way, clients do not have " "to wait until the archive is baked. For larger store items, the first " "@code{.narinfo} request returns 404, meaning that clients have to wait until " "the archive is baked." msgstr "" #. type: table #: doc/guix.texi:15206 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:15209 msgid "" "When @option{--ttl} is used, cached entries are automatically deleted when " "they have expired." msgstr "" #. type: item #: doc/guix.texi:15210 #, no-wrap msgid "--workers=@var{N}" msgstr "" #. type: table #: doc/guix.texi:15213 msgid "" "When @option{--cache} is used, request the allocation of @var{N} worker " "threads to ``bake'' archives." msgstr "" #. type: item #: doc/guix.texi:15214 #, no-wrap msgid "--ttl=@var{ttl}" msgstr "" #. type: table #: doc/guix.texi:15218 doc/guix.texi:36436 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:15223 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:15227 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:15228 #, no-wrap msgid "--negative-ttl=@var{ttl}" msgstr "" #. type: table #: doc/guix.texi:15233 doc/guix.texi:36445 msgid "" "Similarly produce @code{Cache-Control} HTTP headers to advertise the time-to-" "live (TTL) of @emph{negative} lookups---missing store items, for which the " "HTTP 404 code is returned. By default, no negative TTL is advertised." msgstr "" #. type: table #: doc/guix.texi:15237 msgid "" "This parameter can help adjust server load and substitute latency by " "instructing cooperating clients to be more or less patient when a store item " "is missing." msgstr "" #. type: item #: doc/guix.texi:15238 #, no-wrap msgid "--cache-bypass-threshold=@var{size}" msgstr "" #. type: table #: doc/guix.texi:15243 msgid "" "When used in conjunction with @option{--cache}, store items smaller than " "@var{size} are immediately available, even when they are not yet in cache. " "@var{size} is a size in bytes, or it can be suffixed by @code{M} for " "megabytes and so on. The default is @code{10M}." msgstr "" #. type: table #: doc/guix.texi:15248 msgid "" "``Cache bypass'' allows you to reduce the publication delay for clients at " "the expense of possibly additional I/O and CPU use on the server side: " "depending on the client access patterns, those store items can end up being " "baked several times until a copy is available in cache." msgstr "" #. type: table #: doc/guix.texi:15252 msgid "" "Increasing the threshold may be useful for sites that have few users, or to " "guarantee that users get substitutes even for store items that are not " "popular." msgstr "" #. type: item #: doc/guix.texi:15253 #, no-wrap msgid "--nar-path=@var{path}" msgstr "" #. type: table #: doc/guix.texi:15256 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:15260 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:15261 #, no-wrap msgid "--public-key=@var{file}" msgstr "" #. type: itemx #: doc/guix.texi:15262 #, no-wrap msgid "--private-key=@var{file}" msgstr "" #. type: table #: doc/guix.texi:15265 doc/guix.texi:32123 doc/guix.texi:32160 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:15272 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:15273 #, no-wrap msgid "--repl[=@var{port}]" msgstr "" #. type: itemx #: doc/guix.texi:15274 #, no-wrap msgid "-r [@var{port}]" msgstr "" #. type: table #: doc/guix.texi:15278 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:15284 msgid "" "Enabling @command{guix publish} on Guix System is a one-liner: just " "instantiate a @code{guix-publish-service-type} service in the " "@code{services} field of the @code{operating-system} declaration " "(@pxref{guix-publish-service-type, @code{guix-publish-service-type}})." msgstr "" #. type: Plain text #: doc/guix.texi:15287 msgid "" "If you are instead running Guix on a ``foreign distro'', follow these " "instructions:" msgstr "" #. type: itemize #: doc/guix.texi:15291 msgid "If your host distro uses the systemd init system:" msgstr "" #. type: example #: doc/guix.texi:15296 #, 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:15304 #, 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:15308 msgid "Otherwise, proceed similarly with your distro's init system." msgstr "" #. type: section #: doc/guix.texi:15311 #, no-wrap msgid "Invoking @command{guix challenge}" msgstr "" #. type: cindex #: doc/guix.texi:15314 #, no-wrap msgid "verifiable builds" msgstr "" #. type: command{#1} #: doc/guix.texi:15315 #, no-wrap msgid "guix challenge" msgstr "" #. type: cindex #: doc/guix.texi:15316 #, no-wrap msgid "challenge" msgstr "" #. type: Plain text #: doc/guix.texi:15321 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:15329 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:15338 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:15340 msgid "The command output looks like this:" msgstr "" #. type: smallexample #: doc/guix.texi:15354 #, no-wrap msgid "" "$ guix challenge \\\n" " --substitute-urls=\"https://@value{SUBSTITUTE-SERVER-1} https://guix.example.org\" \\\n" " openssl git pius coreutils grep\n" "updating substitutes from 'https://@value{SUBSTITUTE-SERVER-1}'... 100.0%\n" "updating substitutes from 'https://guix.example.org'... 100.0%\n" "/gnu/store/@dots{}-openssl-1.0.2d contents differ:\n" " local hash: 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q\n" " https://@value{SUBSTITUTE-SERVER-1}/nar/@dots{}-openssl-1.0.2d: 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q\n" " https://guix.example.org/nar/@dots{}-openssl-1.0.2d: 1zy4fmaaqcnjrzzajkdn3f5gmjk754b43qkq47llbyak9z0qjyim\n" " differing files:\n" " /lib/libcrypto.so.1.1\n" " /lib/libssl.so.1.1\n" "\n" msgstr "" #. type: smallexample #: doc/guix.texi:15361 #, no-wrap msgid "" "/gnu/store/@dots{}-git-2.5.0 contents differ:\n" " local hash: 00p3bmryhjxrhpn2gxs2fy0a15lnip05l97205pgbk5ra395hyha\n" " https://@value{SUBSTITUTE-SERVER-1}/nar/@dots{}-git-2.5.0: 069nb85bv4d4a6slrwjdy8v1cn4cwspm3kdbmyb81d6zckj3nq9f\n" " https://guix.example.org/nar/@dots{}-git-2.5.0: 0mdqa9w1p6cmli6976v4wi0sw9r4p5prkj7lzfd1877wk11c9c73\n" " differing file:\n" " /libexec/git-core/git-fsck\n" "\n" msgstr "" #. type: smallexample #: doc/guix.texi:15368 #, no-wrap msgid "" "/gnu/store/@dots{}-pius-2.1.1 contents differ:\n" " local hash: 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax\n" " https://@value{SUBSTITUTE-SERVER-1}/nar/@dots{}-pius-2.1.1: 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax\n" " https://guix.example.org/nar/@dots{}-pius-2.1.1: 1cy25x1a4fzq5rk0pmvc8xhwyffnqz95h2bpvqsz2mpvlbccy0gs\n" " differing file:\n" " /share/man/man1/pius.1.gz\n" "\n" msgstr "" #. type: smallexample #: doc/guix.texi:15370 #, no-wrap msgid "" "@dots{}\n" "\n" msgstr "" #. type: smallexample #: doc/guix.texi:15375 #, no-wrap msgid "" "5 store items were analyzed:\n" " - 2 (40.0%) were identical\n" " - 3 (60.0%) differed\n" " - 0 (0.0%) were inconclusive\n" msgstr "" #. type: Plain text #: doc/guix.texi:15385 msgid "" "In this example, @command{guix challenge} queries all the substitute servers " "for each of the fives packages specified on the command line. It then " "reports those store items for which the servers obtained a result different " "from the local build (if it exists) and/or different from one another; here, " "the @samp{local hash} lines indicate that a local build result was available " "for each of these packages and shows its hash." msgstr "" #. type: cindex #: doc/guix.texi:15386 #, no-wrap msgid "non-determinism, in package builds" msgstr "" #. type: Plain text #: doc/guix.texi:15397 msgid "" "As an example, @code{guix.example.org} always gets a different answer. " "Conversely, @code{@value{SUBSTITUTE-SERVER-1}} 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:15400 msgid "" "To find out what is wrong with this Git binary, the easiest approach is to " "run:" msgstr "" #. type: example #: doc/guix.texi:15405 #, no-wrap msgid "" "guix challenge git \\\n" " --diff=diffoscope \\\n" " --substitute-urls=\"https://@value{SUBSTITUTE-SERVER-1} https://guix.example.org\"\n" msgstr "" #. type: Plain text #: doc/guix.texi:15409 msgid "" "This automatically invokes @command{diffoscope}, which displays detailed " "information about files that differ." msgstr "" #. type: Plain text #: doc/guix.texi:15412 msgid "" "Alternatively, we can do something along these lines (@pxref{Invoking guix " "archive}):" msgstr "" #. type: example #: doc/guix.texi:15417 #, no-wrap msgid "" "$ wget -q -O - https://@value{SUBSTITUTE-SERVER-1}/nar/lzip/@dots{}-git-2.5.0 \\\n" " | lzip -d | 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:15426 msgid "" "This command shows the difference between the files resulting from the local " "build, and the files resulting from the build on @code{@value{SUBSTITUTE-" "SERVER-1}} (@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:15434 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:15438 msgid "" "If you are writing packages for Guix, you are encouraged to check whether " "@code{@value{SUBSTITUTE-SERVER-1}} and other substitute servers obtain the " "same build result as you did with:" msgstr "" #. type: example #: doc/guix.texi:15441 #, no-wrap msgid "guix challenge @var{package}\n" msgstr "" #. type: example #: doc/guix.texi:15447 #, no-wrap msgid "guix challenge @var{options} @var{argument}@dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:15454 msgid "" "where @var{argument} is a package specification such as @code{guile@@2.0} or " "@code{glibc:debug} or, alternatively, a store file name as returned, for " "example, by @command{guix build} or @command{guix gc --list-live}." msgstr "" #. type: Plain text #: doc/guix.texi:15460 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:15462 msgid "The one option that matters is:" msgstr "" #. type: table #: doc/guix.texi:15468 msgid "" "Consider @var{urls} the whitespace-separated list of substitute source URLs " "to compare to." msgstr "" #. type: item #: doc/guix.texi:15469 #, no-wrap msgid "--diff=@var{mode}" msgstr "" #. type: table #: doc/guix.texi:15471 msgid "Upon mismatches, show differences according to @var{mode}, one of:" msgstr "" #. type: item #: doc/guix.texi:15473 #, no-wrap msgid "@code{simple} (the default)" msgstr "" #. type: table #: doc/guix.texi:15475 msgid "Show the list of files that differ." msgstr "" #. type: code{#1} #: doc/guix.texi:15476 #, no-wrap msgid "diffoscope" msgstr "" #. type: var{#1} #: doc/guix.texi:15477 #, no-wrap msgid "command" msgstr "" #. type: table #: doc/guix.texi:15480 msgid "" "Invoke @uref{https://diffoscope.org/, Diffoscope}, passing it two " "directories whose contents do not match." msgstr "" #. type: table #: doc/guix.texi:15483 msgid "" "When @var{command} is an absolute file name, run @var{command} instead of " "Diffoscope." msgstr "" #. type: table #: doc/guix.texi:15486 msgid "Do not show further details about the differences." msgstr "" #. type: table #: doc/guix.texi:15491 msgid "" "Thus, unless @option{--diff=none} is passed, @command{guix challenge} " "downloads the store items from the given substitute servers so that it can " "compare them." msgstr "" #. type: item #: doc/guix.texi:15492 #, no-wrap msgid "--verbose" msgstr "" #. type: itemx #: doc/guix.texi:15493 #, no-wrap msgid "-v" msgstr "" #. type: table #: doc/guix.texi:15496 msgid "" "Show details about matches (identical contents) in addition to information " "about mismatches." msgstr "" #. type: section #: doc/guix.texi:15500 #, no-wrap msgid "Invoking @command{guix copy}" msgstr "" #. type: command{#1} #: doc/guix.texi:15502 #, no-wrap msgid "guix copy" msgstr "" #. type: cindex #: doc/guix.texi:15503 #, no-wrap msgid "copy, of store items, over SSH" msgstr "" #. type: cindex #: doc/guix.texi:15504 #, no-wrap msgid "SSH, copy of store items" msgstr "" #. type: cindex #: doc/guix.texi:15505 #, no-wrap msgid "sharing store items across machines" msgstr "" #. type: cindex #: doc/guix.texi:15506 #, no-wrap msgid "transferring store items across machines" msgstr "" #. type: Plain text #: doc/guix.texi:15513 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:15517 #, no-wrap msgid "" "guix copy --to=@var{user}@@@var{host} \\\n" " coreutils $(readlink -f ~/.guix-profile)\n" msgstr "" #. type: Plain text #: doc/guix.texi:15521 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:15524 msgid "" "The command below retrieves @code{libreoffice} and @code{gimp} from " "@var{host}, assuming they are available there:" msgstr "" #. type: example #: doc/guix.texi:15527 #, no-wrap msgid "guix copy --from=@var{host} libreoffice gimp\n" msgstr "" #. type: Plain text #: doc/guix.texi:15532 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:15538 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:15543 #, no-wrap msgid "guix copy [--to=@var{spec}|--from=@var{spec}] @var{items}@dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:15546 msgid "You must always specify one of the following options:" msgstr "" #. type: item #: doc/guix.texi:15548 #, no-wrap msgid "--to=@var{spec}" msgstr "" #. type: itemx #: doc/guix.texi:15549 #, no-wrap msgid "--from=@var{spec}" msgstr "" #. type: table #: doc/guix.texi:15553 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:15557 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:15561 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:15564 #, no-wrap msgid "Invoking @command{guix container}" msgstr "" #. type: command{#1} #: doc/guix.texi:15566 #, no-wrap msgid "guix container" msgstr "" #. type: quotation #: doc/guix.texi:15570 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:15577 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 shell} (@pxref{Invoking guix shell}) and " "@command{guix system container} (@pxref{Invoking guix system}) commands." msgstr "" #. type: example #: doc/guix.texi:15582 #, no-wrap msgid "guix container @var{action} @var{options}@dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:15586 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:15588 msgid "The following actions are available:" msgstr "" #. type: item #: doc/guix.texi:15590 #, no-wrap msgid "exec" msgstr "" #. type: table #: doc/guix.texi:15592 msgid "Execute a command within the context of a running container." msgstr "" #. type: table #: doc/guix.texi:15594 msgid "The syntax is:" msgstr "" #. type: example #: doc/guix.texi:15597 #, no-wrap msgid "guix container exec @var{pid} @var{program} @var{arguments}@dots{}\n" msgstr "" #. type: table #: doc/guix.texi:15603 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:15607 msgid "" "The following command launches an interactive login shell inside a Guix " "system container, started by @command{guix system container}, and whose " "process ID is 9001:" msgstr "" #. type: example #: doc/guix.texi:15610 #, no-wrap msgid "guix container exec 9001 /run/current-system/profile/bin/bash --login\n" msgstr "" #. type: table #: doc/guix.texi:15614 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:15618 #, no-wrap msgid "Invoking @command{guix weather}" msgstr "" #. type: command{#1} #: doc/guix.texi:15620 #, no-wrap msgid "guix weather" msgstr "" #. type: Plain text #: doc/guix.texi:15628 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:15629 #, no-wrap msgid "statistics, for substitutes" msgstr "" #. type: cindex #: doc/guix.texi:15630 #, no-wrap msgid "availability of substitutes" msgstr "" #. type: cindex #: doc/guix.texi:15631 #, no-wrap msgid "substitute availability" msgstr "" #. type: cindex #: doc/guix.texi:15632 #, no-wrap msgid "weather, substitute availability" msgstr "" #. type: Plain text #: doc/guix.texi:15634 msgid "Here's a sample run:" msgstr "" #. type: example #: doc/guix.texi:15646 #, 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 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:15656 #, 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:15658 #, no-wrap msgid "continuous integration, statistics" msgstr "" #. type: Plain text #: doc/guix.texi:15669 msgid "" "As you can see, it reports the fraction of all the packages for which " "substitutes are available on the server---regardless of whether substitutes " "are enabled, and regardless of whether this server's signing key is " "authorized. It also reports the size of the compressed archives (``nars'') " "provided by the server, the size the corresponding store items occupy in the " "store (assuming deduplication is turned off), and the server's throughput. " "The second part gives continuous integration (CI) statistics, if the server " "supports it. In addition, using the @option{--coverage} option, " "@command{guix weather} can list ``important'' package substitutes missing on " "the server (see below)." msgstr "" #. type: Plain text #: doc/guix.texi:15675 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: example #: doc/guix.texi:15680 #, no-wrap msgid "guix weather @var{options}@dots{} [@var{packages}@dots{}]\n" msgstr "" #. type: Plain text #: doc/guix.texi:15688 msgid "" "When @var{packages} is omitted, @command{guix weather} checks the " "availability of substitutes for @emph{all} the packages, or for those " "specified with @option{--manifest}; otherwise it only considers the " "specified packages. It is also possible to query specific system types with " "@option{--system}. @command{guix weather} exits with a non-zero code when " "the fraction of available substitutes is below 100%." msgstr "" #. type: table #: doc/guix.texi:15696 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:15702 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:15708 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: table #: doc/guix.texi:15711 msgid "" "This option can be repeated several times, in which case the manifests are " "concatenated." msgstr "" #. type: item #: doc/guix.texi:15712 #, no-wrap msgid "--coverage[=@var{count}]" msgstr "" #. type: itemx #: doc/guix.texi:15713 #, no-wrap msgid "-c [@var{count}]" msgstr "" #. type: table #: doc/guix.texi:15719 msgid "" "Report on substitute coverage for packages: list packages with at least " "@var{count} dependents (zero by default) for which substitutes are " "unavailable. Dependent packages themselves are not listed: if @var{b} " "depends on @var{a} and @var{a} has no substitutes, only @var{a} is listed, " "even though @var{b} usually lacks substitutes as well. The result looks " "like this:" msgstr "" #. type: example #: doc/guix.texi:15733 #, no-wrap msgid "" "$ guix weather --substitute-urls=@value{SUBSTITUTE-URLS} -c 10\n" "computing 8,983 package derivations for x86_64-linux...\n" "looking for 9,343 store items on @value{SUBSTITUTE-URLS}...\n" "updating substitutes from '@value{SUBSTITUTE-URLS}'... 100.0%\n" "@value{SUBSTITUTE-URLS}\n" " 64.7% substitutes available (6,047 out of 9,343)\n" "@dots{}\n" "2502 packages are missing from '@value{SUBSTITUTE-URLS}' for 'x86_64-linux', among which:\n" " 58 kcoreaddons@@5.49.0 /gnu/store/@dots{}-kcoreaddons-5.49.0\n" " 46 qgpgme@@1.11.1 /gnu/store/@dots{}-qgpgme-1.11.1\n" " 37 perl-http-cookiejar@@0.008 /gnu/store/@dots{}-perl-http-cookiejar-0.008\n" " @dots{}\n" msgstr "" #. type: table #: doc/guix.texi:15739 msgid "" "What this example shows is that @code{kcoreaddons} and presumably the 58 " "packages that depend on it have no substitutes at @code{@value{SUBSTITUTE-" "SERVER-1}}; likewise for @code{qgpgme} and the 46 packages that depend on it." msgstr "" #. type: table #: doc/guix.texi:15743 msgid "" "If you are a Guix developer, or if you are taking care of this build farm, " "you'll probably want to have a closer look at these packages: they may " "simply fail to build." msgstr "" #. type: item #: doc/guix.texi:15744 #, no-wrap msgid "--display-missing" msgstr "" #. type: table #: doc/guix.texi:15746 msgid "Display the list of store items for which substitutes are missing." msgstr "" #. type: section #: doc/guix.texi:15749 #, no-wrap msgid "Invoking @command{guix processes}" msgstr "" #. type: command{#1} #: doc/guix.texi:15751 #, no-wrap msgid "guix processes" msgstr "" #. type: Plain text #: doc/guix.texi:15758 msgid "" "The @command{guix processes} command can be useful to developers and system " "administrators, especially on multi-user machines and on build farms: it " "lists the current sessions (connections to the daemon), as well as " "information about the processes involved@footnote{Remote sessions, when " "@command{guix-daemon} is started with @option{--listen} specifying a TCP " "endpoint, are @emph{not} listed.}. Here's an example of the information it " "returns:" msgstr "" #. type: example #: doc/guix.texi:15764 #, no-wrap msgid "" "$ sudo guix processes\n" "SessionPID: 19002\n" "ClientPID: 19090\n" "ClientCommand: guix shell python\n" "\n" msgstr "" #. type: example #: doc/guix.texi:15768 #, no-wrap msgid "" "SessionPID: 19402\n" "ClientPID: 19367\n" "ClientCommand: guix publish -u guix-publish -p 3000 -C 9 @dots{}\n" "\n" msgstr "" #. type: example #: doc/guix.texi:15781 #, no-wrap msgid "" "SessionPID: 19444\n" "ClientPID: 19419\n" "ClientCommand: cuirass --cache-directory /var/cache/cuirass @dots{}\n" "LockHeld: /gnu/store/@dots{}-perl-ipc-cmd-0.96.lock\n" "LockHeld: /gnu/store/@dots{}-python-six-bootstrap-1.11.0.lock\n" "LockHeld: /gnu/store/@dots{}-libjpeg-turbo-2.0.0.lock\n" "ChildPID: 20495\n" "ChildCommand: guix offload x86_64-linux 7200 1 28800\n" "ChildPID: 27733\n" "ChildCommand: guix offload x86_64-linux 7200 1 28800\n" "ChildPID: 27793\n" "ChildCommand: guix offload x86_64-linux 7200 1 28800\n" msgstr "" #. type: Plain text #: doc/guix.texi:15788 msgid "" "In this example we see that @command{guix-daemon} has three clients: " "@command{guix environment}, @command{guix publish}, and the Cuirass " "continuous integration tool; their process identifier (PID) is given by the " "@code{ClientPID} field. The @code{SessionPID} field gives the PID of the " "@command{guix-daemon} sub-process of this particular session." msgstr "" #. type: Plain text #: doc/guix.texi:15795 msgid "" "The @code{LockHeld} fields show which store items are currently locked by " "this session, which corresponds to store items being built or substituted " "(the @code{LockHeld} field is not displayed when @command{guix processes} is " "not running as root). Last, by looking at the @code{ChildPID} and " "@code{ChildCommand} fields, we understand that these three builds are being " "offloaded (@pxref{Daemon Offload Setup})." msgstr "" #. type: Plain text #: doc/guix.texi:15800 msgid "" "The output is in Recutils format so we can use the handy @command{recsel} " "command to select sessions of interest (@pxref{Selection Expressions,,, " "recutils, GNU recutils manual}). As an example, the command shows the " "command line and PID of the client that triggered the build of a Perl " "package:" msgstr "" #. type: example #: doc/guix.texi:15806 #, no-wrap msgid "" "$ sudo guix processes | \\\n" " recsel -p ClientPID,ClientCommand -e 'LockHeld ~ \"perl\"'\n" "ClientPID: 19419\n" "ClientCommand: cuirass --cache-directory /var/cache/cuirass @dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:15809 msgid "Additional options are listed below." msgstr "" #. type: table #: doc/guix.texi:15819 msgid "" "The default option. It outputs a set of Session recutils records that " "include each @code{ChildProcess} as a field." msgstr "" #. type: item #: doc/guix.texi:15820 #, no-wrap msgid "normalized" msgstr "" #. type: table #: doc/guix.texi:15827 msgid "" "Normalize the output records into record sets (@pxref{Record Sets,,, " "recutils, GNU recutils manual}). Normalizing into record sets allows joins " "across record types. The example below lists the PID of each " "@code{ChildProcess} and the associated PID for @code{Session} that spawned " "the @code{ChildProcess} where the @code{Session} was started using " "@command{guix build}." msgstr "" #. type: example #: doc/guix.texi:15837 #, no-wrap msgid "" "$ guix processes --format=normalized | \\\n" " recsel \\\n" " -j Session \\\n" " -t ChildProcess \\\n" " -p Session.PID,PID \\\n" " -e 'Session.ClientCommand ~ \"guix build\"'\n" "PID: 4435\n" "Session_PID: 4278\n" "\n" msgstr "" #. type: example #: doc/guix.texi:15840 #, no-wrap msgid "" "PID: 4554\n" "Session_PID: 4278\n" "\n" msgstr "" #. type: example #: doc/guix.texi:15843 #, no-wrap msgid "" "PID: 4646\n" "Session_PID: 4278\n" msgstr "" #. type: Plain text #: doc/guix.texi:15853 msgid "" "You can target computers of different CPU architectures when producing " "packages (@pxref{Invoking guix package}), packs (@pxref{Invoking guix pack}) " "or full systems (@pxref{Invoking guix system})." msgstr "" #. type: Plain text #: doc/guix.texi:15856 msgid "" "GNU Guix supports two distinct mechanisms to target foreign architectures:" msgstr "" #. type: enumerate #: doc/guix.texi:15862 msgid "" "The traditional @uref{https://en.wikipedia.org/wiki/Cross_compiler,cross-" "compilation} mechanism." msgstr "" #. type: enumerate #: doc/guix.texi:15866 msgid "" "The native building mechanism which consists in building using the CPU " "instruction set of the foreign system you are targeting. It often requires " "emulation, using the QEMU program for instance." msgstr "" #. type: cindex #: doc/guix.texi:15876 #, no-wrap msgid "foreign architectures" msgstr "" #. type: Plain text #: doc/guix.texi:15879 msgid "" "The commands supporting cross-compilation are proposing the @option{--list-" "targets} and @option{--target} options." msgstr "" #. type: Plain text #: doc/guix.texi:15882 msgid "" "The @option{--list-targets} option lists all the supported targets that can " "be passed as an argument to @option{--target}." msgstr "" #. type: example #: doc/guix.texi:15886 #, no-wrap msgid "" "$ guix build --list-targets\n" "The available targets are:\n" "\n" msgstr "" #. type: example #: doc/guix.texi:15898 #, no-wrap msgid "" " - aarch64-linux-gnu\n" " - arm-linux-gnueabihf\n" " - i586-pc-gnu\n" " - i686-linux-gnu\n" " - i686-w64-mingw32\n" " - mips64el-linux-gnu\n" " - powerpc-linux-gnu\n" " - powerpc64le-linux-gnu\n" " - riscv64-linux-gnu\n" " - x86_64-linux-gnu\n" " - x86_64-w64-mingw32\n" msgstr "" #. type: Plain text #: doc/guix.texi:15902 msgid "" "Targets are specified as GNU triplets (@pxref{Specifying Target Triplets, " "GNU configuration triplets,, autoconf, Autoconf})." msgstr "" #. type: Plain text #: doc/guix.texi:15906 msgid "" "Those triplets are passed to GCC and the other underlying compilers possibly " "involved when building a package, a system image or any other GNU Guix " "output." msgstr "" #. type: example #: doc/guix.texi:15910 #, no-wrap msgid "" "$ guix build --target=aarch64-linux-gnu hello\n" "/gnu/store/9926by9qrxa91ijkhw9ndgwp4bn24g9h-hello-2.12\n" "\n" msgstr "" #. type: example #: doc/guix.texi:15914 #, no-wrap msgid "" "$ file /gnu/store/9926by9qrxa91ijkhw9ndgwp4bn24g9h-hello-2.12/bin/hello\n" "/gnu/store/9926by9qrxa91ijkhw9ndgwp4bn24g9h-hello-2.12/bin/hello: ELF\n" "64-bit LSB executable, ARM aarch64 @dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:15920 msgid "" "The major benefit of cross-compilation is that there are no performance " "penaly compared to emulation using QEMU. There are however higher risks " "that some packages fail to cross-compile because few users are using this " "mechanism extensively." msgstr "" #. type: Plain text #: doc/guix.texi:15926 msgid "" "The commands that support impersonating a specific system have the @option{--" "list-systems} and @option{--system} options." msgstr "" #. type: Plain text #: doc/guix.texi:15929 msgid "" "The @option{--list-systems} option lists all the supported systems that can " "be passed as an argument to @option{--system}." msgstr "" #. type: example #: doc/guix.texi:15933 #, no-wrap msgid "" "$ guix build --list-systems\n" "The available systems are:\n" "\n" msgstr "" #. type: example #: doc/guix.texi:15943 #, no-wrap msgid "" " - x86_64-linux [current]\n" " - aarch64-linux\n" " - armhf-linux\n" " - i586-gnu\n" " - i686-linux\n" " - mips64el-linux\n" " - powerpc-linux\n" " - powerpc64le-linux\n" " - riscv64-linux\n" "\n" msgstr "" #. type: example #: doc/guix.texi:15946 #, no-wrap msgid "" "$ guix build --system=i686-linux hello\n" "/gnu/store/cc0km35s8x2z4pmwkrqqjx46i8b1i3gm-hello-2.12\n" "\n" msgstr "" #. type: example #: doc/guix.texi:15950 #, no-wrap msgid "" "$ file /gnu/store/cc0km35s8x2z4pmwkrqqjx46i8b1i3gm-hello-2.12/bin/hello\n" "/gnu/store/cc0km35s8x2z4pmwkrqqjx46i8b1i3gm-hello-2.12/bin/hello: ELF\n" "32-bit LSB executable, Intel 80386 @dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:15954 msgid "" "In the above example, the current system is @var{x86_64-linux}. The " "@var{hello} package is however built for the @var{i686-linux} system." msgstr "" #. type: Plain text #: doc/guix.texi:15958 msgid "" "This is possible because the @var{i686} CPU instruction set is a subset of " "the @var{x86_64}, hence @var{i686} targeting binaries can be run on " "@var{x86_64}." msgstr "" #. type: Plain text #: doc/guix.texi:15963 msgid "" "Still in the context of the previous example, if picking the @var{aarch64-" "linux} system and the @command{guix build --system=aarch64-linux hello} has " "to build some derivations, an extra step might be needed." msgstr "" #. type: Plain text #: doc/guix.texi:15971 msgid "" "The @var{aarch64-linux} targeting binaries cannot directly be run on a " "@var{x86_64-linux} system. An emulation layer is requested. The GNU Guix " "daemon can take advantage of the Linux kernel @uref{https://en.wikipedia.org/" "wiki/Binfmt_misc,binfmt_misc} mechanism for that. In short, the Linux " "kernel can defer the execution of a binary targeting a foreign platform, " "here @var{aarch64-linux}, to a userspace program, usually an emulator." msgstr "" #. type: Plain text #: doc/guix.texi:15977 msgid "" "There is a service that registers QEMU as a backend for the " "@code{binfmt_misc} mechanism (@pxref{Virtualization Services, @code{qemu-" "binfmt-service-type}}). On Debian based foreign distributions, the " "alternative would be the @code{qemu-user-static} package." msgstr "" #. type: Plain text #: doc/guix.texi:15980 msgid "" "If the @code{binfmt_misc} mechanism is not setup correctly, the building " "will fail this way:" msgstr "" #. type: example #: doc/guix.texi:15988 #, no-wrap msgid "" "$ guix build --system=armhf-linux hello --check\n" "@dots{}\n" "@ unsupported-platform /gnu/store/jjn969pijv7hff62025yxpfmc8zy0aq0-hello-2.12.drv aarch64-linux\n" "while setting up the build environment: a `aarch64-linux' is required to\n" "build `/gnu/store/jjn969pijv7hff62025yxpfmc8zy0aq0-hello-2.12.drv', but\n" "I am a `x86_64-linux'@dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:15992 msgid "" "whereas, with the @code{binfmt_misc} mechanism correctly linked with QEMU, " "one can expect to see:" msgstr "" #. type: example #: doc/guix.texi:15996 #, no-wrap msgid "" "$ guix build --system=armhf-linux hello --check\n" "/gnu/store/13xz4nghg39wpymivlwghy08yzj97hlj-hello-2.12\n" msgstr "" #. type: Plain text #: doc/guix.texi:16002 msgid "" "The main advantage of native building compared to cross-compiling, is that " "more packages are likely to build correctly. However it comes at a price: " "compilation backed by QEMU is @emph{way slower} than cross-compilation, " "because every instruction needs to be emulated." msgstr "" #. type: Plain text #: doc/guix.texi:16008 msgid "" "The availability of substitutes for the architecture targeted by the @code{--" "system} option can mitigate this problem. An other way to work around it is " "to install GNU Guix on a machine whose CPU supports the targeted instruction " "set, and set it up as an offload machine (@pxref{Daemon Offload Setup})." msgstr "" #. type: cindex #: doc/guix.texi:16012 #, no-wrap msgid "system configuration" msgstr "" #. type: Plain text #: doc/guix.texi:16018 msgid "" "Guix System supports a consistent whole-system configuration mechanism. By " "that we mean that all aspects of the global system configuration---such as " "the available system services, timezone and locale settings, user accounts---" "are declared in a single place. Such a @dfn{system configuration} can be " "@dfn{instantiated}---i.e., effected." msgstr "" #. type: Plain text #: doc/guix.texi:16028 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:16033 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:16063 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: code{#1} #: doc/guix.texi:16064 doc/guix.texi:39105 doc/guix.texi:42182 #, no-wrap msgid "operating-system" msgstr "" #. type: include #: doc/guix.texi:16066 #, no-wrap msgid "os-config-bare-bones.texi" msgstr "" #. type: Plain text #: doc/guix.texi:16073 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:16078 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: unnumberedsubsec #: doc/guix.texi:16079 #, no-wrap msgid "Bootloader" msgstr "" #. type: cindex #: doc/guix.texi:16081 #, no-wrap msgid "legacy boot, on Intel machines" msgstr "" #. type: cindex #: doc/guix.texi:16082 #, no-wrap msgid "BIOS boot, on Intel machines" msgstr "" #. type: cindex #: doc/guix.texi:16083 #, no-wrap msgid "UEFI boot" msgstr "" #. type: cindex #: doc/guix.texi:16084 #, no-wrap msgid "EFI boot" msgstr "" #. type: Plain text #: doc/guix.texi:16090 msgid "" "The @code{bootloader} field describes the method that will be used to boot " "your system. Machines based on Intel processors can boot in ``legacy'' BIOS " "mode, as in the example above. However, more recent machines rely instead " "on the @dfn{Unified Extensible Firmware Interface} (UEFI) to boot. In that " "case, the @code{bootloader} field should contain something along these lines:" msgstr "" #. type: lisp #: doc/guix.texi:16095 #, no-wrap msgid "" "(bootloader-configuration\n" " (bootloader grub-efi-bootloader)\n" " (targets '(\"/boot/efi\")))\n" msgstr "" #. type: Plain text #: doc/guix.texi:16099 msgid "" "@xref{Bootloader Configuration}, for more information on the available " "configuration options." msgstr "" #. type: unnumberedsubsec #: doc/guix.texi:16100 #, no-wrap msgid "Globally-Visible Packages" msgstr "" #. type: vindex #: doc/guix.texi:16102 #, no-wrap msgid "%base-packages" msgstr "" #. type: Plain text #: doc/guix.texi:16115 msgid "" "The @code{packages} field lists packages that will be globally visible on " "the system, for all user accounts---i.e., in every user's @env{PATH} " "environment variable---in addition to the per-user profiles (@pxref{Invoking " "guix package}). The @code{%base-packages} variable provides all the tools " "one would expect for basic user and administrator tasks---including the GNU " "Core Utilities, the GNU Networking Utilities, the @command{mg} lightweight " "text editor, @command{find}, @command{grep}, etc. The example above adds " "GNU@tie{}Screen to those, taken from the @code{(gnu packages screen)} module " "(@pxref{Package Modules}). The @code{(list package output)} syntax can be " "used to add a specific output of a package:" msgstr "" #. type: lisp #: doc/guix.texi:16119 #, no-wrap msgid "" "(use-modules (gnu packages))\n" "(use-modules (gnu packages dns))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:16124 #, no-wrap msgid "" "(operating-system\n" " ;; ...\n" " (packages (cons (list isc-bind \"utils\")\n" " %base-packages)))\n" msgstr "" #. type: findex #: doc/guix.texi:16126 #, no-wrap msgid "specification->package" msgstr "" #. type: Plain text #: doc/guix.texi:16135 msgid "" "Referring to packages by variable name, like @code{isc-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:16138 #, no-wrap msgid "" "(use-modules (gnu packages))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:16144 #, no-wrap msgid "" "(operating-system\n" " ;; ...\n" " (packages (append (map specification->package\n" " '(\"tcpdump\" \"htop\" \"gnupg@@2.0\"))\n" " %base-packages)))\n" msgstr "" #. type: unnumberedsubsec #: doc/guix.texi:16146 #, no-wrap msgid "System Services" msgstr "" #. type: cindex #: doc/guix.texi:16148 doc/guix.texi:37724 doc/guix.texi:39346 #, no-wrap msgid "services" msgstr "" #. type: vindex #: doc/guix.texi:16149 #, no-wrap msgid "%base-services" msgstr "" #. type: Plain text #: doc/guix.texi:16159 msgid "" "The @code{services} field lists @dfn{system services} to be made available " "when the system starts (@pxref{Services}). The @code{operating-system} " "declaration above specifies that, in addition to the basic services, we want " "the OpenSSH secure shell daemon listening on port 2222 (@pxref{Networking " "Services, @code{openssh-service-type}}). Under the hood, @code{openssh-" "service-type} arranges so that @command{sshd} is started with the right " "command-line options, possibly with supporting configuration files generated " "as needed (@pxref{Defining Services})." msgstr "" #. type: cindex #: doc/guix.texi:16160 #, no-wrap msgid "customization, of services" msgstr "" #. type: findex #: doc/guix.texi:16161 #, no-wrap msgid "modify-services" msgstr "" #. type: Plain text #: doc/guix.texi:16165 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: anchor{#1} #: doc/guix.texi:16171 msgid "auto-login to TTY" msgstr "" #. type: Plain text #: doc/guix.texi:16171 msgid "" "For example, suppose you want to modify @code{guix-daemon} and Mingetty (the " "console log-in) in the @code{%base-services} list (@pxref{Base Services, " "@code{%base-services}}). To do that, you can write the following in your " "operating system declaration:" msgstr "" #. type: lisp #: doc/guix.texi:16188 #, 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" " ;; Fetch substitutes from example.org.\n" " (substitute-urls\n" " (list \"https://example.org/guix\"\n" " \"https://ci.guix.gnu.org\"))))\n" " (mingetty-service-type config =>\n" " (mingetty-configuration\n" " (inherit config)\n" " ;; Automatically log in as \"guest\".\n" " (auto-login \"guest\")))))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:16192 #, no-wrap msgid "" "(operating-system\n" " ;; @dots{}\n" " (services %my-services))\n" msgstr "" #. type: Plain text #: doc/guix.texi:16205 msgid "" "This changes the configuration---i.e., the service parameters---of the " "@code{guix-service-type} instance, and that of all the @code{mingetty-" "service-type} instances in the @code{%base-services} list (@pxref{Auto-Login " "to a Specific TTY, see the cookbook for how to auto-login one user to a " "specific TTY,, guix-cookbook, GNU Guix Cookbook})). 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:16212 msgid "" "The configuration for a typical ``desktop'' usage, with an encrypted root " "partition, a swap file on the 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:16214 #, no-wrap msgid "os-config-desktop.texi" msgstr "" #. type: Plain text #: doc/guix.texi:16219 msgid "" "A graphical system with a choice of lightweight window managers instead of " "full-blown desktop environments would look like this:" msgstr "" #. type: include #: doc/guix.texi:16221 #, no-wrap msgid "os-config-lightweight-desktop.texi" msgstr "" #. type: Plain text #: doc/guix.texi:16227 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:16231 msgid "" "@xref{Desktop Services}, for the exact list of services provided by " "@code{%desktop-services}. @xref{X.509 Certificates}, for background " "information about the @code{nss-certs} package that is used here." msgstr "" #. type: Plain text #: doc/guix.texi:16238 msgid "" "Again, @code{%desktop-services} is just a list of service objects. If you " "want to remove services from there, you can do so using the procedures for " "list filtering (@pxref{SRFI-1 Filtering and Partitioning,,, guile, GNU Guile " "Reference Manual}). For instance, the following expression returns a list " "that contains all the services in @code{%desktop-services} minus the Avahi " "service:" msgstr "" #. type: lisp #: doc/guix.texi:16243 #, no-wrap msgid "" "(remove (lambda (service)\n" " (eq? (service-kind service) avahi-service-type))\n" " %desktop-services)\n" msgstr "" #. type: Plain text #: doc/guix.texi:16246 msgid "Alternatively, the @code{modify-services} macro can be used:" msgstr "" #. type: lisp #: doc/guix.texi:16250 #, no-wrap msgid "" "(modify-services %desktop-services\n" " (delete avahi-service-type))\n" msgstr "" #. type: unnumberedsubsec #: doc/guix.texi:16253 #, no-wrap msgid "Instantiating the System" msgstr "" #. type: Plain text #: doc/guix.texi:16260 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: quotation #: doc/guix.texi:16264 msgid "" "We recommend that you keep this @file{my-system-config.scm} file safe and " "under version control to easily track changes to your configuration." msgstr "" #. type: Plain text #: doc/guix.texi:16273 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:16274 #, no-wrap msgid "roll-back, of the operating system" msgstr "" #. type: Plain text #: doc/guix.texi:16284 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:16290 msgid "" "Although the @command{guix system reconfigure} command will not modify " "previous generations, you must take care when the current generation is not " "the latest (e.g., after invoking @command{guix system roll-back}), since the " "operation might overwrite a later generation (@pxref{Invoking guix system})." msgstr "" #. type: unnumberedsubsec #: doc/guix.texi:16291 #, no-wrap msgid "The Programming Interface" msgstr "" #. type: Plain text #: doc/guix.texi:16296 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:16297 #, no-wrap msgid "{Monadic Procedure} operating-system-derivation os" msgstr "" #. type: deffn #: doc/guix.texi:16300 msgid "" "Return a derivation that builds @var{os}, an @code{operating-system} object " "(@pxref{Derivations})." msgstr "" #. type: deffn #: doc/guix.texi:16304 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:16309 msgid "" "This procedure is provided by the @code{(gnu system)} module. Along with " "@code{(gnu services)} (@pxref{Services}), this module contains the guts of " "Guix System. Make sure to visit it!" msgstr "" #. type: section #: doc/guix.texi:16312 #, no-wrap msgid "@code{operating-system} Reference" msgstr "" #. type: Plain text #: doc/guix.texi:16317 msgid "" "This section summarizes all the options available in @code{operating-system} " "declarations (@pxref{Using the Configuration System})." msgstr "" #. type: deftp #: doc/guix.texi:16318 #, no-wrap msgid "{Data Type} operating-system" msgstr "" #. type: deftp #: doc/guix.texi:16322 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:16324 #, no-wrap msgid "@code{kernel} (default: @code{linux-libre})" msgstr "" #. type: table #: doc/guix.texi:16329 msgid "" "The package object of the operating system kernel to use@footnote{Currently " "only the Linux-libre kernel is fully supported. Using GNU@tie{}mach with " "the GNU@tie{}Hurd is experimental and only available when building a virtual " "machine disk image.}." msgstr "" #. type: code{#1} #: doc/guix.texi:16330 doc/guix.texi:33751 #, no-wrap msgid "hurd" msgstr "" #. type: item #: doc/guix.texi:16331 #, no-wrap msgid "@code{hurd} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:16336 msgid "" "The package object of the Hurd to be started by the kernel. When this field " "is set, produce a GNU/Hurd operating system. In that case, @code{kernel} " "must also be set to the @code{gnumach} package---the microkernel the Hurd " "runs on." msgstr "" #. type: quotation #: doc/guix.texi:16339 msgid "This feature is experimental and only supported for disk images." msgstr "" #. type: item #: doc/guix.texi:16341 #, no-wrap msgid "@code{kernel-loadable-modules} (default: '())" msgstr "" #. type: table #: doc/guix.texi:16344 msgid "" "A list of objects (usually packages) to collect loadable kernel modules " "from--e.g. @code{(list ddcci-driver-linux)}." msgstr "" #. type: item #: doc/guix.texi:16345 #, no-wrap msgid "@code{kernel-arguments} (default: @code{%default-kernel-arguments})" msgstr "" #. type: table #: doc/guix.texi:16348 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:16349 doc/guix.texi:37968 doc/guix.texi:37987 #, no-wrap msgid "bootloader" msgstr "" #. type: table #: doc/guix.texi:16351 msgid "" "The system bootloader configuration object. @xref{Bootloader Configuration}." msgstr "" #. type: code{#1} #: doc/guix.texi:16352 doc/guix.texi:38185 doc/guix.texi:42258 #, no-wrap msgid "label" msgstr "" #. type: table #: doc/guix.texi:16355 msgid "" "This is the label (a string) as it appears in the bootloader's menu entry. " "The default label includes the kernel name and version." msgstr "" #. type: item #: doc/guix.texi:16356 doc/guix.texi:18096 doc/guix.texi:21839 #: doc/guix.texi:38106 #, no-wrap msgid "@code{keyboard-layout} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:16361 msgid "" "This field specifies the keyboard layout to use in the console. It can be " "either @code{#f}, in which case the default keyboard layout is used (usually " "US English), or a @code{} record. @xref{Keyboard Layout}, " "for more information." msgstr "" #. type: table #: doc/guix.texi:16366 msgid "" "This keyboard layout is in effect as soon as the kernel has booted. For " "instance, it is the keyboard layout in effect when you type a passphrase if " "your root file system is on a @code{luks-device-mapping} mapped device " "(@pxref{Mapped Devices})." msgstr "" #. type: quotation #: doc/guix.texi:16373 msgid "" "This does @emph{not} specify the keyboard layout used by the bootloader, nor " "that used by the graphical display server. @xref{Bootloader Configuration}, " "for information on how to specify the bootloader's keyboard layout. @xref{X " "Window}, for information on how to specify the keyboard layout used by the X " "Window System." msgstr "" #. type: item #: doc/guix.texi:16375 #, no-wrap msgid "@code{initrd-modules} (default: @code{%base-initrd-modules})" msgstr "" #. type: cindex #: doc/guix.texi:16376 doc/guix.texi:37761 doc/guix.texi:37894 #, no-wrap msgid "initrd" msgstr "" #. type: cindex #: doc/guix.texi:16377 doc/guix.texi:37762 doc/guix.texi:37895 #, no-wrap msgid "initial RAM disk" msgstr "" #. type: table #: doc/guix.texi:16380 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:16381 #, no-wrap msgid "@code{initrd} (default: @code{base-initrd})" msgstr "" #. type: table #: doc/guix.texi:16385 msgid "" "A procedure that returns an initial RAM disk for the Linux kernel. This " "field is provided to support low-level customization and should rarely be " "needed for casual use. @xref{Initial RAM Disk}." msgstr "" #. type: item #: doc/guix.texi:16386 #, no-wrap msgid "@code{firmware} (default: @code{%base-firmware})" msgstr "" #. type: cindex #: doc/guix.texi:16387 #, no-wrap msgid "firmware" msgstr "" #. type: table #: doc/guix.texi:16389 msgid "List of firmware packages loadable by the operating system kernel." msgstr "" #. type: table #: doc/guix.texi:16394 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:16395 doc/guix.texi:39124 #, no-wrap msgid "host-name" msgstr "" #. type: table #: doc/guix.texi:16397 msgid "The host name." msgstr "" #. type: code{#1} #: doc/guix.texi:16398 #, no-wrap msgid "hosts-file" msgstr "" #. type: cindex #: doc/guix.texi:16399 #, no-wrap msgid "hosts file" msgstr "" #. type: table #: doc/guix.texi:16404 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:16405 #, no-wrap msgid "@code{mapped-devices} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:16407 msgid "A list of mapped devices. @xref{Mapped Devices}." msgstr "" #. type: code{#1} #: doc/guix.texi:16408 #, no-wrap msgid "file-systems" msgstr "" #. type: table #: doc/guix.texi:16410 msgid "A list of file systems. @xref{File Systems}." msgstr "" #. type: item #: doc/guix.texi:16411 #, no-wrap msgid "@code{swap-devices} (default: @code{'()})" msgstr "" #. type: cindex #: doc/guix.texi:16412 #, no-wrap msgid "swap devices" msgstr "" #. type: table #: doc/guix.texi:16414 msgid "A list of swap spaces. @xref{Swap Space}." msgstr "" #. type: item #: doc/guix.texi:16415 #, no-wrap msgid "@code{users} (default: @code{%base-user-accounts})" msgstr "" #. type: itemx #: doc/guix.texi:16416 #, no-wrap msgid "@code{groups} (default: @code{%base-groups})" msgstr "" #. type: table #: doc/guix.texi:16418 msgid "List of user accounts and groups. @xref{User Accounts}." msgstr "" #. type: table #: doc/guix.texi:16421 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:16422 #, no-wrap msgid "@code{skeletons} (default: @code{(default-skeletons)})" msgstr "" #. type: table #: doc/guix.texi:16426 msgid "" "A list of target file name/file-like object tuples (@pxref{G-Expressions, " "file-like objects}). These are the skeleton files that will be added to the " "home directory of newly-created user accounts." msgstr "" #. type: table #: doc/guix.texi:16428 msgid "For instance, a valid value may look like this:" msgstr "" #. type: lisp #: doc/guix.texi:16434 #, 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:16436 #, no-wrap msgid "@code{issue} (default: @code{%default-issue})" msgstr "" #. type: table #: doc/guix.texi:16439 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:16440 #, no-wrap msgid "@code{packages} (default: @code{%base-packages})" msgstr "" #. type: table #: doc/guix.texi:16444 msgid "" "A list of packages to be installed in the global profile, which is " "accessible at @file{/run/current-system/profile}. Each element is either a " "package variable or a package/output tuple. Here's a simple example of both:" msgstr "" #. type: lisp #: doc/guix.texi:16449 #, no-wrap msgid "" "(cons* git ; the default \"out\" output\n" " (list git \"send-email\") ; another output of git\n" " %base-packages) ; the default set\n" msgstr "" #. type: table #: doc/guix.texi:16454 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: item #: doc/guix.texi:16455 #, no-wrap msgid "@code{timezone} (default: @code{\"Etc/UTC\"})" msgstr "" #. type: table #: doc/guix.texi:16457 msgid "A timezone identifying string---e.g., @code{\"Europe/Paris\"}." msgstr "" #. type: table #: doc/guix.texi:16461 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:16462 doc/guix.texi:24000 #, no-wrap msgid "@code{locale} (default: @code{\"en_US.utf8\"})" msgstr "" #. type: table #: doc/guix.texi:16465 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:16466 #, no-wrap msgid "@code{locale-definitions} (default: @code{%default-locale-definitions})" msgstr "" #. type: table #: doc/guix.texi:16469 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:16470 #, no-wrap msgid "@code{locale-libcs} (default: @code{(list @var{glibc})})" msgstr "" #. type: table #: doc/guix.texi:16474 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:16475 #, no-wrap msgid "@code{name-service-switch} (default: @code{%default-nss})" msgstr "" #. type: table #: doc/guix.texi:16479 msgid "" "Configuration of the libc name service switch (NSS)---a @code{} object. @xref{Name Service Switch}, for details." msgstr "" #. type: item #: doc/guix.texi:16480 #, no-wrap msgid "@code{services} (default: @code{%base-services})" msgstr "" #. type: table #: doc/guix.texi:16482 msgid "A list of service objects denoting system services. @xref{Services}." msgstr "" #. type: cindex #: doc/guix.texi:16483 #, no-wrap msgid "essential services" msgstr "" #. type: item #: doc/guix.texi:16484 #, no-wrap msgid "@code{essential-services} (default: ...)" msgstr "" #. type: table #: doc/guix.texi:16489 msgid "" "The list of ``essential services''---i.e., things like instances of " "@code{system-service-type} and @code{host-name-service-type} (@pxref{Service " "Reference}), which are derived from the operating system definition itself. " "As a user you should @emph{never} need to touch this field." msgstr "" #. type: item #: doc/guix.texi:16490 #, no-wrap msgid "@code{pam-services} (default: @code{(base-pam-services)})" msgstr "" #. type: cindex #: doc/guix.texi:16491 #, no-wrap msgid "PAM" msgstr "" #. type: cindex #: doc/guix.texi:16492 #, no-wrap msgid "pluggable authentication modules" msgstr "" #. type: table #: doc/guix.texi:16495 msgid "Linux @dfn{pluggable authentication module} (PAM) services." msgstr "" #. type: item #: doc/guix.texi:16496 #, no-wrap msgid "@code{setuid-programs} (default: @code{%setuid-programs})" msgstr "" #. type: table #: doc/guix.texi:16499 msgid "" "List of @code{}. @xref{Setuid Programs}, for more " "information." msgstr "" #. type: item #: doc/guix.texi:16500 #, no-wrap msgid "@code{sudoers-file} (default: @code{%sudoers-specification})" msgstr "" #. type: cindex #: doc/guix.texi:16501 #, no-wrap msgid "sudoers file" msgstr "" #. type: table #: doc/guix.texi:16504 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:16509 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: deffn #: doc/guix.texi:16512 #, no-wrap msgid "{Scheme Syntax} this-operating-system" msgstr "" #. type: deffn #: doc/guix.texi:16515 msgid "" "When used in the @emph{lexical scope} of an operating system field " "definition, this identifier resolves to the operating system being defined." msgstr "" #. type: deffn #: doc/guix.texi:16518 msgid "" "The example below shows how to refer to the operating system being defined " "in the definition of the @code{label} field:" msgstr "" #. type: lisp #: doc/guix.texi:16521 doc/guix.texi:20854 #, no-wrap msgid "" "(use-modules (gnu) (guix))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:16526 #, no-wrap msgid "" "(operating-system\n" " ;; ...\n" " (label (package-full-name\n" " (operating-system-kernel this-operating-system))))\n" msgstr "" #. type: deffn #: doc/guix.texi:16530 msgid "" "It is an error to refer to @code{this-operating-system} outside an operating " "system definition." msgstr "" #. type: Plain text #: doc/guix.texi:16541 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: lisp #: doc/guix.texi:16547 #, no-wrap msgid "" "(file-system\n" " (mount-point \"/home\")\n" " (device \"/dev/sda3\")\n" " (type \"ext4\"))\n" msgstr "" #. type: Plain text #: doc/guix.texi:16551 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:16552 #, no-wrap msgid "{Data Type} file-system" msgstr "" #. type: deftp #: doc/guix.texi:16555 msgid "" "Objects of this type represent file systems to be mounted. They contain the " "following members:" msgstr "" #. type: item #: doc/guix.texi:16557 doc/guix.texi:16943 doc/guix.texi:19470 #, no-wrap msgid "type" msgstr "" #. type: table #: doc/guix.texi:16560 msgid "" "This is a string specifying the type of the file system---e.g., " "@code{\"ext4\"}." msgstr "" #. type: code{#1} #: doc/guix.texi:16561 #, no-wrap msgid "mount-point" msgstr "" #. type: table #: doc/guix.texi:16563 msgid "This designates the place where the file system is to be mounted." msgstr "" #. type: item #: doc/guix.texi:16564 doc/guix.texi:19420 #, no-wrap msgid "device" msgstr "" #. type: table #: doc/guix.texi:16574 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:16575 #, no-wrap msgid "file-system-label" msgstr "" #. type: table #: doc/guix.texi:16580 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: lisp #: doc/guix.texi:16586 #, no-wrap msgid "" "(file-system\n" " (mount-point \"/home\")\n" " (type \"ext4\")\n" " (device (file-system-label \"my-home\")))\n" msgstr "" #. type: code{#1} #: doc/guix.texi:16588 doc/guix.texi:36197 doc/guix.texi:36213 #, no-wrap msgid "uuid" msgstr "" #. type: table #: doc/guix.texi:16596 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: lisp #: doc/guix.texi:16602 #, 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:16610 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:16611 doc/guix.texi:42267 #, no-wrap msgid "@code{flags} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:16623 msgid "" "This is a list of symbols denoting mount flags. Recognized flags include " "@code{read-only}, @code{bind-mount}, @code{no-dev} (disallow access to " "special files), @code{no-suid} (ignore setuid and setgid bits), @code{no-" "atime} (do not update file access times), @code{no-diratime} (likewise for " "directories only), @code{strict-atime} (update file access time), @code{lazy-" "time} (only update time on the in-memory version of the file inode), " "@code{no-exec} (disallow program execution), and @code{shared} (make the " "mount shared). @xref{Mount-Unmount-Remount,,, libc, The GNU C Library " "Reference Manual}, for more information on these flags." msgstr "" #. type: item #: doc/guix.texi:16624 #, no-wrap msgid "@code{options} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:16628 msgid "" "This is either @code{#f}, or a string denoting mount options passed to the " "file system driver. @xref{Mount-Unmount-Remount,,, libc, The GNU C Library " "Reference Manual}, for details." msgstr "" #. type: table #: doc/guix.texi:16632 msgid "" "Run @command{man 8 mount} for options for various file systems, but beware " "that what it lists as file-system-independent ``mount options'' are in fact " "flags, and belong in the @code{flags} field described above." msgstr "" #. type: table #: doc/guix.texi:16637 msgid "" "The @code{file-system-options->alist} and @code{alist->file-system-options} " "procedures from @code{(gnu system file-systems)} can be used to convert file " "system options given as an association list to the string representation, " "and vice-versa." msgstr "" #. type: item #: doc/guix.texi:16638 #, no-wrap msgid "@code{mount?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:16643 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:16644 #, no-wrap msgid "@code{needed-for-boot?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:16649 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:16650 #, no-wrap msgid "@code{check?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:16654 msgid "" "This Boolean indicates whether the file system should be checked for errors " "before being mounted. How and when this happens can be further adjusted " "with the following options." msgstr "" #. type: item #: doc/guix.texi:16655 #, no-wrap msgid "@code{skip-check-if-clean?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:16660 msgid "" "When true, this Boolean indicates that a file system check triggered by " "@code{check?} may exit early if the file system is marked as ``clean'', " "meaning that it was previously correctly unmounted and should not contain " "errors." msgstr "" #. type: table #: doc/guix.texi:16664 msgid "" "Setting this to false will always force a full consistency check when " "@code{check?} is true. This may take a very long time and is not " "recommended on healthy systems---in fact, it may reduce reliability!" msgstr "" #. type: table #: doc/guix.texi:16668 msgid "" "Conversely, some primitive file systems like @code{fat} do not keep track of " "clean shutdowns and will perform a full scan regardless of the value of this " "option." msgstr "" #. type: item #: doc/guix.texi:16669 #, no-wrap msgid "@code{repair} (default: @code{'preen})" msgstr "" #. type: table #: doc/guix.texi:16672 msgid "" "When @code{check?} finds errors, it can (try to) repair them and continue " "booting. This option controls when and how to do so." msgstr "" #. type: table #: doc/guix.texi:16676 msgid "" "If false, try not to modify the file system at all. Checking certain file " "systems like @code{jfs} may still write to the device to replay the " "journal. No repairs will be attempted." msgstr "" #. type: table #: doc/guix.texi:16679 msgid "" "If @code{#t}, try to repair any errors found and assume ``yes'' to all " "questions. This will fix the most errors, but may be risky." msgstr "" #. type: table #: doc/guix.texi:16683 msgid "" "If @code{'preen}, repair only errors that are safe to fix without human " "interaction. What that means is left up to the developers of each file " "system and may be equivalent to ``none'' or ``all''." msgstr "" #. type: item #: doc/guix.texi:16684 #, no-wrap msgid "@code{create-mount-point?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:16686 msgid "When true, the mount point is created if it does not exist yet." msgstr "" #. type: item #: doc/guix.texi:16687 #, no-wrap msgid "@code{mount-may-fail?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:16692 msgid "" "When true, this indicates that mounting this file system can fail but that " "should not be considered an error. This is useful in unusual cases; an " "example of this is @code{efivarfs}, a file system that can only be mounted " "on EFI/UEFI systems." msgstr "" #. type: table #: doc/guix.texi:16697 msgid "" "This is a list of @code{} or @code{} 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:16701 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:16704 msgid "" "Another example is a file system that depends on a mapped device, for " "example for an encrypted partition (@pxref{Mapped Devices})." msgstr "" #. type: deffn #: doc/guix.texi:16707 #, no-wrap msgid "{Scheme Procedure} file-system-label @var{str}" msgstr "" #. type: deffn #: doc/guix.texi:16710 msgid "" "This procedure returns an opaque file system label from @var{str}, a string:" msgstr "" #. type: lisp #: doc/guix.texi:16714 #, no-wrap msgid "" "(file-system-label \"home\")\n" "@result{} #\n" msgstr "" #. type: deffn #: doc/guix.texi:16718 msgid "" "File system labels are used to refer to file systems by label rather than by " "device name. See above for examples." msgstr "" #. type: Plain text #: doc/guix.texi:16722 msgid "" "The @code{(gnu system file-systems)} exports the following useful variables." msgstr "" #. type: defvr #: doc/guix.texi:16723 #, no-wrap msgid "{Scheme Variable} %base-file-systems" msgstr "" #. type: defvr #: doc/guix.texi:16728 msgid "" "These are essential file systems that are required on normal systems, such " "as @code{%pseudo-terminal-file-system} and @code{%immutable-store} (see " "below). Operating system declarations should always contain at least these." msgstr "" #. type: defvr #: doc/guix.texi:16730 #, no-wrap msgid "{Scheme Variable} %pseudo-terminal-file-system" msgstr "" #. type: defvr #: doc/guix.texi:16736 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:16738 #, no-wrap msgid "{Scheme Variable} %shared-memory-file-system" msgstr "" #. type: defvr #: doc/guix.texi:16742 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:16744 #, no-wrap msgid "{Scheme Variable} %immutable-store" msgstr "" #. type: defvr #: doc/guix.texi:16749 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:16752 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:16754 #, no-wrap msgid "{Scheme Variable} %binary-format-file-system" msgstr "" #. type: defvr #: doc/guix.texi:16758 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:16760 #, no-wrap msgid "{Scheme Variable} %fuse-control-file-system" msgstr "" #. type: defvr #: doc/guix.texi:16764 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: Plain text #: doc/guix.texi:16768 msgid "" "The @code{(gnu system uuid)} module provides tools to deal with file system " "``unique identifiers'' (UUIDs)." msgstr "" #. type: deffn #: doc/guix.texi:16769 #, no-wrap msgid "{Scheme Procedure} uuid @var{str} [@var{type}]" msgstr "" #. type: deffn #: doc/guix.texi:16772 msgid "" "Return an opaque UUID (unique identifier) object of the given @var{type} (a " "symbol) by parsing @var{str} (a string):" msgstr "" #. type: lisp #: doc/guix.texi:16776 #, no-wrap msgid "" "(uuid \"4dab5feb-d176-45de-b287-9b0a6e4c01cb\")\n" "@result{} #< type: dce bv: @dots{}>\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:16779 #, no-wrap msgid "" "(uuid \"1234-ABCD\" 'fat)\n" "@result{} #< type: fat bv: @dots{}>\n" msgstr "" #. type: deffn #: doc/guix.texi:16783 msgid "" "@var{type} may be one of @code{dce}, @code{iso9660}, @code{fat}, " "@code{ntfs}, or one of the commonly found synonyms for these." msgstr "" #. type: deffn #: doc/guix.texi:16786 msgid "" "UUIDs are another way to unambiguously refer to file systems in operating " "system configuration. See the examples above." msgstr "" #. type: subsection #: doc/guix.texi:16789 doc/guix.texi:16790 #, no-wrap msgid "Btrfs file system" msgstr "" #. type: Plain text #: doc/guix.texi:16796 msgid "" "The Btrfs has special features, such as subvolumes, that merit being " "explained in more details. The following section attempts to cover basic as " "well as complex uses of a Btrfs file system with the Guix System." msgstr "" #. type: Plain text #: doc/guix.texi:16799 msgid "" "In its simplest usage, a Btrfs file system can be described, for example, by:" msgstr "" #. type: lisp #: doc/guix.texi:16805 #, no-wrap msgid "" "(file-system\n" " (mount-point \"/home\")\n" " (type \"btrfs\")\n" " (device (file-system-label \"my-home\")))\n" msgstr "" #. type: Plain text #: doc/guix.texi:16811 msgid "" "The example below is more complex, as it makes use of a Btrfs subvolume, " "named @code{rootfs}. The parent Btrfs file system is labeled @code{my-btrfs-" "pool}, and is located on an encrypted device (hence the dependency on " "@code{mapped-devices}):" msgstr "" #. type: lisp #: doc/guix.texi:16819 #, no-wrap msgid "" "(file-system\n" " (device (file-system-label \"my-btrfs-pool\"))\n" " (mount-point \"/\")\n" " (type \"btrfs\")\n" " (options \"subvol=rootfs\")\n" " (dependencies mapped-devices))\n" msgstr "" #. type: Plain text #: doc/guix.texi:16830 msgid "" "Some bootloaders, for example GRUB, only mount a Btrfs partition at its top " "level during the early boot, and rely on their configuration to refer to the " "correct subvolume path within that top level. The bootloaders operating in " "this way typically produce their configuration on a running system where the " "Btrfs partitions are already mounted and where the subvolume information is " "readily available. As an example, @command{grub-mkconfig}, the " "configuration generator command shipped with GRUB, reads @file{/proc/self/" "mountinfo} to determine the top-level path of a subvolume." msgstr "" #. type: Plain text #: doc/guix.texi:16838 msgid "" "The Guix System produces a bootloader configuration using the operating " "system configuration as its sole input; it is therefore necessary to extract " "the subvolume name on which @file{/gnu/store} lives (if any) from that " "operating system configuration. To better illustrate, consider a subvolume " "named 'rootfs' which contains the root file system data. In such situation, " "the GRUB bootloader would only see the top level of the root Btrfs " "partition, e.g.:" msgstr "" #. type: example #: doc/guix.texi:16845 #, no-wrap msgid "" "/ (top level)\n" "├── rootfs (subvolume directory)\n" " ├── gnu (normal directory)\n" " ├── store (normal directory)\n" "[...]\n" msgstr "" #. type: Plain text #: doc/guix.texi:16850 msgid "" "Thus, the subvolume name must be prepended to the @file{/gnu/store} path of " "the kernel, initrd binaries and any other files referred to in the GRUB " "configuration that must be found during the early boot." msgstr "" #. type: Plain text #: doc/guix.texi:16853 msgid "" "The next example shows a nested hierarchy of subvolumes and directories:" msgstr "" #. type: example #: doc/guix.texi:16860 #, no-wrap msgid "" "/ (top level)\n" "├── rootfs (subvolume)\n" " ├── gnu (normal directory)\n" " ├── store (subvolume)\n" "[...]\n" msgstr "" #. type: Plain text #: doc/guix.texi:16867 msgid "" "This scenario would work without mounting the 'store' subvolume. Mounting " "'rootfs' is sufficient, since the subvolume name matches its intended mount " "point in the file system hierarchy. Alternatively, the 'store' subvolume " "could be referred to by setting the @code{subvol} option to either @code{/" "rootfs/gnu/store} or @code{rootfs/gnu/store}." msgstr "" #. type: Plain text #: doc/guix.texi:16869 msgid "Finally, a more contrived example of nested subvolumes:" msgstr "" #. type: example #: doc/guix.texi:16876 #, no-wrap msgid "" "/ (top level)\n" "├── root-snapshots (subvolume)\n" " ├── root-current (subvolume)\n" " ├── guix-store (subvolume)\n" "[...]\n" msgstr "" #. type: Plain text #: doc/guix.texi:16883 msgid "" "Here, the 'guix-store' subvolume doesn't match its intended mount point, so " "it is necessary to mount it. The subvolume must be fully specified, by " "passing its file name to the @code{subvol} option. To illustrate, the 'guix-" "store' subvolume could be mounted on @file{/gnu/store} by using a file " "system declaration such as:" msgstr "" #. type: lisp #: doc/guix.texi:16891 #, no-wrap msgid "" "(file-system\n" " (device (file-system-label \"btrfs-pool-1\"))\n" " (mount-point \"/gnu/store\")\n" " (type \"btrfs\")\n" " (options \"subvol=root-snapshots/root-current/guix-store,\\\n" "compress-force=zstd,space_cache=v2\"))\n" msgstr "" #. type: cindex #: doc/guix.texi:16896 #, no-wrap msgid "device mapping" msgstr "" #. type: cindex #: doc/guix.texi:16897 #, no-wrap msgid "mapped devices" msgstr "" #. type: Plain text #: doc/guix.texi:16914 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." msgstr "" #. type: Plain text #: doc/guix.texi:16917 msgid "" "Mapped devices are declared using the @code{mapped-device} form, defined as " "follows; for examples, see below." msgstr "" #. type: deftp #: doc/guix.texi:16918 #, no-wrap msgid "{Data Type} mapped-device" msgstr "" #. type: deftp #: doc/guix.texi:16921 msgid "" "Objects of this type represent device mappings that will be made when the " "system boots up." msgstr "" #. type: table #: doc/guix.texi:16928 msgid "" "This is either a string specifying the name of the block device to be " "mapped, such as @code{\"/dev/sda3\"}, or a list of such strings when several " "devices need to be assembled for creating a new one. In case of LVM this is " "a string specifying name of the volume group to be mapped." msgstr "" #. type: code{#1} #: doc/guix.texi:16929 doc/guix.texi:17084 doc/guix.texi:42020 #, no-wrap msgid "target" msgstr "" #. type: table #: doc/guix.texi:16938 msgid "" "This string specifies the name of the resulting mapped device. For kernel " "mappers such as encrypted devices of type @code{luks-device-mapping}, " "specifying @code{\"my-partition\"} leads to the creation of the @code{\"/dev/" "mapper/my-partition\"} device. For RAID devices of type @code{raid-device-" "mapping}, the full device name such as @code{\"/dev/md0\"} needs to be " "given. LVM logical volumes of type @code{lvm-device-mapping} need to be " "specified as @code{\"VGNAME-LVNAME\"}." msgstr "" #. type: code{#1} #: doc/guix.texi:16939 doc/guix.texi:38077 #, no-wrap msgid "targets" msgstr "" #. type: table #: doc/guix.texi:16942 msgid "" "This list of strings specifies names of the resulting mapped devices in case " "there are several. The format is identical to @var{target}." msgstr "" #. type: table #: doc/guix.texi:16946 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:16949 #, no-wrap msgid "{Scheme Variable} luks-device-mapping" msgstr "" #. type: defvr #: doc/guix.texi:16953 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:16955 #, no-wrap msgid "{Scheme Variable} raid-device-mapping" msgstr "" #. type: defvr #: doc/guix.texi:16960 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:16962 #, no-wrap msgid "LVM, logical volume manager" msgstr "" #. type: defvr #: doc/guix.texi:16963 #, no-wrap msgid "{Scheme Variable} lvm-device-mapping" msgstr "" #. type: defvr #: doc/guix.texi:16968 msgid "" "This defines one or more logical volumes for the Linux @uref{https://www." "sourceware.org/lvm2/, Logical Volume Manager (LVM)}. The volume group is " "activated by the @command{vgchange} command from the @code{lvm2} package." msgstr "" #. type: cindex #: doc/guix.texi:16970 #, no-wrap msgid "disk encryption" msgstr "" #. type: cindex #: doc/guix.texi:16971 #, no-wrap msgid "LUKS" msgstr "" #. type: Plain text #: doc/guix.texi:16979 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: lisp #: doc/guix.texi:16985 #, 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:16990 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:16993 #, no-wrap msgid "cryptsetup luksUUID /dev/sda3\n" msgstr "" #. type: Plain text #: doc/guix.texi:16996 msgid "and use it as follows:" msgstr "" #. type: lisp #: doc/guix.texi:17002 #, 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:17004 #, no-wrap msgid "swap encryption" msgstr "" #. type: Plain text #: doc/guix.texi:17011 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{Swap Space}, or " "@xref{Preparing for Installation,,Disk Partitioning}, for an example." msgstr "" #. type: Plain text #: doc/guix.texi:17014 msgid "" "A RAID device formed of the partitions @file{/dev/sda1} and @file{/dev/sdb1} " "may be declared as follows:" msgstr "" #. type: lisp #: doc/guix.texi:17020 #, 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:17027 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: Plain text #: doc/guix.texi:17030 msgid "" "LVM logical volumes ``alpha'' and ``beta'' from volume group ``vg0'' can be " "declared as follows:" msgstr "" #. type: lisp #: doc/guix.texi:17036 #, no-wrap msgid "" "(mapped-device\n" " (source \"vg0\")\n" " (targets (list \"vg0-alpha\" \"vg0-beta\"))\n" " (type lvm-device-mapping))\n" msgstr "" #. type: Plain text #: doc/guix.texi:17041 msgid "" "Devices @file{/dev/mapper/vg0-alpha} and @file{/dev/mapper/vg0-beta} can " "then be used as the @code{device} of a @code{file-system} declaration " "(@pxref{File Systems})." msgstr "" #. type: cindex #: doc/guix.texi:17044 #, no-wrap msgid "swap space" msgstr "" #. type: Plain text #: doc/guix.texi:17054 msgid "" "Swap space, as it is commonly called, is a disk area specifically designated " "for paging: the process in charge of memory management (the Linux kernel or " "Hurd's default pager) can decide that some memory pages stored in RAM which " "belong to a running program but are unused should be stored on disk " "instead. It unloads those from the RAM, freeing up precious fast memory, " "and writes them to the swap space. If the program tries to access that very " "page, the memory management process loads it back into memory for the " "program to use." msgstr "" #. type: Plain text #: doc/guix.texi:17060 msgid "" "A common misconception about swap is that it is only useful when small " "amounts of RAM are available to the system. However, it should be noted " "that kernels often use all available RAM for disk access caching to make I/O " "faster, and thus paging out unused portions of program memory will expand " "the RAM available for such caching." msgstr "" #. type: Plain text #: doc/guix.texi:17064 msgid "" "For a more detailed description of how memory is managed from the viewpoint " "of a monolithic kernel, @xref{Memory Concepts,,, libc, The GNU C Library " "Reference Manual}." msgstr "" #. type: Plain text #: doc/guix.texi:17073 msgid "" "The Linux kernel has support for swap partitions and swap files: the former " "uses a whole disk partition for paging, whereas the second uses a file on a " "file system for that (the file system driver needs to support it). On a " "comparable setup, both have the same performance, so one should consider " "ease of use when deciding between them. Partitions are ``simpler'' and do " "not need file system support, but need to be allocated at disk formatting " "time (logical volumes notwithstanding), whereas files can be allocated and " "deallocated at any time." msgstr "" #. type: Plain text #: doc/guix.texi:17078 msgid "" "Note that swap space is not zeroed on shutdown, so sensitive data (such as " "passwords) may linger on it if it was paged out. As such, you should " "consider having your swap reside on an encrypted device (@pxref{Mapped " "Devices})." msgstr "" #. type: deftp #: doc/guix.texi:17079 #, no-wrap msgid "{Data Type} swap-space" msgstr "" #. type: deftp #: doc/guix.texi:17082 msgid "" "Objects of this type represent swap spaces. They contain the following " "members:" msgstr "" #. type: table #: doc/guix.texi:17088 msgid "" "The device or file to use, either a UUID, a @code{file-system-label} or a " "string, as in the definition of a @code{file-system} (@pxref{File Systems})." msgstr "" #. type: table #: doc/guix.texi:17095 msgid "" "A list of @code{file-system} or @code{mapped-device} objects, upon which the " "availability of the space depends. Note that just like for @code{file-" "system} objects, dependencies which are needed for boot and mounted in early " "userspace are not managed by the Shepherd, and so automatically filtered out " "for you." msgstr "" #. type: item #: doc/guix.texi:17096 #, no-wrap msgid "@code{priority} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17103 msgid "" "Only supported by the Linux kernel. Either @code{#f} to disable swap " "priority, or an integer between 0 and 32767. The kernel will first use swap " "spaces of higher priority when paging, and use same priority spaces on a " "round-robin basis. The kernel will use swap spaces without a set priority " "after prioritized spaces, and in the order that they appeared in (not round-" "robin)." msgstr "" #. type: item #: doc/guix.texi:17104 #, no-wrap msgid "@code{discard?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17108 msgid "" "Only supported by the Linux kernel. When true, the kernel will notify the " "disk controller of discarded pages, for example with the TRIM operation on " "Solid State Drives." msgstr "" #. type: Plain text #: doc/guix.texi:17113 msgid "Here are some examples:" msgstr "" #. type: lisp #: doc/guix.texi:17116 #, no-wrap msgid "(swap-space (target (uuid \"4dab5feb-d176-45de-b287-9b0a6e4c01cb\")))\n" msgstr "" #. type: Plain text #: doc/guix.texi:17121 msgid "" "Use the swap partition with the given UUID@. You can learn the UUID of a " "Linux swap partition by running @command{swaplabel @var{device}}, where " "@var{device} is the @file{/dev} file name of that partition." msgstr "" #. type: lisp #: doc/guix.texi:17126 #, no-wrap msgid "" "(swap-space\n" " (target (file-system-label \"swap\"))\n" " (dependencies mapped-devices))\n" msgstr "" #. type: Plain text #: doc/guix.texi:17132 msgid "" "Use the partition with label @code{swap}, which can be found after all the " "@var{mapped-devices} mapped devices have been opened. Again, the " "@command{swaplabel} command allows you to view and change the label of a " "Linux swap partition." msgstr "" #. type: Plain text #: doc/guix.texi:17135 msgid "" "Here's a more involved example with the corresponding @code{file-systems} " "part of an @code{operating-system} declaration." msgstr "" #. type: lisp #: doc/guix.texi:17146 #, no-wrap msgid "" "(file-systems\n" " (list (file-system\n" " (device (file-system-label \"root\"))\n" " (mount-point \"/\")\n" " (type \"ext4\"))\n" " (file-system\n" " (device (file-system-label \"btrfs\"))\n" " (mount-point \"/btrfs\")\n" " (type \"btrfs\"))))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:17153 #, no-wrap msgid "" "(swap-devices\n" " (list\n" " (swap-space\n" " (target \"/btrfs/swapfile\")\n" " (dependencies (filter (file-system-mount-point-predicate \"/btrfs\")\n" " file-systems)))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:17158 msgid "" "Use the file @file{/btrfs/swapfile} as swap space, which depends on the file " "system mounted at @file{/btrfs}. Note how we use Guile's filter to select " "the file system in an elegant fashion!" msgstr "" #. type: cindex #: doc/guix.texi:17162 #, no-wrap msgid "users" msgstr "" #. type: cindex #: doc/guix.texi:17163 #, no-wrap msgid "accounts" msgstr "" #. type: cindex #: doc/guix.texi:17164 #, no-wrap msgid "user accounts" msgstr "" #. type: Plain text #: doc/guix.texi:17168 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: lisp #: doc/guix.texi:17178 #, 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" msgstr "" #. type: Plain text #: doc/guix.texi:17182 msgid "" "Here's a user account that uses a different shell and a custom home " "directory (the default would be @file{\"/home/bob\"}):" msgstr "" #. type: lisp #: doc/guix.texi:17190 #, no-wrap msgid "" "(user-account\n" " (name \"bob\")\n" " (group \"users\")\n" " (comment \"Alice's bro\")\n" " (shell (file-append zsh \"/bin/zsh\"))\n" " (home-directory \"/home/robert\"))\n" msgstr "" #. type: Plain text #: doc/guix.texi:17199 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:17200 #, no-wrap msgid "{Data Type} user-account" msgstr "" #. type: deftp #: doc/guix.texi:17203 msgid "" "Objects of this type represent user accounts. The following members may be " "specified:" msgstr "" #. type: table #: doc/guix.texi:17207 msgid "The name of the user account." msgstr "" #. type: itemx #: doc/guix.texi:17208 doc/guix.texi:37715 #, no-wrap msgid "group" msgstr "" #. type: cindex #: doc/guix.texi:17209 doc/guix.texi:17293 #, no-wrap msgid "groups" msgstr "" #. type: table #: doc/guix.texi:17212 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:17213 #, no-wrap msgid "@code{supplementary-groups} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:17216 msgid "" "Optionally, this can be defined as a list of group names that this account " "belongs to." msgstr "" #. type: item #: doc/guix.texi:17217 #, no-wrap msgid "@code{uid} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17221 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:17222 doc/guix.texi:20344 #, no-wrap msgid "@code{comment} (default: @code{\"\"})" msgstr "" #. type: table #: doc/guix.texi:17224 msgid "A comment about the account, such as the account owner's full name." msgstr "" #. type: table #: doc/guix.texi:17229 msgid "" "Note that, for non-system accounts, users are free to change their real name " "as it appears in @file{/etc/passwd} using the @command{chfn} command. When " "they do, their choice prevails over the system administrator's choice; " "reconfiguring does @emph{not} change their name." msgstr "" #. type: code{#1} #: doc/guix.texi:17230 #, no-wrap msgid "home-directory" msgstr "" #. type: table #: doc/guix.texi:17232 msgid "This is the name of the home directory for the account." msgstr "" #. type: item #: doc/guix.texi:17233 #, no-wrap msgid "@code{create-home-directory?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:17236 msgid "" "Indicates whether the home directory of this account should be created if it " "does not exist yet." msgstr "" #. type: item #: doc/guix.texi:17237 #, no-wrap msgid "@code{shell} (default: Bash)" msgstr "" #. type: table #: doc/guix.texi:17241 msgid "" "This is a G-expression denoting the file name of a program to be used as the " "shell (@pxref{G-Expressions}). For example, you would refer to the Bash " "executable like this:" msgstr "" #. type: lisp #: doc/guix.texi:17244 #, no-wrap msgid "(file-append bash \"/bin/bash\")\n" msgstr "" #. type: table #: doc/guix.texi:17248 msgid "... and to the Zsh executable like that:" msgstr "" #. type: lisp #: doc/guix.texi:17251 #, no-wrap msgid "(file-append zsh \"/bin/zsh\")\n" msgstr "" #. type: item #: doc/guix.texi:17253 doc/guix.texi:17311 #, no-wrap msgid "@code{system?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17257 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:17259 msgid "user-account-password" msgstr "" #. type: cindex #: doc/guix.texi:17259 #, no-wrap msgid "password, for user accounts" msgstr "" #. type: item #: doc/guix.texi:17260 doc/guix.texi:17315 #, no-wrap msgid "@code{password} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17266 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:17270 msgid "" "If you @emph{do} want to set an initial password for an account, then this " "field must contain the encrypted password, as a string. You can use the " "@code{crypt} procedure for this purpose:" msgstr "" #. type: lisp #: doc/guix.texi:17275 #, no-wrap msgid "" "(user-account\n" " (name \"charlie\")\n" " (group \"users\")\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:17278 #, no-wrap msgid "" " ;; Specify a SHA-512-hashed initial password.\n" " (password (crypt \"InitialPassword!\" \"$6$abc\")))\n" msgstr "" #. type: quotation #: doc/guix.texi:17284 msgid "" "The hash of this initial password will be available in a file in @file{/gnu/" "store}, readable by all the users, so this method must be used with care." msgstr "" #. type: table #: doc/guix.texi:17289 msgid "" "@xref{Passphrase Storage,,, libc, The GNU C Library Reference Manual}, for " "more information on password encryption, and @ref{Encryption,,, guile, GNU " "Guile Reference Manual}, for information on Guile's @code{crypt} procedure." msgstr "" #. type: Plain text #: doc/guix.texi:17295 msgid "User group declarations are even simpler:" msgstr "" #. type: lisp #: doc/guix.texi:17298 #, no-wrap msgid "(user-group (name \"students\"))\n" msgstr "" #. type: deftp #: doc/guix.texi:17300 #, no-wrap msgid "{Data Type} user-group" msgstr "" #. type: deftp #: doc/guix.texi:17302 msgid "This type is for, well, user groups. There are just a few fields:" msgstr "" #. type: table #: doc/guix.texi:17306 msgid "The name of the group." msgstr "" #. type: item #: doc/guix.texi:17307 doc/guix.texi:33837 #, no-wrap msgid "@code{id} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17310 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:17314 msgid "" "This Boolean value indicates whether the group is a ``system'' group. " "System groups have low numerical IDs." msgstr "" #. type: table #: doc/guix.texi:17318 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:17324 msgid "" "For convenience, a variable lists all the basic user groups one may expect:" msgstr "" #. type: defvr #: doc/guix.texi:17325 #, no-wrap msgid "{Scheme Variable} %base-groups" msgstr "" #. type: defvr #: doc/guix.texi:17330 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:17332 #, no-wrap msgid "{Scheme Variable} %base-user-accounts" msgstr "" #. type: defvr #: doc/guix.texi:17335 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:17338 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:17344 #, no-wrap msgid "keymap" msgstr "" #. type: Plain text #: doc/guix.texi:17352 msgid "" "To specify what each key of your keyboard does, you need to tell the " "operating system what @dfn{keyboard layout} you want to use. The default, " "when nothing is specified, is the US English QWERTY layout for 105-key PC " "keyboards. However, German speakers will usually prefer the German QWERTZ " "layout, French speakers will want the AZERTY layout, and so on; hackers " "might prefer Dvorak or bépo, and they might even want to further customize " "the effect of some of the keys. This section explains how to get that done." msgstr "" #. type: cindex #: doc/guix.texi:17353 #, no-wrap msgid "keyboard layout, definition" msgstr "" #. type: Plain text #: doc/guix.texi:17355 msgid "" "There are three components that will want to know about your keyboard layout:" msgstr "" #. type: itemize #: doc/guix.texi:17362 msgid "" "The @emph{bootloader} may want to know what keyboard layout you want to use " "(@pxref{Bootloader Configuration, @code{keyboard-layout}}). This is useful " "if you want, for instance, to make sure that you can type the passphrase of " "your encrypted root partition using the right layout." msgstr "" #. type: itemize #: doc/guix.texi:17367 msgid "" "The @emph{operating system kernel}, Linux, will need that so that the " "console is properly configured (@pxref{operating-system Reference, " "@code{keyboard-layout}})." msgstr "" #. type: itemize #: doc/guix.texi:17371 msgid "" "The @emph{graphical display server}, usually Xorg, also has its own idea of " "the keyboard layout (@pxref{X Window, @code{keyboard-layout}})." msgstr "" #. type: Plain text #: doc/guix.texi:17375 msgid "" "Guix allows you to configure all three separately but, fortunately, it " "allows you to share the same keyboard layout for all three components." msgstr "" #. type: cindex #: doc/guix.texi:17376 #, no-wrap msgid "XKB, keyboard layouts" msgstr "" #. type: Plain text #: doc/guix.texi:17384 msgid "" "Keyboard layouts are represented by records created by the @code{keyboard-" "layout} procedure of @code{(gnu system keyboard)}. Following the X Keyboard " "extension (XKB), each layout has four attributes: a name (often a language " "code such as ``fi'' for Finnish or ``jp'' for Japanese), an optional variant " "name, an optional keyboard model name, and a possibly empty list of " "additional options. In most cases the layout name is all you care about." msgstr "" #. type: deffn #: doc/guix.texi:17385 #, no-wrap msgid "{Scheme Procedure} keyboard-layout @var{name} [@var{variant}] @" msgstr "" #. type: deffn #: doc/guix.texi:17388 msgid "" "[#:model] [#:options '()] Return a new keyboard layout with the given " "@var{name} and @var{variant}." msgstr "" #. type: deffn #: doc/guix.texi:17392 msgid "" "@var{name} must be a string such as @code{\"fr\"}; @var{variant} must be a " "string such as @code{\"bepo\"} or @code{\"nodeadkeys\"}. See the " "@code{xkeyboard-config} package for valid options." msgstr "" #. type: Plain text #: doc/guix.texi:17395 msgid "Here are a few examples:" msgstr "" #. type: lisp #: doc/guix.texi:17400 #, no-wrap msgid "" ";; The German QWERTZ layout. Here we assume a standard\n" ";; \"pc105\" keyboard model.\n" "(keyboard-layout \"de\")\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:17403 #, no-wrap msgid "" ";; The bépo variant of the French layout.\n" "(keyboard-layout \"fr\" \"bepo\")\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:17406 #, no-wrap msgid "" ";; The Catalan layout.\n" "(keyboard-layout \"es\" \"cat\")\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:17409 #, no-wrap msgid "" ";; Arabic layout with \"Alt-Shift\" to switch to US layout.\n" "(keyboard-layout \"ar,us\" #:options '(\"grp:alt_shift_toggle\"))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:17416 #, no-wrap msgid "" ";; The Latin American Spanish layout. In addition, the\n" ";; \"Caps Lock\" key is used as an additional \"Ctrl\" key,\n" ";; and the \"Menu\" key is used as a \"Compose\" key to enter\n" ";; accented letters.\n" "(keyboard-layout \"latam\"\n" " #:options '(\"ctrl:nocaps\" \"compose:menu\"))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:17419 #, no-wrap msgid "" ";; The Russian layout for a ThinkPad keyboard.\n" "(keyboard-layout \"ru\" #:model \"thinkpad\")\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:17424 #, no-wrap msgid "" ";; The \"US international\" layout, which is the US layout plus\n" ";; dead keys to enter accented characters. This is for an\n" ";; Apple MacBook keyboard.\n" "(keyboard-layout \"us\" \"intl\" #:model \"macbook78\")\n" msgstr "" #. type: Plain text #: doc/guix.texi:17428 msgid "" "See the @file{share/X11/xkb} directory of the @code{xkeyboard-config} " "package for a complete list of supported layouts, variants, and models." msgstr "" #. type: cindex #: doc/guix.texi:17429 #, no-wrap msgid "keyboard layout, configuration" msgstr "" #. type: Plain text #: doc/guix.texi:17433 msgid "" "Let's say you want your system to use the Turkish keyboard layout throughout " "your system---bootloader, console, and Xorg. Here's what your system " "configuration would look like:" msgstr "" #. type: findex #: doc/guix.texi:17434 #, no-wrap msgid "set-xorg-configuration" msgstr "" #. type: lisp #: doc/guix.texi:17438 #, no-wrap msgid "" ";; Using the Turkish layout for the bootloader, the console,\n" ";; and for Xorg.\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:17450 #, no-wrap msgid "" "(operating-system\n" " ;; ...\n" " (keyboard-layout (keyboard-layout \"tr\")) ;for the console\n" " (bootloader (bootloader-configuration\n" " (bootloader grub-efi-bootloader)\n" " (targets '(\"/boot/efi\"))\n" " (keyboard-layout keyboard-layout))) ;for GRUB\n" " (services (cons (set-xorg-configuration\n" " (xorg-configuration ;for Xorg\n" " (keyboard-layout keyboard-layout)))\n" " %desktop-services)))\n" msgstr "" #. type: Plain text #: doc/guix.texi:17457 msgid "" "In the example above, for GRUB and for Xorg, we just refer to the " "@code{keyboard-layout} field defined above, but we could just as well refer " "to a different layout. The @code{set-xorg-configuration} procedure " "communicates the desired Xorg configuration to the graphical log-in manager, " "by default GDM." msgstr "" #. type: Plain text #: doc/guix.texi:17460 msgid "" "We've discussed how to specify the @emph{default} keyboard layout of your " "system when it starts, but you can also adjust it at run time:" msgstr "" #. type: itemize #: doc/guix.texi:17465 msgid "" "If you're using GNOME, its settings panel has a ``Region & Language'' entry " "where you can select one or more keyboard layouts." msgstr "" #. type: itemize #: doc/guix.texi:17470 msgid "" "Under Xorg, the @command{setxkbmap} command (from the same-named package) " "allows you to change the current layout. For example, this is how you would " "change the layout to US Dvorak:" msgstr "" #. type: example #: doc/guix.texi:17473 #, no-wrap msgid "setxkbmap us dvorak\n" msgstr "" #. type: itemize #: doc/guix.texi:17480 msgid "" "The @code{loadkeys} command changes the keyboard layout in effect in the " "Linux console. However, note that @code{loadkeys} does @emph{not} use the " "XKB keyboard layout categorization described above. The command below loads " "the French bépo layout:" msgstr "" #. type: example #: doc/guix.texi:17483 #, no-wrap msgid "loadkeys fr-bepo\n" msgstr "" #. type: cindex #: doc/guix.texi:17489 #, no-wrap msgid "locale" msgstr "" #. type: Plain text #: doc/guix.texi:17496 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:17497 #, no-wrap msgid "locale definition" msgstr "" #. type: Plain text #: doc/guix.texi:17501 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:17510 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:17513 msgid "" "For instance, to add the North Frisian locale for Germany, the value of that " "field may be:" msgstr "" #. type: lisp #: doc/guix.texi:17518 #, 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:17522 msgid "" "Likewise, to save space, one might want @code{locale-definitions} to list " "only the locales that are actually used, as in:" msgstr "" #. type: lisp #: doc/guix.texi:17527 #, 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:17536 msgid "" "The compiled locale definitions are available at @file{/run/current-system/" "locale/X.Y}, where @code{X.Y} is the libc version, which is the default " "location where the GNU@tie{}libc provided by Guix looks for locale data. " "This can be overridden using the @env{LOCPATH} environment variable " "(@pxref{locales-and-locpath, @env{LOCPATH} and locale packages})." msgstr "" #. type: Plain text #: doc/guix.texi:17539 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:17540 #, no-wrap msgid "{Data Type} locale-definition" msgstr "" #. type: deftp #: doc/guix.texi:17542 msgid "This is the data type of a locale definition." msgstr "" #. type: table #: doc/guix.texi:17548 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:17552 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:17553 #, no-wrap msgid "@code{charset} (default: @code{\"UTF-8\"})" msgstr "" #. type: table #: doc/guix.texi:17557 msgid "" "The ``character set'' or ``code set'' for that locale, @uref{https://www." "iana.org/assignments/character-sets, as defined by IANA}." msgstr "" #. type: defvr #: doc/guix.texi:17561 #, no-wrap msgid "{Scheme Variable} %default-locale-definitions" msgstr "" #. type: defvr #: doc/guix.texi:17565 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:17566 #, no-wrap msgid "locale name" msgstr "" #. type: cindex #: doc/guix.texi:17567 #, no-wrap msgid "normalized codeset in locale names" msgstr "" #. type: defvr #: doc/guix.texi:17573 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: subsection #: doc/guix.texi:17575 #, no-wrap msgid "Locale Data Compatibility Considerations" msgstr "" #. type: cindex #: doc/guix.texi:17577 #, no-wrap msgid "incompatibility, of locale data" msgstr "" #. type: Plain text #: doc/guix.texi:17584 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:17596 msgid "" "For instance, a program linked against libc version 2.21 is unable to read " "locale data produced with libc 2.22; worse, that program @emph{aborts} " "instead of simply ignoring the incompatible locale data@footnote{Versions " "2.23 and later of GNU@tie{}libc will simply skip the incompatible locale " "data, which is already an improvement.}. Similarly, a program linked " "against libc 2.22 can read most, but not all, of the locale data from libc " "2.21 (specifically, @env{LC_COLLATE} data is incompatible); thus calls to " "@code{setlocale} may fail, but programs will not abort." msgstr "" #. type: Plain text #: doc/guix.texi:17601 msgid "" "The ``problem'' with Guix is that users have a lot of freedom: They can " "choose whether and when to upgrade software in their profiles, and might be " "using a libc version different from the one the system administrator used to " "build the system-wide locale data." msgstr "" #. type: Plain text #: doc/guix.texi:17605 msgid "" "Fortunately, unprivileged users can also install their own locale data and " "define @env{GUIX_LOCPATH} accordingly (@pxref{locales-and-locpath, " "@env{GUIX_LOCPATH} and locale packages})." msgstr "" #. type: Plain text #: doc/guix.texi:17612 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: lisp #: doc/guix.texi:17615 #, no-wrap msgid "" "(use-package-modules base)\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:17619 #, 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:17624 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:17629 #, no-wrap msgid "system services" msgstr "" #. type: Plain text #: doc/guix.texi:17635 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:17642 msgid "" "Guix has a broad definition of ``service'' (@pxref{Service Composition}), " "but many services are managed by the GNU@tie{}Shepherd (@pxref{Shepherd " "Services}). On a running system, the @command{herd} command allows you to " "list the available services, show their status, start and stop them, or do " "other specific operations (@pxref{Jump Start,,, shepherd, The GNU Shepherd " "Manual}). For example:" msgstr "" #. type: example #: doc/guix.texi:17645 #, no-wrap msgid "# herd status\n" msgstr "" #. type: Plain text #: doc/guix.texi:17650 msgid "" "The above command, run as @code{root}, lists the currently defined " "services. The @command{herd doc} command shows a synopsis of the given " "service and its associated actions:" msgstr "" #. type: example #: doc/guix.texi:17654 #, no-wrap msgid "" "# herd doc nscd\n" "Run libc's name service cache daemon (nscd).\n" "\n" msgstr "" #. type: example #: doc/guix.texi:17657 #, no-wrap msgid "" "# herd doc nscd action invalidate\n" "invalidate: Invalidate the given cache--e.g., 'hosts' for host name lookups.\n" msgstr "" #. type: Plain text #: doc/guix.texi:17662 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:17669 #, 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: cindex #: doc/guix.texi:17671 #, no-wrap msgid "configuration, action for shepherd services" msgstr "" #. type: cindex #: doc/guix.texi:17672 #, no-wrap msgid "configuration file, of a shepherd service" msgstr "" #. type: Plain text #: doc/guix.texi:17676 msgid "" "For some services, @command{herd configuration} returns the name of the " "service's configuration file, which can be handy to inspect its " "configuration:" msgstr "" #. type: example #: doc/guix.texi:17680 #, no-wrap msgid "" "# herd configuration sshd\n" "/gnu/store/@dots{}-sshd_config\n" msgstr "" #. type: Plain text #: doc/guix.texi:17685 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: subsection #: doc/guix.texi:17723 doc/guix.texi:27101 doc/guix.texi:27102 #, no-wrap msgid "File-Sharing Services" msgstr "" #. type: menuentry #: doc/guix.texi:17723 msgid "File-sharing services." msgstr "" #. type: subsection #: doc/guix.texi:17723 doc/guix.texi:31084 doc/guix.texi:31085 #, no-wrap msgid "VNC Services" msgstr "" #. type: menuentry #: doc/guix.texi:17723 msgid "VNC daemons." msgstr "" #. type: Plain text #: doc/guix.texi:17731 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:17732 #, no-wrap msgid "{Scheme Variable} %base-services" msgstr "" #. type: defvr #: doc/guix.texi:17738 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:17743 msgid "" "This is the default value of the @code{services} field of @code{operating-" "system} declarations. Usually, when customizing a system, you will want to " "append services to @code{%base-services}, like this:" msgstr "" #. type: lisp #: doc/guix.texi:17748 #, no-wrap msgid "" "(append (list (service avahi-service-type)\n" " (service openssh-service-type))\n" " %base-services)\n" msgstr "" #. type: defvr #: doc/guix.texi:17751 #, no-wrap msgid "{Scheme Variable} special-files-service-type" msgstr "" #. type: defvr #: doc/guix.texi:17754 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:17758 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:17759 #, no-wrap msgid "/bin/sh" msgstr "" #. type: cindex #: doc/guix.texi:17760 #, no-wrap msgid "@file{sh}, in @file{/bin}" msgstr "" #. type: lisp #: doc/guix.texi:17764 #, no-wrap msgid "" "`((\"/bin/sh\" ,(file-append bash \"/bin/sh\"))\n" " (\"/usr/bin/env\" ,(file-append coreutils \"/bin/env\")))\n" msgstr "" #. type: file{#1} #: doc/guix.texi:17766 #, no-wrap msgid "/usr/bin/env" msgstr "" #. type: cindex #: doc/guix.texi:17767 #, no-wrap msgid "@file{env}, in @file{/usr/bin}" msgstr "" #. type: defvr #: doc/guix.texi:17770 msgid "" "If you want to add, say, @code{/bin/bash} to your system, you can change it " "to:" msgstr "" #. type: lisp #: doc/guix.texi:17775 #, no-wrap msgid "" "`((\"/bin/sh\" ,(file-append bash \"/bin/sh\"))\n" " (\"/usr/bin/env\" ,(file-append coreutils \"/bin/env\"))\n" " (\"/bin/bash\" ,(file-append bash \"/bin/bash\")))\n" msgstr "" #. type: defvr #: doc/guix.texi:17782 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:17784 #, no-wrap msgid "{Scheme Procedure} extra-special-file @var{file} @var{target}" msgstr "" #. type: deffn #: doc/guix.texi:17786 msgid "Use @var{target} as the ``special file'' @var{file}." msgstr "" #. type: deffn #: doc/guix.texi:17790 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: lisp #: doc/guix.texi:17794 #, no-wrap msgid "" "(extra-special-file \"/usr/bin/env\"\n" " (file-append coreutils \"/bin/env\"))\n" msgstr "" #. type: deffn #: doc/guix.texi:17797 #, no-wrap msgid "{Scheme Procedure} host-name-service @var{name}" msgstr "" #. type: deffn #: doc/guix.texi:17799 msgid "Return a service that sets the host name to @var{name}." msgstr "" #. type: defvr #: doc/guix.texi:17801 #, no-wrap msgid "{Scheme Variable} console-font-service-type" msgstr "" #. type: defvr #: doc/guix.texi:17806 msgid "" "Install the given fonts on the specified ttys (fonts are per virtual console " "on the kernel Linux). The value of this service is a list of tty/font " "pairs. The font can be the name of a font provided by the @code{kbd} " "package or any valid argument to @command{setfont}, as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:17815 #, no-wrap msgid "" "`((\"tty1\" . \"LatGrkCyr-8x16\")\n" " (\"tty2\" . ,(file-append\n" " font-tamzen\n" " \"/share/kbd/consolefonts/TamzenForPowerline10x20.psf\"))\n" " (\"tty3\" . ,(file-append\n" " font-terminus\n" " \"/share/consolefonts/ter-132n\"))) ; for HDPI\n" msgstr "" #. type: deffn #: doc/guix.texi:17818 #, no-wrap msgid "{Scheme Procedure} login-service @var{config}" msgstr "" #. type: deffn #: doc/guix.texi:17822 msgid "" "Return a service to run login according to @var{config}, a @code{} object, which specifies the message of the day, among other " "things." msgstr "" #. type: deftp #: doc/guix.texi:17824 #, no-wrap msgid "{Data Type} login-configuration" msgstr "" #. type: deftp #: doc/guix.texi:17826 msgid "This is the data type representing the configuration of login." msgstr "" #. type: code{#1} #: doc/guix.texi:17829 doc/guix.texi:18761 #, no-wrap msgid "motd" msgstr "" #. type: cindex #: doc/guix.texi:17830 #, no-wrap msgid "message of the day" msgstr "" #. type: table #: doc/guix.texi:17832 doc/guix.texi:18763 msgid "A file-like object containing the ``message of the day''." msgstr "" #. type: item #: doc/guix.texi:17833 doc/guix.texi:18764 doc/guix.texi:21429 #, no-wrap msgid "@code{allow-empty-passwords?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:17836 doc/guix.texi:18767 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:17840 #, no-wrap msgid "{Scheme Procedure} mingetty-service @var{config}" msgstr "" #. type: deffn #: doc/guix.texi:17844 msgid "" "Return a service to run mingetty according to @var{config}, a " "@code{} object, which specifies the tty to run, " "among other things." msgstr "" #. type: deftp #: doc/guix.texi:17846 #, no-wrap msgid "{Data Type} mingetty-configuration" msgstr "" #. type: deftp #: doc/guix.texi:17849 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:17852 doc/guix.texi:17891 doc/guix.texi:36713 #, no-wrap msgid "tty" msgstr "" #. type: table #: doc/guix.texi:17854 msgid "The name of the console this Mingetty runs on---e.g., @code{\"tty1\"}." msgstr "" #. type: item #: doc/guix.texi:17855 doc/guix.texi:17920 doc/guix.texi:18083 #, no-wrap msgid "@code{auto-login} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17859 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:17860 #, no-wrap msgid "@code{login-program} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17864 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:17865 #, no-wrap msgid "@code{login-pause?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17868 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:17869 #, no-wrap msgid "@code{clear-on-logout?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:17871 msgid "When set to @code{#t}, the screen will be cleared after logout." msgstr "" #. type: item #: doc/guix.texi:17872 #, no-wrap msgid "@code{mingetty} (default: @var{mingetty})" msgstr "" #. type: table #: doc/guix.texi:17874 msgid "The Mingetty package to use." msgstr "" #. type: deffn #: doc/guix.texi:17878 #, no-wrap msgid "{Scheme Procedure} agetty-service @var{config}" msgstr "" #. type: deffn #: doc/guix.texi:17882 msgid "" "Return a service to run agetty according to @var{config}, an @code{} object, which specifies the tty to run, among other things." msgstr "" #. type: deftp #: doc/guix.texi:17884 #, no-wrap msgid "{Data Type} agetty-configuration" msgstr "" #. type: deftp #: doc/guix.texi:17888 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:17895 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:17899 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:17903 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:17907 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:17908 doc/guix.texi:36874 #, no-wrap msgid "@code{baud-rate} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17911 msgid "" "A string containing a comma-separated list of one or more baud rates, in " "descending order." msgstr "" #. type: item #: doc/guix.texi:17912 #, no-wrap msgid "@code{term} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17915 msgid "" "A string containing the value used for the @env{TERM} environment variable." msgstr "" #. type: item #: doc/guix.texi:17916 #, no-wrap msgid "@code{eight-bits?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17919 msgid "" "When @code{#t}, the tty is assumed to be 8-bit clean, and parity detection " "is disabled." msgstr "" #. type: table #: doc/guix.texi:17923 doc/guix.texi:18086 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:17924 #, no-wrap msgid "@code{no-reset?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17926 msgid "When @code{#t}, don't reset terminal cflags (control modes)." msgstr "" #. type: item #: doc/guix.texi:17927 #, no-wrap msgid "@code{host} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17930 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:17931 #, no-wrap msgid "@code{remote?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17935 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:17936 #, no-wrap msgid "@code{flow-control?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17938 msgid "When set to @code{#t}, enable hardware (RTS/CTS) flow control." msgstr "" #. type: item #: doc/guix.texi:17939 #, no-wrap msgid "@code{no-issue?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17942 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:17943 #, no-wrap msgid "@code{init-string} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17946 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:17947 #, no-wrap msgid "@code{no-clear?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17950 msgid "" "When set to @code{#t}, agetty will not clear the screen before showing the " "login prompt." msgstr "" #. type: item #: doc/guix.texi:17951 #, no-wrap msgid "@code{login-program} (default: (file-append shadow \"/bin/login\"))" msgstr "" #. type: table #: doc/guix.texi:17955 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:17956 #, no-wrap msgid "@code{local-line} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17960 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:17961 #, no-wrap msgid "@code{extract-baud?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17964 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:17965 #, no-wrap msgid "@code{skip-login?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17969 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:17970 #, no-wrap msgid "@code{no-newline?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17973 msgid "" "When set to @code{#t}, do not print a newline before printing the @file{/etc/" "issue} file." msgstr "" #. type: item #: doc/guix.texi:17975 #, no-wrap msgid "@code{login-options} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17980 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:17981 #, no-wrap msgid "@code{login-pause} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17985 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:17986 doc/guix.texi:31898 #, no-wrap msgid "@code{chroot} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17989 msgid "" "Change root to the specified directory. This option accepts a directory " "path as a string." msgstr "" #. type: item #: doc/guix.texi:17990 #, no-wrap msgid "@code{hangup?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17993 msgid "" "Use the Linux system call @code{vhangup} to do a virtual hangup of the " "specified terminal." msgstr "" #. type: item #: doc/guix.texi:17994 #, no-wrap msgid "@code{keep-baud?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:17998 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:17999 #, no-wrap msgid "@code{timeout} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:18002 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:18003 #, no-wrap msgid "@code{detect-case?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:18009 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:18010 #, no-wrap msgid "@code{wait-cr?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:18015 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:18016 #, no-wrap msgid "@code{no-hints?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:18019 msgid "" "When set to @code{#t}, do not print hints about Num, Caps, and Scroll locks." msgstr "" #. type: item #: doc/guix.texi:18020 #, no-wrap msgid "@code{no-hostname?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:18023 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:18024 #, no-wrap msgid "@code{long-hostname?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:18028 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:18029 #, no-wrap msgid "@code{erase-characters} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:18032 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:18033 #, no-wrap msgid "@code{kill-characters} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:18037 msgid "" "This option accepts a string that should be interpreted to mean ``ignore all " "previous characters'' (also called a ``kill'' character) when the user types " "their login name." msgstr "" #. type: item #: doc/guix.texi:18038 #, no-wrap msgid "@code{chdir} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:18041 msgid "" "This option accepts, as a string, a directory path that will be changed to " "before login." msgstr "" #. type: item #: doc/guix.texi:18042 #, no-wrap msgid "@code{delay} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:18045 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:18046 #, no-wrap msgid "@code{nice} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:18049 msgid "" "This option accepts, as an integer, the nice value with which to run the " "@command{login} program." msgstr "" #. type: item #: doc/guix.texi:18050 doc/guix.texi:18354 doc/guix.texi:19647 #: doc/guix.texi:28085 doc/guix.texi:29483 doc/guix.texi:32056 #: doc/guix.texi:32883 doc/guix.texi:34658 doc/guix.texi:37214 #, no-wrap msgid "@code{extra-options} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:18053 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: item #: doc/guix.texi:18054 doc/guix.texi:29164 #, no-wrap msgid "@code{shepherd-requirement} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:18057 msgid "" "The option can be used to provides extra shepherd requirements (for example " "@code{'syslogd}) to the respective @code{'term-}* shepherd service." msgstr "" #. type: deffn #: doc/guix.texi:18061 #, no-wrap msgid "{Scheme Procedure} kmscon-service-type @var{config}" msgstr "" #. type: deffn #: doc/guix.texi:18065 msgid "" "Return a service to run @uref{https://www.freedesktop.org/wiki/Software/" "kmscon,kmscon} according to @var{config}, a @code{} " "object, which specifies the tty to run, among other things." msgstr "" #. type: deftp #: doc/guix.texi:18067 #, no-wrap msgid "{Data Type} kmscon-configuration" msgstr "" #. type: deftp #: doc/guix.texi:18070 msgid "" "This is the data type representing the configuration of Kmscon, which " "implements virtual console log-in." msgstr "" #. type: code{#1} #: doc/guix.texi:18073 #, no-wrap msgid "virtual-terminal" msgstr "" #. type: table #: doc/guix.texi:18075 msgid "The name of the console this Kmscon runs on---e.g., @code{\"tty1\"}." msgstr "" #. type: item #: doc/guix.texi:18076 #, no-wrap msgid "@code{login-program} (default: @code{#~(string-append #$shadow \"/bin/login\")})" msgstr "" #. type: table #: doc/guix.texi:18079 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:18080 #, no-wrap msgid "@code{login-arguments} (default: @code{'(\"-p\")})" msgstr "" #. type: table #: doc/guix.texi:18082 msgid "A list of arguments to pass to @command{login}." msgstr "" #. type: item #: doc/guix.texi:18087 #, no-wrap msgid "@code{hardware-acceleration?} (default: #f)" msgstr "" #. type: table #: doc/guix.texi:18089 msgid "Whether to use hardware acceleration." msgstr "" #. type: item #: doc/guix.texi:18090 #, no-wrap msgid "@code{font-engine} (default: @code{\"pango\"})" msgstr "" #. type: table #: doc/guix.texi:18092 msgid "Font engine used in Kmscon." msgstr "" #. type: item #: doc/guix.texi:18093 #, no-wrap msgid "@code{font-size} (default: @code{12})" msgstr "" #. type: table #: doc/guix.texi:18095 msgid "Font size used in Kmscon." msgstr "" #. type: table #: doc/guix.texi:18099 msgid "" "If this is @code{#f}, Kmscon uses the default keyboard layout---usually US " "English (``qwerty'') for a 105-key PC keyboard." msgstr "" #. type: table #: doc/guix.texi:18103 msgid "" "Otherwise this must be a @code{keyboard-layout} object specifying the " "keyboard layout. @xref{Keyboard Layout}, for more information on how to " "specify the keyboard layout." msgstr "" #. type: item #: doc/guix.texi:18104 #, no-wrap msgid "@code{kmscon} (default: @var{kmscon})" msgstr "" #. type: table #: doc/guix.texi:18106 msgid "The Kmscon package to use." msgstr "" #. type: cindex #: doc/guix.texi:18110 #, no-wrap msgid "name service cache daemon" msgstr "" #. type: cindex #: doc/guix.texi:18111 #, no-wrap msgid "nscd" msgstr "" #. type: deffn #: doc/guix.texi:18112 #, no-wrap msgid "{Scheme Procedure} nscd-service [@var{config}] [#:glibc glibc] @" msgstr "" #. type: deffn #: doc/guix.texi:18117 msgid "" "[#:name-services '()] Return a service that runs the libc name service cache " "daemon (nscd) with the given @var{config}---an @code{} " "object. @xref{Name Service Switch}, for an example." msgstr "" #. type: deffn #: doc/guix.texi:18119 msgid "" "For convenience, the Shepherd service for nscd provides the following " "actions:" msgstr "" #. type: item #: doc/guix.texi:18121 #, no-wrap msgid "invalidate" msgstr "" #. type: cindex #: doc/guix.texi:18122 #, no-wrap msgid "cache invalidation, nscd" msgstr "" #. type: cindex #: doc/guix.texi:18123 #, no-wrap msgid "nscd, cache invalidation" msgstr "" #. type: table #: doc/guix.texi:18125 msgid "This invalidate the given cache. For instance, running:" msgstr "" #. type: example #: doc/guix.texi:18128 #, no-wrap msgid "herd invalidate nscd hosts\n" msgstr "" #. type: table #: doc/guix.texi:18132 msgid "invalidates the host name lookup cache of nscd." msgstr "" #. type: item #: doc/guix.texi:18133 #, no-wrap msgid "statistics" msgstr "" #. type: table #: doc/guix.texi:18136 msgid "" "Running @command{herd statistics nscd} displays information about nscd usage " "and caches." msgstr "" #. type: defvr #: doc/guix.texi:18140 #, no-wrap msgid "{Scheme Variable} %nscd-default-configuration" msgstr "" #. type: defvr #: doc/guix.texi:18144 msgid "" "This is the default @code{} value (see below) used by " "@code{nscd-service}. It uses the caches defined by @code{%nscd-default-" "caches}; see below." msgstr "" #. type: deftp #: doc/guix.texi:18146 #, no-wrap msgid "{Data Type} nscd-configuration" msgstr "" #. type: deftp #: doc/guix.texi:18149 msgid "" "This is the data type representing the name service cache daemon (nscd) " "configuration." msgstr "" #. type: item #: doc/guix.texi:18152 #, no-wrap msgid "@code{name-services} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:18155 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:18156 #, no-wrap msgid "@code{glibc} (default: @var{glibc})" msgstr "" #. type: table #: doc/guix.texi:18159 msgid "" "Package object denoting the GNU C Library providing the @command{nscd} " "command." msgstr "" #. type: item #: doc/guix.texi:18160 #, no-wrap msgid "@code{log-file} (default: @code{\"/var/log/nscd.log\"})" msgstr "" #. type: table #: doc/guix.texi:18163 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:18164 #, no-wrap msgid "@code{debug-level} (default: @code{0})" msgstr "" #. type: table #: doc/guix.texi:18167 msgid "" "Integer denoting the debugging levels. Higher numbers mean that more " "debugging output is logged." msgstr "" #. type: item #: doc/guix.texi:18168 #, no-wrap msgid "@code{caches} (default: @code{%nscd-default-caches})" msgstr "" #. type: table #: doc/guix.texi:18171 msgid "" "List of @code{} objects denoting things to be cached; see below." msgstr "" #. type: deftp #: doc/guix.texi:18175 #, no-wrap msgid "{Data Type} nscd-cache" msgstr "" #. type: deftp #: doc/guix.texi:18177 msgid "Data type representing a cache database of nscd and its parameters." msgstr "" #. type: cindex #: doc/guix.texi:18180 doc/guix.texi:23956 #, no-wrap msgid "database" msgstr "" #. type: table #: doc/guix.texi:18185 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:18186 #, no-wrap msgid "positive-time-to-live" msgstr "" #. type: itemx #: doc/guix.texi:18187 #, no-wrap msgid "@code{negative-time-to-live} (default: @code{20})" msgstr "" #. type: table #: doc/guix.texi:18190 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:18191 #, no-wrap msgid "@code{check-files?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:18194 msgid "" "Whether to check for updates of the files corresponding to @var{database}." msgstr "" #. type: table #: doc/guix.texi:18198 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:18199 #, no-wrap msgid "@code{persistent?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:18201 msgid "Whether the cache should be stored persistently on disk." msgstr "" #. type: item #: doc/guix.texi:18202 #, no-wrap msgid "@code{shared?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:18204 msgid "Whether the cache should be shared among users." msgstr "" #. type: item #: doc/guix.texi:18205 #, no-wrap msgid "@code{max-database-size} (default: 32@tie{}MiB)" msgstr "" #. type: table #: doc/guix.texi:18207 msgid "Maximum size in bytes of the database cache." msgstr "" #. type: defvr #: doc/guix.texi:18214 #, no-wrap msgid "{Scheme Variable} %nscd-default-caches" msgstr "" #. type: defvr #: doc/guix.texi:18217 msgid "" "List of @code{} objects used by default by @code{nscd-" "configuration} (see above)." msgstr "" #. type: defvr #: doc/guix.texi:18223 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:18226 msgid "syslog-configuration-type" msgstr "" #. type: cindex #: doc/guix.texi:18226 doc/guix.texi:18242 #, no-wrap msgid "syslog" msgstr "" #. type: cindex #: doc/guix.texi:18227 doc/guix.texi:19080 #, no-wrap msgid "logging" msgstr "" #. type: deftp #: doc/guix.texi:18228 #, no-wrap msgid "{Data Type} syslog-configuration" msgstr "" #. type: deftp #: doc/guix.texi:18230 msgid "This data type represents the configuration of the syslog daemon." msgstr "" #. type: item #: doc/guix.texi:18232 #, no-wrap msgid "@code{syslogd} (default: @code{#~(string-append #$inetutils \"/libexec/syslogd\")})" msgstr "" #. type: table #: doc/guix.texi:18234 msgid "The syslog daemon to use." msgstr "" #. type: item #: doc/guix.texi:18235 #, no-wrap msgid "@code{config-file} (default: @code{%default-syslog.conf})" msgstr "" #. type: table #: doc/guix.texi:18237 msgid "The syslog configuration file to use." msgstr "" #. type: anchor{#1} #: doc/guix.texi:18242 msgid "syslog-service" msgstr "" #. type: deffn #: doc/guix.texi:18243 #, no-wrap msgid "{Scheme Procedure} syslog-service @var{config}" msgstr "" #. type: deffn #: doc/guix.texi:18245 msgid "Return a service that runs a syslog daemon according to @var{config}." msgstr "" #. type: deffn #: doc/guix.texi:18248 msgid "" "@xref{syslogd invocation,,, inetutils, GNU Inetutils}, for more information " "on the configuration file syntax." msgstr "" #. type: defvr #: doc/guix.texi:18250 #, no-wrap msgid "{Scheme Variable} guix-service-type" msgstr "" #. type: defvr #: doc/guix.texi:18254 msgid "" "This is the type of the service that runs the build daemon, @command{guix-" "daemon} (@pxref{Invoking guix-daemon}). Its value must be a @code{guix-" "configuration} record as described below." msgstr "" #. type: anchor{#1} #: doc/guix.texi:18257 msgid "guix-configuration-type" msgstr "" #. type: deftp #: doc/guix.texi:18257 #, no-wrap msgid "{Data Type} guix-configuration" msgstr "" #. type: deftp #: doc/guix.texi:18260 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:18262 #, no-wrap msgid "@code{guix} (default: @var{guix})" msgstr "" #. type: table #: doc/guix.texi:18264 doc/guix.texi:18572 msgid "The Guix package to use." msgstr "" #. type: item #: doc/guix.texi:18265 #, no-wrap msgid "@code{build-group} (default: @code{\"guixbuild\"})" msgstr "" #. type: table #: doc/guix.texi:18267 msgid "Name of the group for build user accounts." msgstr "" #. type: item #: doc/guix.texi:18268 #, no-wrap msgid "@code{build-accounts} (default: @code{10})" msgstr "" #. type: table #: doc/guix.texi:18270 msgid "Number of build user accounts to create." msgstr "" #. type: item #: doc/guix.texi:18271 #, no-wrap msgid "@code{authorize-key?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:18278 msgid "" "Whether to authorize the substitute keys listed in @code{authorized-keys}---" "by default that of @code{@value{SUBSTITUTE-SERVER-1}} and " "@code{@value{SUBSTITUTE-SERVER-2}} (@pxref{Substitutes})." msgstr "" #. type: table #: doc/guix.texi:18284 msgid "" "When @code{authorize-key?} is true, @file{/etc/guix/acl} cannot be changed " "by invoking @command{guix archive --authorize}. You must instead adjust " "@code{guix-configuration} as you wish and reconfigure the system. This " "ensures that your operating system configuration file is self-contained." msgstr "" #. type: quotation #: doc/guix.texi:18291 msgid "" "When booting or reconfiguring to a system where @code{authorize-key?} is " "true, the existing @file{/etc/guix/acl} file is backed up as @file{/etc/guix/" "acl.bak} if it was determined to be a manually modified file. This is to " "facilitate migration from earlier versions, which allowed for in-place " "modifications to @file{/etc/guix/acl}." msgstr "" #. type: vindex #: doc/guix.texi:18293 #, no-wrap msgid "%default-authorized-guix-keys" msgstr "" #. type: item #: doc/guix.texi:18294 #, no-wrap msgid "@code{authorized-keys} (default: @code{%default-authorized-guix-keys})" msgstr "" #. type: table #: doc/guix.texi:18300 msgid "" "The list of authorized key files for archive imports, as a list of string-" "valued gexps (@pxref{Invoking guix archive}). By default, it contains that " "of @code{@value{SUBSTITUTE-SERVER-1}} and @code{@value{SUBSTITUTE-SERVER-2}} " "(@pxref{Substitutes}). See @code{substitute-urls} below for an example on " "how to change it." msgstr "" #. type: item #: doc/guix.texi:18301 #, no-wrap msgid "@code{use-substitutes?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:18303 msgid "Whether to use substitutes." msgstr "" #. type: item #: doc/guix.texi:18304 doc/guix.texi:32153 #, no-wrap msgid "@code{substitute-urls} (default: @code{%default-substitute-urls})" msgstr "" #. type: table #: doc/guix.texi:18306 doc/guix.texi:32155 msgid "The list of URLs where to look for substitutes by default." msgstr "" #. type: table #: doc/guix.texi:18313 msgid "" "Suppose you would like to fetch substitutes from @code{guix.example.org} in " "addition to @code{@value{SUBSTITUTE-SERVER-1}}. You will need to do two " "things: (1) add @code{guix.example.org} to @code{substitute-urls}, and (2) " "authorize its signing key, having done appropriate checks (@pxref{Substitute " "Server Authorization}). The configuration below does exactly that:" msgstr "" #. type: lisp #: doc/guix.texi:18322 #, no-wrap msgid "" "(guix-configuration\n" " (substitute-urls\n" " (append (list \"https://guix.example.org\")\n" " %default-substitute-urls))\n" " (authorized-keys\n" " (append (list (local-file \"./guix.example.org-key.pub\"))\n" " %default-authorized-guix-keys)))\n" msgstr "" #. type: table #: doc/guix.texi:18327 msgid "" "This example assumes that the file @file{./guix.example.org-key.pub} " "contains the public key that @code{guix.example.org} uses to sign " "substitutes." msgstr "" #. type: item #: doc/guix.texi:18328 #, no-wrap msgid "@code{generate-substitute-key?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:18332 msgid "" "Whether to generate a @dfn{substitute key pair} under @file{/etc/guix/" "signing-key.pub} and @file{/etc/guix/signing-key.sec} if there is not " "already one." msgstr "" #. type: table #: doc/guix.texi:18339 msgid "" "This key pair is used when exporting store items, for instance with " "@command{guix publish} (@pxref{Invoking guix publish}) or @command{guix " "archive} (@pxref{Invoking guix archive}). Generating a key pair takes a few " "seconds when enough entropy is available and is only done once; you might " "want to turn it off for instance in a virtual machine that does not need it " "and where the extra boot time is a problem." msgstr "" #. type: item #: doc/guix.texi:18340 #, no-wrap msgid "@code{max-silent-time} (default: @code{0})" msgstr "" #. type: itemx #: doc/guix.texi:18341 #, no-wrap msgid "@code{timeout} (default: @code{0})" msgstr "" #. type: table #: doc/guix.texi:18345 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:18346 #, no-wrap msgid "@code{log-compression} (default: @code{'gzip})" msgstr "" #. type: table #: doc/guix.texi:18349 msgid "" "The type of compression used for build logs---one of @code{gzip}, " "@code{bzip2}, or @code{none}." msgstr "" #. type: item #: doc/guix.texi:18350 #, no-wrap msgid "@code{discover?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:18356 msgid "List of extra command-line options for @command{guix-daemon}." msgstr "" #. type: item #: doc/guix.texi:18357 #, no-wrap msgid "@code{log-file} (default: @code{\"/var/log/guix-daemon.log\"})" msgstr "" #. type: table #: doc/guix.texi:18360 msgid "" "File where @command{guix-daemon}'s standard output and standard error are " "written." msgstr "" #. type: cindex #: doc/guix.texi:18361 #, no-wrap msgid "HTTP proxy, for @code{guix-daemon}" msgstr "" #. type: cindex #: doc/guix.texi:18362 #, no-wrap msgid "proxy, for @code{guix-daemon} HTTP access" msgstr "" #. type: item #: doc/guix.texi:18363 #, no-wrap msgid "@code{http-proxy} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:18366 msgid "" "The URL of the HTTP and HTTPS proxy used for downloading fixed-output " "derivations and substitutes." msgstr "" #. type: table #: doc/guix.texi:18369 msgid "" "It is also possible to change the daemon's proxy at run time through the " "@code{set-http-proxy} action, which restarts it:" msgstr "" #. type: example #: doc/guix.texi:18372 #, no-wrap msgid "herd set-http-proxy guix-daemon http://localhost:8118\n" msgstr "" #. type: table #: doc/guix.texi:18375 msgid "To clear the proxy settings, run:" msgstr "" #. type: example #: doc/guix.texi:18378 #, no-wrap msgid "herd set-http-proxy guix-daemon\n" msgstr "" #. type: item #: doc/guix.texi:18380 #, no-wrap msgid "@code{tmpdir} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:18382 msgid "A directory path where the @command{guix-daemon} will perform builds." msgstr "" #. type: deftp #: doc/guix.texi:18386 #, no-wrap msgid "{Data Type} guix-extension" msgstr "" #. type: deftp #: doc/guix.texi:18392 msgid "" "This data type represents the parameters of the Guix build daemon that are " "extendable. This is the type of the object that must be used within a guix " "service extension. @xref{Service Composition}, for more information." msgstr "" #. type: item #: doc/guix.texi:18394 doc/guix.texi:20589 doc/guix.texi:41386 #, no-wrap msgid "@code{authorized-keys} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:18396 msgid "A list of file-like objects where each element contains a public key." msgstr "" #. type: item #: doc/guix.texi:18397 #, no-wrap msgid "@code{substitute-urls} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:18399 msgid "A list of strings where each element is a substitute URL." msgstr "" #. type: item #: doc/guix.texi:18400 #, no-wrap msgid "@code{chroot-directories} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:18402 msgid "" "A list of file-like objects or strings pointing to additional directories " "the build daemon can use." msgstr "" #. type: deffn #: doc/guix.texi:18405 #, no-wrap msgid "{Scheme Procedure} udev-service [#:udev @var{eudev} #:rules @code{'()}]" msgstr "" #. type: deffn #: doc/guix.texi:18411 msgid "" "Run @var{udev}, which populates the @file{/dev} directory dynamically. udev " "rules can be provided as a list of files through the @var{rules} variable. " "The procedures @code{udev-rule}, @code{udev-rules-service} and @code{file-" ">udev-rule} from @code{(gnu services base)} simplify the creation of such " "rule files." msgstr "" #. type: deffn #: doc/guix.texi:18414 msgid "" "The @command{herd rules udev} command, as root, returns the name of the " "directory containing all the active udev rules." msgstr "" #. type: deffn #: doc/guix.texi:18416 #, no-wrap msgid "{Scheme Procedure} udev-rule [@var{file-name} @var{contents}]" msgstr "" #. type: deffn #: doc/guix.texi:18419 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:18423 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: lisp #: doc/guix.texi:18431 #, 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:18434 #, no-wrap msgid "{Scheme Procedure} udev-rules-service [@var{name} @var{rules}] @" msgstr "" #. type: deffn #: doc/guix.texi:18441 msgid "" "[#:groups @var{groups}] Return a service that extends @code{udev-service-" "type } with @var{rules} and @code{account-service-type} with @var{groups} as " "system groups. This works by creating a singleton service type " "@code{@var{name}-udev-rules}, of which the returned service is an instance." msgstr "" #. type: deffn #: doc/guix.texi:18444 msgid "" "Here we show how it can be used to extend @code{udev-service-type} with the " "previously defined rule @code{%example-udev-rule}." msgstr "" #. type: lisp #: doc/guix.texi:18451 #, no-wrap msgid "" "(operating-system\n" " ;; @dots{}\n" " (services\n" " (cons (udev-rules-service 'usb-thing %example-udev-rule)\n" " %desktop-services)))\n" msgstr "" #. type: deffn #: doc/guix.texi:18454 #, no-wrap msgid "{Scheme Procedure} file->udev-rule [@var{file-name} @var{file}]" msgstr "" #. type: deffn #: doc/guix.texi:18457 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:18459 msgid "The following example showcases how we can use an existing rule file." msgstr "" #. type: lisp #: doc/guix.texi:18464 #, no-wrap msgid "" "(use-modules (guix download) ;for url-fetch\n" " (guix packages) ;for origin\n" " @dots{})\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:18475 #, 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: Plain text #: doc/guix.texi:18484 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: Plain text #: doc/guix.texi:18493 msgid "" "The following example shows how to use the @var{android-udev-rules} package " "so that the Android tool @command{adb} can detect devices without root " "privileges. It also details how to create the @code{adbusers} group, which " "is required for the proper functioning of the rules defined within the " "@code{android-udev-rules} package. To create such a group, we must define " "it both as part of the @code{supplementary-groups} of our @code{user-" "account} declaration, as well as in the @var{groups} of the @code{udev-rules-" "service} procedure." msgstr "" #. type: lisp #: doc/guix.texi:18498 #, 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: lisp #: doc/guix.texi:18511 #, no-wrap msgid "" "(operating-system\n" " ;; @dots{}\n" " (users (cons (user-account\n" " ;; @dots{}\n" " (supplementary-groups\n" " '(\"adbusers\" ;for adb\n" " \"wheel\" \"netdev\" \"audio\" \"video\")))))\n" " ;; @dots{}\n" " (services\n" " (cons (udev-rules-service 'android android-udev-rules\n" " #:groups '(\"adbusers\"))\n" " %desktop-services)))\n" msgstr "" #. type: defvr #: doc/guix.texi:18513 #, no-wrap msgid "{Scheme Variable} urandom-seed-service-type" msgstr "" #. type: defvr #: doc/guix.texi:18518 msgid "" "Save some entropy in @code{%random-seed-file} to seed @file{/dev/urandom} " "when rebooting. It also tries to seed @file{/dev/urandom} from @file{/dev/" "hwrng} while booting, if @file{/dev/hwrng} exists and is readable." msgstr "" #. type: defvr #: doc/guix.texi:18520 #, no-wrap msgid "{Scheme Variable} %random-seed-file" msgstr "" #. type: defvr #: doc/guix.texi:18524 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:18526 #, no-wrap msgid "mouse" msgstr "" #. type: cindex #: doc/guix.texi:18527 #, no-wrap msgid "gpm" msgstr "" #. type: defvr #: doc/guix.texi:18528 #, no-wrap msgid "{Scheme Variable} gpm-service-type" msgstr "" #. type: defvr #: doc/guix.texi:18533 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:18536 msgid "" "The value for services of this type must be a @code{gpm-configuration} (see " "below). This service is not part of @code{%base-services}." msgstr "" #. type: deftp #: doc/guix.texi:18538 #, no-wrap msgid "{Data Type} gpm-configuration" msgstr "" #. type: deftp #: doc/guix.texi:18540 msgid "Data type representing the configuration of GPM." msgstr "" #. type: item #: doc/guix.texi:18542 #, no-wrap msgid "@code{options} (default: @code{%default-gpm-options})" msgstr "" #. type: table #: doc/guix.texi:18547 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:18548 #, no-wrap msgid "@code{gpm} (default: @code{gpm})" msgstr "" #. type: table #: doc/guix.texi:18550 msgid "The GPM package to use." msgstr "" #. type: anchor{#1} #: doc/guix.texi:18555 msgid "guix-publish-service-type" msgstr "" #. type: deffn #: doc/guix.texi:18555 #, no-wrap msgid "{Scheme Variable} guix-publish-service-type" msgstr "" #. type: deffn #: doc/guix.texi:18559 msgid "" "This is the service type for @command{guix publish} (@pxref{Invoking guix " "publish}). Its value must be a @code{guix-publish-configuration} object, as " "described below." msgstr "" #. type: deffn #: doc/guix.texi:18563 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:18565 #, no-wrap msgid "{Data Type} guix-publish-configuration" msgstr "" #. type: deftp #: doc/guix.texi:18568 msgid "" "Data type representing the configuration of the @code{guix publish} service." msgstr "" #. type: item #: doc/guix.texi:18570 #, no-wrap msgid "@code{guix} (default: @code{guix})" msgstr "" #. type: item #: doc/guix.texi:18573 doc/guix.texi:34513 #, no-wrap msgid "@code{port} (default: @code{80})" msgstr "" #. type: table #: doc/guix.texi:18575 msgid "The TCP port to listen for connections." msgstr "" #. type: item #: doc/guix.texi:18576 doc/guix.texi:32036 doc/guix.texi:35917 #, no-wrap msgid "@code{host} (default: @code{\"localhost\"})" msgstr "" #. type: table #: doc/guix.texi:18579 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: item #: doc/guix.texi:18580 #, no-wrap msgid "@code{advertise?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:18583 msgid "" "When true, advertise the service on the local network @i{via} the DNS-SD " "protocol, using Avahi." msgstr "" #. type: table #: doc/guix.texi:18587 msgid "" "This allows neighboring Guix devices with discovery on (see @code{guix-" "configuration} above) to discover this @command{guix publish} instance and " "to automatically download substitutes from it." msgstr "" #. type: item #: doc/guix.texi:18588 #, no-wrap msgid "@code{compression} (default: @code{'((\"gzip\" 3) (\"zstd\" 3))})" msgstr "" #. type: table #: doc/guix.texi:18592 msgid "" "This is a list of compression method/level tuple used when compressing " "substitutes. For example, to compress all substitutes with @emph{both} lzip " "at level 7 and gzip at level 9, write:" msgstr "" #. type: lisp #: doc/guix.texi:18595 #, no-wrap msgid "'((\"lzip\" 7) (\"gzip\" 9))\n" msgstr "" #. type: table #: doc/guix.texi:18601 msgid "" "Level 9 achieves the best compression ratio at the expense of increased CPU " "usage, whereas level 1 achieves fast compression. @xref{Invoking guix " "publish}, for more information on the available compression methods and the " "tradeoffs involved." msgstr "" #. type: table #: doc/guix.texi:18603 msgid "An empty list disables compression altogether." msgstr "" #. type: item #: doc/guix.texi:18604 #, no-wrap msgid "@code{nar-path} (default: @code{\"nar\"})" msgstr "" #. type: table #: doc/guix.texi:18607 msgid "" "The URL path at which ``nars'' can be fetched. @xref{Invoking guix publish, " "@option{--nar-path}}, for details." msgstr "" #. type: item #: doc/guix.texi:18608 #, no-wrap msgid "@code{cache} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:18614 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:18615 #, no-wrap msgid "@code{workers} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:18619 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:18620 #, no-wrap msgid "@code{cache-bypass-threshold} (default: 10 MiB)" msgstr "" #. type: table #: doc/guix.texi:18625 msgid "" "When @code{cache} is true, this is the maximum size in bytes of a store item " "for which @command{guix publish} may bypass its cache in case of a cache " "miss. @xref{Invoking guix publish, @option{--cache-bypass-threshold}}, for " "more information." msgstr "" #. type: item #: doc/guix.texi:18626 doc/guix.texi:36432 #, no-wrap msgid "@code{ttl} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:18630 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: item #: doc/guix.texi:18631 doc/guix.texi:36440 #, no-wrap msgid "@code{negative-ttl} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:18635 msgid "" "When it is an integer, this denotes the @dfn{time-to-live} in seconds for " "the negative lookups. @xref{Invoking guix publish, @option{--negative-" "ttl}}, for more information." msgstr "" #. type: anchor{#1} #: doc/guix.texi:18639 msgid "rngd-service" msgstr "" #. type: deffn #: doc/guix.texi:18639 #, no-wrap msgid "{Scheme Procedure} rngd-service [#:rng-tools @var{rng-tools}] @" msgstr "" #. type: deffn #: doc/guix.texi:18644 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:18647 msgid "pam-limits-service" msgstr "" #. type: cindex #: doc/guix.texi:18647 #, no-wrap msgid "session limits" msgstr "" #. type: cindex #: doc/guix.texi:18648 #, no-wrap msgid "ulimit" msgstr "" #. type: cindex #: doc/guix.texi:18649 #, no-wrap msgid "priority" msgstr "" #. type: cindex #: doc/guix.texi:18650 #, no-wrap msgid "realtime" msgstr "" #. type: cindex #: doc/guix.texi:18651 #, no-wrap msgid "jackd" msgstr "" #. type: cindex #: doc/guix.texi:18652 #, no-wrap msgid "nofile" msgstr "" #. type: cindex #: doc/guix.texi:18653 #, no-wrap msgid "open file descriptors" msgstr "" #. type: deffn #: doc/guix.texi:18654 #, no-wrap msgid "{Scheme Procedure} pam-limits-service [#:limits @code{'()}]" msgstr "" #. type: deffn #: doc/guix.texi:18661 msgid "" "Return a service that installs a configuration file for the @uref{http://" "linux-pam.org/Linux-PAM-html/sag-pam_limits.html, @code{pam_limits} " "module}. The procedure optionally takes a list of @code{pam-limits-entry} " "values, which can be used to specify @code{ulimit} limits and @code{nice} " "priority limits to user sessions." msgstr "" #. type: deffn #: doc/guix.texi:18664 msgid "" "The following limits definition sets two hard and soft limits for all login " "sessions of users in the @code{realtime} group:" msgstr "" #. type: lisp #: doc/guix.texi:18670 #, 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:18676 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: deffn #: doc/guix.texi:18679 msgid "" "Another useful example is raising the maximum number of open file " "descriptors that can be used:" msgstr "" #. type: lisp #: doc/guix.texi:18684 #, no-wrap msgid "" "(pam-limits-service\n" " (list\n" " (pam-limits-entry \"*\" 'both 'nofile 100000)))\n" msgstr "" #. type: deffn #: doc/guix.texi:18692 msgid "" "In the above example, the asterisk means the limit should apply to any " "user. It is important to ensure the chosen value doesn't exceed the maximum " "system value visible in the @file{/proc/sys/fs/file-max} file, else the " "users would be prevented from login in. For more information about the " "Pluggable Authentication Module (PAM) limits, refer to the @samp{pam_limits} " "man page from the @code{linux-pam} package." msgstr "" #. type: defvr #: doc/guix.texi:18694 #, no-wrap msgid "{Scheme Variable} greetd-service-type" msgstr "" #. type: defvr #: doc/guix.texi:18698 msgid "" "@uref{https://git.sr.ht/~kennylevinsen/greetd, @code{greetd}} is a minimal " "and flexible login manager daemon, that makes no assumptions about what you " "want to launch." msgstr "" #. type: defvr #: doc/guix.texi:18702 msgid "" "If you can run it from your shell in a TTY, greetd can start it. If it can " "be taught to speak a simple JSON-based IPC protocol, then it can be a geeter." msgstr "" #. type: defvr #: doc/guix.texi:18705 msgid "" "@code{greetd-service-type} provides necessary infrastructure for logging in " "users, including:" msgstr "" #. type: itemize #: doc/guix.texi:18709 msgid "@code{greetd} PAM service" msgstr "" #. type: itemize #: doc/guix.texi:18712 msgid "Special variation of @code{pam-mount} to mount @code{XDG_RUNTIME_DIR}" msgstr "" #. type: defvr #: doc/guix.texi:18716 msgid "" "Here is example of switching from @code{mingetty-service-type} to " "@code{greetd-service-type}, and how different terminals could be:" msgstr "" #. type: lisp #: doc/guix.texi:18754 #, no-wrap msgid "" " (append\n" " (modify-services %base-services\n" " ;; greetd-service-type provides \"greetd\" PAM service\n" " (delete login-service-type)\n" " ;; and can be used in place of mingetty-service-type\n" " (delete mingetty-service-type))\n" " (list\n" " (service greetd-service-type\n" " (greetd-configuration\n" " (terminals\n" " (list\n" " ;; we can make any terminal active by default\n" " (greetd-terminal-configuration (terminal-vt \"1\") (terminal-switch #t))\n" " ;; we can make environment without XDG_RUNTIME_DIR set\n" " ;; even provide our own environment variables\n" " (greetd-terminal-configuration\n" " (terminal-vt \"2\")\n" " (default-session-command\n" " (greetd-agreety-session\n" " (extra-env '((\"MY_VAR\" . \"1\")))\n" " (xdg-env? #f))))\n" " ;; we can use different shell instead of default bash\n" " (greetd-terminal-configuration\n" " (terminal-vt \"3\")\n" " (default-session-command\n" " (greetd-agreety-session (command (file-append zsh \"/bin/zsh\")))))\n" " ;; we can use any other executable command as greeter\n" " (greetd-terminal-configuration\n" " (terminal-vt \"4\")\n" " (default-session-command (program-file \"my-noop-greeter\" #~(exit))))\n" " (greetd-terminal-configuration (terminal-vt \"5\"))\n" " (greetd-terminal-configuration (terminal-vt \"6\"))))))\n" " ;; mingetty-service-type can be used in parallel\n" " ;; if needed to do so, do not (delete login-service-type)\n" " ;; as illustrated above\n" " #| (service mingetty-service-type (mingetty-configuration (tty \"tty8\"))) |#))\n" msgstr "" #. type: deftp #: doc/guix.texi:18757 #, no-wrap msgid "{Data Type} greetd-configuration" msgstr "" #. type: deftp #: doc/guix.texi:18759 msgid "Configuration record for the @code{greetd-service-type}." msgstr "" #. type: item #: doc/guix.texi:18768 #, no-wrap msgid "@code{terminals} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:18771 msgid "" "List of @code{greetd-terminal-configuration} per terminal for which " "@code{greetd} should be started." msgstr "" #. type: item #: doc/guix.texi:18772 #, no-wrap msgid "@code{greeter-supplementary-groups} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:18774 msgid "" "List of groups which should be added to @code{greeter} user. For instance:" msgstr "" #. type: lisp #: doc/guix.texi:18776 #, no-wrap msgid "(greeter-supplementary-groups '(\"seat\" \"video\"))\n" msgstr "" #. type: table #: doc/guix.texi:18778 msgid "Note that this example will fail if @code{seat} group does not exist." msgstr "" #. type: deftp #: doc/guix.texi:18781 #, no-wrap msgid "{Data Type} greetd-terminal-configuration" msgstr "" #. type: deftp #: doc/guix.texi:18783 msgid "Configuration record for per terminal greetd daemon service." msgstr "" #. type: item #: doc/guix.texi:18785 #, no-wrap msgid "@code{greetd} (default: @code{greetd})" msgstr "" #. type: table #: doc/guix.texi:18787 msgid "The greetd package to use." msgstr "" #. type: code{#1} #: doc/guix.texi:18788 #, no-wrap msgid "config-file-name" msgstr "" #. type: table #: doc/guix.texi:18791 msgid "" "Configuration file name to use for greetd daemon. Generally, autogenerated " "derivation based on @code{terminal-vt} value." msgstr "" #. type: code{#1} #: doc/guix.texi:18792 #, no-wrap msgid "log-file-name" msgstr "" #. type: table #: doc/guix.texi:18795 msgid "" "Log file name to use for greetd daemon. Generally, autogenerated name based " "on @code{terminal-vt} value." msgstr "" #. type: item #: doc/guix.texi:18796 #, no-wrap msgid "@code{terminal-vt} (default: @samp{\"7\"})" msgstr "" #. type: table #: doc/guix.texi:18799 msgid "" "The VT to run on. Use of a specific VT with appropriate conflict avoidance " "is recommended." msgstr "" #. type: item #: doc/guix.texi:18800 #, no-wrap msgid "@code{terminal-switch} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:18802 msgid "Make this terminal active on start of @code{greetd}." msgstr "" #. type: item #: doc/guix.texi:18803 #, no-wrap msgid "@code{default-session-user} (default: @samp{\"greeter\"})" msgstr "" #. type: table #: doc/guix.texi:18805 msgid "The user to use for running the greeter." msgstr "" #. type: item #: doc/guix.texi:18806 #, no-wrap msgid "@code{default-session-command} (default: @code{(greetd-agreety-session)})" msgstr "" #. type: table #: doc/guix.texi:18809 msgid "" "Can be either instance of @code{greetd-agreety-session} configuration or " "@code{gexp->script} like object to use as greeter." msgstr "" #. type: deftp #: doc/guix.texi:18813 #, no-wrap msgid "{Data Type} greetd-agreety-session" msgstr "" #. type: deftp #: doc/guix.texi:18815 msgid "Configuration record for the agreety greetd greeter." msgstr "" #. type: item #: doc/guix.texi:18817 #, no-wrap msgid "@code{agreety} (default: @code{greetd})" msgstr "" #. type: table #: doc/guix.texi:18819 msgid "The package with @command{/bin/agreety} command." msgstr "" #. type: item #: doc/guix.texi:18820 #, no-wrap msgid "@code{command} (default: @code{(file-append bash \"/bin/bash\")})" msgstr "" #. type: table #: doc/guix.texi:18822 msgid "Command to be started by @command{/bin/agreety} on successful login." msgstr "" #. type: item #: doc/guix.texi:18823 #, no-wrap msgid "@code{command-args} (default: @code{'(\"-l\")})" msgstr "" #. type: table #: doc/guix.texi:18825 doc/guix.texi:18849 msgid "Command arguments to pass to command." msgstr "" #. type: item #: doc/guix.texi:18826 doc/guix.texi:18871 #, no-wrap msgid "@code{extra-env} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:18828 doc/guix.texi:18873 msgid "Extra environment variables to set on login." msgstr "" #. type: item #: doc/guix.texi:18829 #, no-wrap msgid "@code{xdg-env?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:18833 msgid "" "If true @code{XDG_RUNTIME_DIR} and @code{XDG_SESSION_TYPE} will be set " "before starting command. One should note that, @code{extra-env} variables " "are set right after mentioned variables, so that they can be overriden." msgstr "" #. type: deftp #: doc/guix.texi:18837 #, no-wrap msgid "{Data Type} greetd-wlgreet-session" msgstr "" #. type: deftp #: doc/guix.texi:18839 msgid "Generic configuration record for the wlgreet greetd greeter." msgstr "" #. type: item #: doc/guix.texi:18841 #, no-wrap msgid "@code{wlgreet} (default: @code{wlgreet})" msgstr "" #. type: table #: doc/guix.texi:18843 msgid "The package with the @command{/bin/wlgreet} command." msgstr "" #. type: item #: doc/guix.texi:18844 #, no-wrap msgid "@code{command} (default: @code{(file-append sway \"/bin/sway\")})" msgstr "" #. type: table #: doc/guix.texi:18846 msgid "Command to be started by @command{/bin/wlgreet} on successful login." msgstr "" #. type: item #: doc/guix.texi:18847 #, no-wrap msgid "@code{command-args} (default: @code{'()})" msgstr "" #. type: item #: doc/guix.texi:18850 #, no-wrap msgid "@code{output-mode} (default: @code{\"all\"})" msgstr "" #. type: table #: doc/guix.texi:18852 msgid "Option to use for @code{outputMode} in the TOML configuration file." msgstr "" #. type: item #: doc/guix.texi:18853 #, no-wrap msgid "@code{scale} (default: @code{1})" msgstr "" #. type: table #: doc/guix.texi:18855 msgid "Option to use for @code{scale} in the TOML configuration file." msgstr "" #. type: item #: doc/guix.texi:18856 #, no-wrap msgid "@code{background} (default: @code{'(0 0 0 0.9)})" msgstr "" #. type: table #: doc/guix.texi:18858 msgid "RGBA list to use as the background colour of the login prompt." msgstr "" #. type: item #: doc/guix.texi:18859 #, no-wrap msgid "@code{headline} (default: @code{'(1 1 1 1)})" msgstr "" #. type: table #: doc/guix.texi:18861 msgid "RGBA list to use as the headline colour of the UI popup." msgstr "" #. type: item #: doc/guix.texi:18862 #, no-wrap msgid "@code{prompt} (default: @code{'(1 1 1 1)})" msgstr "" #. type: table #: doc/guix.texi:18864 msgid "RGBA list to use as the prompt colour of the UI popup." msgstr "" #. type: item #: doc/guix.texi:18865 #, no-wrap msgid "@code{prompt-error} (default: @code{'(1 1 1 1)})" msgstr "" #. type: table #: doc/guix.texi:18867 msgid "RGBA list to use as the error colour of the UI popup." msgstr "" #. type: item #: doc/guix.texi:18868 #, no-wrap msgid "@code{border} (default: @code{'(1 1 1 1)})" msgstr "" #. type: table #: doc/guix.texi:18870 msgid "RGBA list to use as the border colour of the UI popup." msgstr "" #. type: deftp #: doc/guix.texi:18877 #, no-wrap msgid "{Data Type} greetd-wlgreet-sway-session" msgstr "" #. type: deftp #: doc/guix.texi:18879 msgid "Sway-specific configuration record for the wlgreet greetd greeter." msgstr "" #. type: item #: doc/guix.texi:18881 #, no-wrap msgid "@code{wlgreet-session} (default: @code{(greetd-wlgreet-session)})" msgstr "" #. type: table #: doc/guix.texi:18884 msgid "" "A @code{greetd-wlgreet-session} record for generic wlgreet configuration, on " "top of the Sway-specific @code{greetd-wlgreet-sway-session}." msgstr "" #. type: item #: doc/guix.texi:18885 #, no-wrap msgid "@code{sway} (default: @code{sway})" msgstr "" #. type: table #: doc/guix.texi:18887 msgid "The package providing the @command{/bin/sway} command." msgstr "" #. type: item #: doc/guix.texi:18888 #, no-wrap msgid "@code{sway-configuration} (default: #f)" msgstr "" #. type: table #: doc/guix.texi:18891 msgid "" "File-like object providing an additional Sway configuration file to be " "prepended to the mandatory part of the configuration." msgstr "" #. type: deftp #: doc/guix.texi:18895 msgid "" "Here is an example of a greetd configuration that uses wlgreet and Sway:" msgstr "" #. type: lisp #: doc/guix.texi:18909 #, no-wrap msgid "" " (greetd-configuration\n" " ;; We need to give the greeter user these permissions, otherwise\n" " ;; Sway will crash on launch.\n" " (greeter-supplementary-groups (list \"video\" \"input\" \"seat\"))\n" " (terminals\n" " (list (greetd-terminal-configuration\n" " (terminal-vt \"1\")\n" " (terminal-switch #t)\n" " (default-session-command\n" " (greetd-wlgreet-sway-session\n" " (sway-configuration\n" " (local-file \"sway-greetd.conf\"))))))))\n" msgstr "" #. type: cindex #: doc/guix.texi:18915 doc/guix.texi:41121 #, no-wrap msgid "cron" msgstr "" #. type: cindex #: doc/guix.texi:18916 doc/guix.texi:41122 #, no-wrap msgid "mcron" msgstr "" #. type: cindex #: doc/guix.texi:18917 doc/guix.texi:41123 #, no-wrap msgid "scheduling jobs" msgstr "" #. type: Plain text #: doc/guix.texi:18924 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:18932 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:18936 #, no-wrap msgid "" "(use-modules (guix) (gnu) (gnu services mcron))\n" "(use-package-modules base idutils)\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:18946 #, 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" " \"updatedb\"))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:18952 #, 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:18959 #, 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:18962 #, no-wrap msgid "" "(operating-system\n" " ;; @dots{}\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:18972 #, no-wrap msgid "" " ;; %BASE-SERVICES already includes an instance of\n" " ;; 'mcron-service-type', which we extend with additional\n" " ;; jobs using 'simple-service'.\n" " (services (cons (simple-service 'my-cron-jobs\n" " mcron-service-type\n" " (list garbage-collector-job\n" " updatedb-job\n" " idutils-job))\n" " %base-services)))\n" msgstr "" #. type: quotation #: doc/guix.texi:18974 doc/guix.texi:31811 doc/contributing.texi:1439 #, no-wrap msgid "Tip" msgstr "" #. type: quotation #: doc/guix.texi:18980 msgid "" "When providing the action of a job specification as a procedure, you should " "provide an explicit name for the job via the optional 3rd argument as done " "in the @code{updatedb-job} example above. Otherwise, the job would appear " "as ``Lambda function'' in the output of @command{herd schedule mcron}, which " "is not nearly descriptive enough!" msgstr "" #. type: Plain text #: doc/guix.texi:18987 msgid "" "For more complex jobs defined in Scheme where you need control over the top " "level, for instance to introduce a @code{use-modules} form, you can move " "your code to a separate program using the @code{program-file} procedure of " "the @code{(guix gexp)} module (@pxref{G-Expressions}). The example below " "illustrates that." msgstr "" #. type: lisp #: doc/guix.texi:19003 #, no-wrap msgid "" "(define %battery-alert-job\n" " ;; Beep when the battery percentage falls below %MIN-LEVEL.\n" " #~(job\n" " '(next-minute (range 0 60 1))\n" " #$(program-file\n" " \"battery-alert.scm\"\n" " (with-imported-modules (source-module-closure\n" " '((guix build utils)))\n" " #~(begin\n" " (use-modules (guix build utils)\n" " (ice-9 popen)\n" " (ice-9 regex)\n" " (ice-9 textual-ports)\n" " (srfi srfi-2))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:19005 #, no-wrap msgid "" " (define %min-level 20)\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:19016 #, no-wrap msgid "" " (setenv \"LC_ALL\" \"C\") ;ensure English output\n" " (and-let* ((input-pipe (open-pipe*\n" " OPEN_READ\n" " #$(file-append acpi \"/bin/acpi\")))\n" " (output (get-string-all input-pipe))\n" " (m (string-match \"Discharging, ([0-9]+)%\" output))\n" " (level (string->number (match:substring m 1)))\n" " ((< level %min-level)))\n" " (format #t \"warning: Battery level is low (~a%)~%\" level)\n" " (invoke #$(file-append beep \"/bin/beep\") \"-r5\")))))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:19021 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: Plain text #: doc/guix.texi:19024 msgid "" "On a running system, you can use the @code{schedule} action of the service " "to visualize the mcron jobs that will be executed next:" msgstr "" #. type: example #: doc/guix.texi:19027 #, no-wrap msgid "# herd schedule mcron\n" msgstr "" #. type: Plain text #: doc/guix.texi:19032 msgid "" "The example above lists the next five tasks that will be executed, but you " "can also specify the number of tasks to display:" msgstr "" #. type: example #: doc/guix.texi:19035 #, no-wrap msgid "# herd schedule mcron 10\n" msgstr "" #. type: defvr #: doc/guix.texi:19037 #, no-wrap msgid "{Scheme Variable} mcron-service-type" msgstr "" #. type: defvr #: doc/guix.texi:19040 msgid "" "This is the type of the @code{mcron} service, whose value is an @code{mcron-" "configuration} object." msgstr "" #. type: defvr #: doc/guix.texi:19045 doc/guix.texi:41142 msgid "" "This service type can be the target of a service extension that provides " "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:19050 #, no-wrap msgid "{Data Type} mcron-configuration" msgstr "" #. type: deftp #: doc/guix.texi:19052 msgid "Available @code{mcron-configuration} fields are:" msgstr "" #. type: item #: doc/guix.texi:19054 doc/guix.texi:41151 #, no-wrap msgid "@code{mcron} (default: @code{mcron}) (type: file-like)" msgstr "" #. type: table #: doc/guix.texi:19056 doc/guix.texi:41153 msgid "The mcron package to use." msgstr "" #. type: item #: doc/guix.texi:19057 doc/guix.texi:41154 #, no-wrap msgid "@code{jobs} (default: @code{()}) (type: list-of-gexps)" msgstr "" #. type: table #: doc/guix.texi:19061 doc/guix.texi:41158 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: item #: doc/guix.texi:19062 doc/guix.texi:41159 #, no-wrap msgid "@code{log?} (default: @code{#t}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:19064 doc/guix.texi:41161 msgid "Log messages to standard output." msgstr "" #. type: item #: doc/guix.texi:19065 doc/guix.texi:41162 #, no-wrap msgid "@code{log-format} (default: @code{\"~1@@*~a ~a: ~a~%\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:19070 doc/guix.texi:41167 msgid "" "@code{(ice-9 format)} format string for log messages. The default value " "produces messages like \"@samp{@var{pid} @var{name}: @var{message}\"} " "(@pxref{Invoking mcron, Invoking,, mcron,GNU@tie{}mcron}). Each message is " "also prefixed by a timestamp by GNU Shepherd." msgstr "" #. type: cindex #: doc/guix.texi:19078 #, no-wrap msgid "rottlog" msgstr "" #. type: cindex #: doc/guix.texi:19079 #, no-wrap msgid "log rotation" msgstr "" #. type: Plain text #: doc/guix.texi:19086 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:19092 msgid "" "This service is part of @code{%base-services}, and thus enabled by default, " "with the default settings, for commonly encountered log files. The example " "below shows how to extend it with an additional @dfn{rotation}, should you " "need to do that (usually, services that produce log files already take care " "of that):" msgstr "" #. type: lisp #: doc/guix.texi:19096 #, no-wrap msgid "" "(use-modules (guix) (gnu))\n" "(use-service-modules admin)\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:19100 #, no-wrap msgid "" "(define my-log-files\n" " ;; Log files that I want to rotate.\n" " '(\"/var/log/something.log\" \"/var/log/another.log\"))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:19109 #, no-wrap msgid "" "(operating-system\n" " ;; @dots{}\n" " (services (cons (simple-service 'rotate-my-stuff\n" " rottlog-service-type\n" " (list (log-rotation\n" " (frequency 'daily)\n" " (files my-log-files))))\n" " %base-services)))\n" msgstr "" #. type: defvr #: doc/guix.texi:19111 #, no-wrap msgid "{Scheme Variable} rottlog-service-type" msgstr "" #. type: defvr #: doc/guix.texi:19114 msgid "" "This is the type of the Rottlog service, whose value is a @code{rottlog-" "configuration} object." msgstr "" #. type: defvr #: doc/guix.texi:19117 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:19120 msgid "" "This service type can define mcron jobs (@pxref{Scheduled Job Execution}) to " "run the rottlog service." msgstr "" #. type: deftp #: doc/guix.texi:19122 #, no-wrap msgid "{Data Type} rottlog-configuration" msgstr "" #. type: deftp #: doc/guix.texi:19124 msgid "Data type representing the configuration of rottlog." msgstr "" #. type: item #: doc/guix.texi:19126 #, no-wrap msgid "@code{rottlog} (default: @code{rottlog})" msgstr "" #. type: table #: doc/guix.texi:19128 msgid "The Rottlog package to use." msgstr "" #. type: item #: doc/guix.texi:19129 #, no-wrap msgid "@code{rc-file} (default: @code{(file-append rottlog \"/etc/rc\")})" msgstr "" #. type: table #: doc/guix.texi:19132 msgid "" "The Rottlog configuration file to use (@pxref{Mandatory RC Variables,,, " "rottlog, GNU Rot[t]log Manual})." msgstr "" #. type: item #: doc/guix.texi:19133 #, no-wrap msgid "@code{rotations} (default: @code{%default-rotations})" msgstr "" #. type: table #: doc/guix.texi:19135 msgid "A list of @code{log-rotation} objects as defined below." msgstr "" #. type: code{#1} #: doc/guix.texi:19136 #, no-wrap msgid "jobs" msgstr "" #. type: table #: doc/guix.texi:19139 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:19142 #, no-wrap msgid "{Data Type} log-rotation" msgstr "" #. type: deftp #: doc/guix.texi:19144 msgid "Data type representing the rotation of a group of log files." msgstr "" #. type: deftp #: doc/guix.texi:19148 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: lisp #: doc/guix.texi:19157 #, 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:19160 msgid "The list of fields is as follows:" msgstr "" #. type: item #: doc/guix.texi:19162 #, no-wrap msgid "@code{frequency} (default: @code{'weekly})" msgstr "" #. type: table #: doc/guix.texi:19164 msgid "The log rotation frequency, a symbol." msgstr "" #. type: table #: doc/guix.texi:19167 msgid "The list of files or file glob patterns to rotate." msgstr "" #. type: vindex #: doc/guix.texi:19168 #, no-wrap msgid "%default-log-rotation-options" msgstr "" #. type: item #: doc/guix.texi:19169 #, no-wrap msgid "@code{options} (default: @code{%default-log-rotation-options})" msgstr "" #. type: table #: doc/guix.texi:19172 msgid "" "The list of rottlog options for this rotation (@pxref{Configuration " "parameters,,, rottlog, GNU Rot[t]log Manual})." msgstr "" #. type: item #: doc/guix.texi:19173 #, no-wrap msgid "@code{post-rotate} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:19175 msgid "Either @code{#f} or a gexp to execute once the rotation has completed." msgstr "" #. type: defvr #: doc/guix.texi:19178 #, no-wrap msgid "{Scheme Variable} %default-rotations" msgstr "" #. type: defvr #: doc/guix.texi:19181 msgid "" "Specifies weekly rotation of @code{%rotated-files} and of @file{/var/log/" "guix-daemon.log}." msgstr "" #. type: defvr #: doc/guix.texi:19183 #, no-wrap msgid "{Scheme Variable} %rotated-files" msgstr "" #. type: defvr #: doc/guix.texi:19187 msgid "" "The list of syslog-controlled files to be rotated. By default it is: " "@code{'(\"/var/log/messages\" \"/var/log/secure\" \"/var/log/debug\" \\ \"/" "var/log/maillog\")}." msgstr "" #. type: Plain text #: doc/guix.texi:19195 msgid "" "Some log files just need to be deleted periodically once they are old, " "without any other criterion and without any archival step. This is the case " "of build logs stored by @command{guix-daemon} under @file{/var/log/guix/" "drvs} (@pxref{Invoking guix-daemon}). The @code{log-cleanup} service " "addresses this use case. For example, @code{%base-services} (@pxref{Base " "Services}) includes the following:" msgstr "" #. type: lisp #: doc/guix.texi:19201 #, no-wrap msgid "" ";; Periodically delete old build logs.\n" "(service log-cleanup-service-type\n" " (log-cleanup-configuration\n" " (directory \"/var/log/guix/drvs\")))\n" msgstr "" #. type: Plain text #: doc/guix.texi:19204 msgid "That ensures build logs do not accumulate endlessly." msgstr "" #. type: defvr #: doc/guix.texi:19205 #, no-wrap msgid "{Scheme Variable} log-cleanup-service-type" msgstr "" #. type: defvr #: doc/guix.texi:19208 msgid "" "This is the type of the service to delete old logs. Its value must be a " "@code{log-cleanup-configuration} record as described below." msgstr "" #. type: deftp #: doc/guix.texi:19210 #, no-wrap msgid "{Data Type} log-cleanup-configuration" msgstr "" #. type: deftp #: doc/guix.texi:19212 msgid "Data type representing the log cleanup configuration" msgstr "" #. type: code{#1} #: doc/guix.texi:19214 #, no-wrap msgid "directory" msgstr "" #. type: table #: doc/guix.texi:19216 msgid "Name of the directory containing log files." msgstr "" #. type: item #: doc/guix.texi:19217 #, no-wrap msgid "@code{expiry} (default: @code{(* 6 30 24 3600)})" msgstr "" #. type: table #: doc/guix.texi:19220 msgid "" "Age in seconds after which a file is subject to deletion (six months by " "default)." msgstr "" #. type: item #: doc/guix.texi:19221 #, no-wrap msgid "@code{schedule} (default: @code{\"30 12 01,08,15,22 * *\"})" msgstr "" #. type: table #: doc/guix.texi:19224 msgid "" "String or gexp denoting the corresponding mcron job schedule " "(@pxref{Scheduled Job Execution})." msgstr "" #. type: cindex #: doc/guix.texi:19227 #, no-wrap msgid "logging, anonymization" msgstr "" #. type: subheading #: doc/guix.texi:19228 #, no-wrap msgid "Anonip Service" msgstr "" #. type: Plain text #: doc/guix.texi:19233 msgid "" "Anonip is a privacy filter that removes IP address from web server logs. " "This service creates a FIFO and filters any written lines with anonip before " "writing the filtered log to a target file." msgstr "" #. type: Plain text #: doc/guix.texi:19237 msgid "" "The following example sets up the FIFO @file{/var/run/anonip/https.access." "log} and writes the filtered log file @file{/var/log/anonip/https.access." "log}." msgstr "" #. type: lisp #: doc/guix.texi:19243 #, no-wrap msgid "" "(service anonip-service-type\n" " (anonip-configuration\n" " (input \"/var/run/anonip/https.access.log\")\n" " (output \"/var/log/anonip/https.access.log\")))\n" msgstr "" #. type: Plain text #: doc/guix.texi:19248 msgid "" "Configure your web server to write its logs to the FIFO at @file{/var/run/" "anonip/https.access.log} and collect the anonymized log file at @file{/var/" "web-logs/https.access.log}." msgstr "" #. type: deftp #: doc/guix.texi:19249 #, no-wrap msgid "{Data Type} anonip-configuration" msgstr "" #. type: deftp #: doc/guix.texi:19252 msgid "" "This data type represents the configuration of anonip. It has the following " "parameters:" msgstr "" #. type: item #: doc/guix.texi:19254 #, no-wrap msgid "@code{anonip} (default: @code{anonip})" msgstr "" #. type: table #: doc/guix.texi:19256 msgid "The anonip package to use." msgstr "" #. type: code{#1} #: doc/guix.texi:19257 #, no-wrap msgid "input" msgstr "" #. type: table #: doc/guix.texi:19260 msgid "" "The file name of the input log file to process. The service creates a FIFO " "of this name. The web server should write its logs to this FIFO." msgstr "" #. type: code{#1} #: doc/guix.texi:19261 #, no-wrap msgid "output" msgstr "" #. type: table #: doc/guix.texi:19263 msgid "The file name of the processed log file." msgstr "" #. type: deftp #: doc/guix.texi:19266 msgid "The following optional settings may be provided:" msgstr "" #. type: code{#1} #: doc/guix.texi:19268 #, no-wrap msgid "skip-private?" msgstr "" #. type: table #: doc/guix.texi:19270 msgid "When @code{#true} do not mask addresses in private ranges." msgstr "" #. type: code{#1} #: doc/guix.texi:19271 #, no-wrap msgid "column" msgstr "" #. type: table #: doc/guix.texi:19274 msgid "" "A 1-based indexed column number. Assume IP address is in the specified " "column (default is 1)." msgstr "" #. type: code{#1} #: doc/guix.texi:19275 #, no-wrap msgid "replacement" msgstr "" #. type: table #: doc/guix.texi:19277 msgid "" "Replacement string in case address parsing fails, e.g. @code{\"0.0.0.0\"}." msgstr "" #. type: code{#1} #: doc/guix.texi:19278 #, no-wrap msgid "ipv4mask" msgstr "" #. type: table #: doc/guix.texi:19280 msgid "Number of bits to mask in IPv4 addresses." msgstr "" #. type: code{#1} #: doc/guix.texi:19281 #, no-wrap msgid "ipv6mask" msgstr "" #. type: table #: doc/guix.texi:19283 msgid "Number of bits to mask in IPv6 addresses." msgstr "" #. type: code{#1} #: doc/guix.texi:19284 #, no-wrap msgid "increment" msgstr "" #. type: table #: doc/guix.texi:19286 msgid "Increment the IP address by the given number. By default this is zero." msgstr "" #. type: code{#1} #: doc/guix.texi:19287 #, no-wrap msgid "delimiter" msgstr "" #. type: table #: doc/guix.texi:19289 msgid "Log delimiter string." msgstr "" #. type: code{#1} #: doc/guix.texi:19290 #, no-wrap msgid "regex" msgstr "" #. type: table #: doc/guix.texi:19292 msgid "" "Regular expression for detecting IP addresses. Use this instead of " "@code{column}." msgstr "" #. type: Plain text #: doc/guix.texi:19307 msgid "" "The @code{(gnu services networking)} module provides services to configure " "network interfaces and set up networking on your machine. Those services " "provide different ways for you to set up your machine: by declaring a static " "network configuration, by running a Dynamic Host Configuration Protocol " "(DHCP) client, or by running daemons such as NetworkManager and Connman that " "automate the whole process, automatically adapt to connectivity changes, and " "provide a high-level user interface." msgstr "" #. type: Plain text #: doc/guix.texi:19313 msgid "" "On a laptop, NetworkManager and Connman are by far the most convenient " "options, which is why the default desktop services include NetworkManager " "(@pxref{Desktop Services, @code{%desktop-services}}). For a server, or for " "a virtual machine or a container, static network configuration or a simple " "DHCP client are often more appropriate." msgstr "" #. type: Plain text #: doc/guix.texi:19316 msgid "" "This section describes the various network setup services available, " "starting with static network configuration." msgstr "" #. type: defvr #: doc/guix.texi:19317 #, no-wrap msgid "{Scheme Variable} static-networking-service-type" msgstr "" #. type: defvr #: doc/guix.texi:19322 msgid "" "This is the type for statically-configured network interfaces. Its value " "must be a list of @code{static-networking} records. Each of them declares a " "set of @dfn{addresses}, @dfn{routes}, and @dfn{links}, as shown below." msgstr "" #. type: cindex #: doc/guix.texi:19323 #, no-wrap msgid "network interface controller (NIC)" msgstr "" #. type: cindex #: doc/guix.texi:19324 #, no-wrap msgid "NIC, networking interface controller" msgstr "" #. type: defvr #: doc/guix.texi:19327 msgid "" "Here is the simplest configuration, with only one network interface " "controller (NIC) and only IPv4 connectivity:" msgstr "" #. type: lisp #: doc/guix.texi:19341 #, no-wrap msgid "" ";; Static networking for one NIC, IPv4-only.\n" "(service static-networking-service-type\n" " (list (static-networking\n" " (addresses\n" " (list (network-address\n" " (device \"eno1\")\n" " (value \"10.0.2.15/24\"))))\n" " (routes\n" " (list (network-route\n" " (destination \"default\")\n" " (gateway \"10.0.2.2\"))))\n" " (name-servers '(\"10.0.2.3\")))))\n" msgstr "" #. type: defvr #: doc/guix.texi:19350 msgid "" "The snippet above can be added to the @code{services} field of your " "operating system configuration (@pxref{Using the Configuration System}). It " "will configure your machine to have 10.0.2.15 as its IP address, with a 24-" "bit netmask for the local network---meaning that any 10.0.2.@var{x} address " "is on the local area network (LAN). Traffic to addresses outside the local " "network is routed @i{via} 10.0.2.2. Host names are resolved by sending " "domain name system (DNS) queries to 10.0.2.3." msgstr "" #. type: deftp #: doc/guix.texi:19352 #, no-wrap msgid "{Data Type} static-networking" msgstr "" #. type: deftp #: doc/guix.texi:19354 msgid "This is the data type representing a static network configuration." msgstr "" #. type: deftp #: doc/guix.texi:19358 msgid "" "As an example, here is how you would declare the configuration of a machine " "with a single network interface controller (NIC) available as @code{eno1}, " "and with one IPv4 and one IPv6 address:" msgstr "" #. type: lisp #: doc/guix.texi:19375 #, no-wrap msgid "" ";; Network configuration for one NIC, IPv4 + IPv6.\n" "(static-networking\n" " (addresses (list (network-address\n" " (device \"eno1\")\n" " (value \"10.0.2.15/24\"))\n" " (network-address\n" " (device \"eno1\")\n" " (value \"2001:123:4567:101::1/64\"))))\n" " (routes (list (network-route\n" " (destination \"default\")\n" " (gateway \"10.0.2.2\"))\n" " (network-route\n" " (destination \"default\")\n" " (gateway \"2020:321:4567:42::1\"))))\n" " (name-servers '(\"10.0.2.3\")))\n" msgstr "" #. type: deftp #: doc/guix.texi:19381 msgid "" "If you are familiar with the @command{ip} command of the @uref{https://wiki." "linuxfoundation.org/networking/iproute2, @code{iproute2} package} found on " "Linux-based systems, the declaration above is equivalent to typing:" msgstr "" #. type: example #: doc/guix.texi:19387 #, no-wrap msgid "" "ip address add 10.0.2.15/24 dev eno1\n" "ip address add 2001:123:4567:101::1/64 dev eno1\n" "ip route add default via inet 10.0.2.2\n" "ip route add default via inet6 2020:321:4567:42::1\n" msgstr "" #. type: deftp #: doc/guix.texi:19392 msgid "" "Run @command{man 8 ip} for more info. Venerable GNU/Linux users will " "certainly know how to do it with @command{ifconfig} and @command{route}, but " "we'll spare you that." msgstr "" #. type: deftp #: doc/guix.texi:19394 msgid "The available fields of this data type are as follows:" msgstr "" #. type: code{#1} #: doc/guix.texi:19396 #, no-wrap msgid "addresses" msgstr "" #. type: itemx #: doc/guix.texi:19397 #, no-wrap msgid "@code{links} (default: @code{'()})" msgstr "" #. type: itemx #: doc/guix.texi:19398 #, no-wrap msgid "@code{routes} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:19401 msgid "" "The list of @code{network-address}, @code{network-link}, and @code{network-" "route} records for this network (see below)." msgstr "" #. type: item #: doc/guix.texi:19402 #, no-wrap msgid "@code{name-servers} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:19405 msgid "" "The list of IP addresses (strings) of domain name servers. These IP " "addresses go to @file{/etc/resolv.conf}." msgstr "" #. type: item #: doc/guix.texi:19406 #, no-wrap msgid "@code{provision} (default: @code{'(networking)})" msgstr "" #. type: table #: doc/guix.texi:19409 msgid "" "If true, this should be a list of symbols for the Shepherd service " "corresponding to this network configuration." msgstr "" #. type: item #: doc/guix.texi:19410 #, no-wrap msgid "@code{requirement} (default @code{'()})" msgstr "" #. type: table #: doc/guix.texi:19412 msgid "The list of Shepherd services depended on." msgstr "" #. type: deftp #: doc/guix.texi:19415 #, no-wrap msgid "{Data Type} network-address" msgstr "" #. type: deftp #: doc/guix.texi:19418 msgid "" "This is the data type representing the IP address of a network interface." msgstr "" #. type: table #: doc/guix.texi:19423 msgid "" "The name of the network interface for this address---e.g., @code{\"eno1\"}." msgstr "" #. type: item #: doc/guix.texi:19424 #, no-wrap msgid "value" msgstr "" #. type: table #: doc/guix.texi:19428 msgid "" "The actual IP address and network mask, in @uref{https://en.wikipedia.org/" "wiki/CIDR#CIDR_notation, @acronym{CIDR, Classless Inter-Domain Routing} " "notation}, as a string." msgstr "" #. type: table #: doc/guix.texi:19432 msgid "" "For example, @code{\"10.0.2.15/24\"} denotes IPv4 address 10.0.2.15 on a 24-" "bit sub-network---all 10.0.2.@var{x} addresses are on the same local network." msgstr "" #. type: item #: doc/guix.texi:19433 #, no-wrap msgid "ipv6?" msgstr "" #. type: table #: doc/guix.texi:19436 msgid "" "Whether @code{value} denotes an IPv6 address. By default this is " "automatically determined." msgstr "" #. type: deftp #: doc/guix.texi:19439 #, no-wrap msgid "{Data Type} network-route" msgstr "" #. type: deftp #: doc/guix.texi:19441 msgid "This is the data type representing a network route." msgstr "" #. type: code{#1} #: doc/guix.texi:19443 #, no-wrap msgid "destination" msgstr "" #. type: table #: doc/guix.texi:19446 msgid "" "The route destination (a string), either an IP address and network mask or " "@code{\"default\"} to denote the default route." msgstr "" #. type: item #: doc/guix.texi:19447 #, no-wrap msgid "@code{source} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:19449 msgid "The route source." msgstr "" #. type: item #: doc/guix.texi:19450 doc/guix.texi:38214 #, no-wrap msgid "@code{device} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:19452 msgid "The device used for this route---e.g., @code{\"eno2\"}." msgstr "" #. type: item #: doc/guix.texi:19453 #, no-wrap msgid "@code{ipv6?} (default: auto)" msgstr "" #. type: table #: doc/guix.texi:19456 msgid "" "Whether this is an IPv6 route. By default this is automatically determined " "based on @code{destination} or @code{gateway}." msgstr "" #. type: item #: doc/guix.texi:19457 #, no-wrap msgid "@code{gateway} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:19459 msgid "IP address (a string) through which traffic is routed." msgstr "" #. type: deftp #: doc/guix.texi:19462 #, no-wrap msgid "{Data Type} network-link" msgstr "" #. type: deftp #: doc/guix.texi:19465 msgid "" "Data type for a network link (@pxref{Link,,, guile-netlink, Guile-Netlink " "Manual})." msgstr "" #. type: table #: doc/guix.texi:19469 msgid "The name of the link---e.g., @code{\"v0p0\"}." msgstr "" #. type: table #: doc/guix.texi:19472 msgid "A symbol denoting the type of the link---e.g., @code{'veth}." msgstr "" #. type: item #: doc/guix.texi:19473 #, no-wrap msgid "arguments" msgstr "" #. type: table #: doc/guix.texi:19475 msgid "List of arguments for this type of link." msgstr "" #. type: cindex #: doc/guix.texi:19478 #, no-wrap msgid "loopback device" msgstr "" #. type: defvr #: doc/guix.texi:19479 #, no-wrap msgid "{Scheme Variable} %loopback-static-networking" msgstr "" #. type: defvr #: doc/guix.texi:19483 msgid "" "This is the @code{static-networking} record representing the ``loopback " "device'', @code{lo}, for IP addresses 127.0.0.1 and ::1, and providing the " "@code{loopback} Shepherd service." msgstr "" #. type: cindex #: doc/guix.texi:19485 #, no-wrap msgid "networking, with QEMU" msgstr "" #. type: cindex #: doc/guix.texi:19486 #, no-wrap msgid "QEMU, networking" msgstr "" #. type: defvr #: doc/guix.texi:19487 #, no-wrap msgid "{Scheme Variable} %qemu-static-networking" msgstr "" #. type: defvr #: doc/guix.texi:19491 msgid "" "This is the @code{static-networking} record representing network setup when " "using QEMU's user-mode network stack on @code{eth0} (@pxref{Using the user " "mode network stack,,, QEMU, QEMU Documentation})." msgstr "" #. type: cindex #: doc/guix.texi:19493 #, no-wrap msgid "DHCP, networking service" msgstr "" #. type: defvr #: doc/guix.texi:19494 #, no-wrap msgid "{Scheme Variable} dhcp-client-service-type" msgstr "" #. type: defvr #: doc/guix.texi:19497 msgid "" "This is the type of services that run @var{dhcp}, a Dynamic Host " "Configuration Protocol (DHCP) client." msgstr "" #. type: deftp #: doc/guix.texi:19499 #, no-wrap msgid "{Data Type} dhcp-client-configuration" msgstr "" #. type: deftp #: doc/guix.texi:19501 msgid "Data type representing the configuration of the DHCP client service." msgstr "" #. type: item #: doc/guix.texi:19503 doc/guix.texi:19741 #, no-wrap msgid "@code{package} (default: @code{isc-dhcp})" msgstr "" #. type: table #: doc/guix.texi:19505 msgid "DHCP client package to use." msgstr "" #. type: item #: doc/guix.texi:19506 #, no-wrap msgid "@code{interfaces} (default: @code{'all})" msgstr "" #. type: table #: doc/guix.texi:19509 msgid "" "Either @code{'all} or the list of interface names that the DHCP client " "should listen on---e.g., @code{'(\"eno1\")}." msgstr "" #. type: table #: doc/guix.texi:19513 msgid "" "When set to @code{'all}, the DHCP client listens on all the available non-" "loopback interfaces that can be activated. Otherwise the DHCP client " "listens only on the specified interfaces." msgstr "" #. type: cindex #: doc/guix.texi:19516 #, no-wrap msgid "NetworkManager" msgstr "" #. type: defvr #: doc/guix.texi:19518 #, no-wrap msgid "{Scheme Variable} network-manager-service-type" msgstr "" #. type: defvr #: doc/guix.texi:19523 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: defvr #: doc/guix.texi:19526 doc/guix.texi:19664 doc/guix.texi:19693 msgid "" "This service is part of @code{%desktop-services} (@pxref{Desktop Services})." msgstr "" #. type: deftp #: doc/guix.texi:19528 #, no-wrap msgid "{Data Type} network-manager-configuration" msgstr "" #. type: deftp #: doc/guix.texi:19530 msgid "Data type representing the configuration of NetworkManager." msgstr "" #. type: item #: doc/guix.texi:19532 #, no-wrap msgid "@code{network-manager} (default: @code{network-manager})" msgstr "" #. type: table #: doc/guix.texi:19534 msgid "The NetworkManager package to use." msgstr "" #. type: item #: doc/guix.texi:19535 #, no-wrap msgid "@code{dns} (default: @code{\"default\"})" msgstr "" #. type: table #: doc/guix.texi:19538 msgid "" "Processing mode for DNS, which affects how NetworkManager uses the " "@code{resolv.conf} configuration file." msgstr "" #. type: table #: doc/guix.texi:19543 msgid "" "NetworkManager will update @code{resolv.conf} to reflect the nameservers " "provided by currently active connections." msgstr "" #. type: item #: doc/guix.texi:19544 #, no-wrap msgid "dnsmasq" msgstr "" #. type: table #: doc/guix.texi:19548 msgid "" "NetworkManager will run @code{dnsmasq} as a local caching nameserver, using " "a @dfn{conditional forwarding} configuration if you are connected to a VPN, " "and then update @code{resolv.conf} to point to the local nameserver." msgstr "" #. type: table #: doc/guix.texi:19554 msgid "" "With this setting, you can share your network connection. For example when " "you want to share your network connection to another laptop @i{via} an " "Ethernet cable, you can open @command{nm-connection-editor} and configure " "the Wired connection's method for IPv4 and IPv6 to be ``Shared to other " "computers'' and reestablish the connection (or reboot)." msgstr "" #. type: table #: doc/guix.texi:19561 msgid "" "You can also set up a @dfn{host-to-guest connection} to QEMU VMs " "(@pxref{Installing Guix in a VM}). With a host-to-guest connection, you can " "e.g.@: access a Web server running on the VM (@pxref{Web Services}) from a " "Web browser on your host system, or connect to the VM @i{via} SSH " "(@pxref{Networking Services, @code{openssh-service-type}}). To set up a " "host-to-guest connection, run this command once:" msgstr "" #. type: example #: doc/guix.texi:19568 #, no-wrap msgid "" "nmcli connection add type tun \\\n" " connection.interface-name tap0 \\\n" " tun.mode tap tun.owner $(id -u) \\\n" " ipv4.method shared \\\n" " ipv4.addresses 172.28.112.1/24\n" msgstr "" #. type: table #: doc/guix.texi:19573 msgid "" "Then each time you launch your QEMU VM (@pxref{Running Guix in a VM}), pass " "@option{-nic tap,ifname=tap0,script=no,downscript=no} to @command{qemu-" "system-...}." msgstr "" #. type: table #: doc/guix.texi:19576 msgid "NetworkManager will not modify @code{resolv.conf}." msgstr "" #. type: item #: doc/guix.texi:19578 #, no-wrap msgid "@code{vpn-plugins} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:19582 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:19586 #, no-wrap msgid "Connman" msgstr "" #. type: deffn #: doc/guix.texi:19587 #, no-wrap msgid "{Scheme Variable} connman-service-type" msgstr "" #. type: deffn #: doc/guix.texi:19590 msgid "" "This is the service type to run @url{https://01.org/connman,Connman}, a " "network connection manager." msgstr "" #. type: deffn #: doc/guix.texi:19593 msgid "" "Its value must be an @code{connman-configuration} record as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:19598 #, no-wrap msgid "" "(service connman-service-type\n" " (connman-configuration\n" " (disable-vpn? #t)))\n" msgstr "" #. type: deffn #: doc/guix.texi:19601 msgid "See below for details about @code{connman-configuration}." msgstr "" #. type: deftp #: doc/guix.texi:19603 #, no-wrap msgid "{Data Type} connman-configuration" msgstr "" #. type: deftp #: doc/guix.texi:19605 msgid "Data Type representing the configuration of connman." msgstr "" #. type: item #: doc/guix.texi:19607 #, no-wrap msgid "@code{connman} (default: @var{connman})" msgstr "" #. type: table #: doc/guix.texi:19609 msgid "The connman package to use." msgstr "" #. type: item #: doc/guix.texi:19610 #, no-wrap msgid "@code{disable-vpn?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:19612 msgid "When true, disable connman's vpn plugin." msgstr "" #. type: cindex #: doc/guix.texi:19615 #, no-wrap msgid "WPA Supplicant" msgstr "" #. type: defvr #: doc/guix.texi:19616 #, no-wrap msgid "{Scheme Variable} wpa-supplicant-service-type" msgstr "" #. type: defvr #: doc/guix.texi:19620 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." msgstr "" #. type: deftp #: doc/guix.texi:19622 #, no-wrap msgid "{Data Type} wpa-supplicant-configuration" msgstr "" #. type: deftp #: doc/guix.texi:19624 msgid "Data type representing the configuration of WPA Supplicant." msgstr "" #. type: deftp #: doc/guix.texi:19626 doc/guix.texi:36004 msgid "It takes the following parameters:" msgstr "" #. type: item #: doc/guix.texi:19628 #, no-wrap msgid "@code{wpa-supplicant} (default: @code{wpa-supplicant})" msgstr "" #. type: table #: doc/guix.texi:19630 msgid "The WPA Supplicant package to use." msgstr "" #. type: item #: doc/guix.texi:19631 #, no-wrap msgid "@code{requirement} (default: @code{'(user-processes loopback syslogd)}" msgstr "" #. type: table #: doc/guix.texi:19633 msgid "List of services that should be started before WPA Supplicant starts." msgstr "" #. type: item #: doc/guix.texi:19634 #, no-wrap msgid "@code{dbus?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:19636 msgid "Whether to listen for requests on D-Bus." msgstr "" #. type: item #: doc/guix.texi:19637 #, no-wrap msgid "@code{pid-file} (default: @code{\"/var/run/wpa_supplicant.pid\"})" msgstr "" #. type: table #: doc/guix.texi:19639 msgid "Where to store the PID file." msgstr "" #. type: item #: doc/guix.texi:19640 doc/guix.texi:34282 doc/guix.texi:34424 #, no-wrap msgid "@code{interface} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:19643 msgid "" "If this is set, it must specify the name of a network interface that WPA " "supplicant will control." msgstr "" #. type: item #: doc/guix.texi:19644 doc/guix.texi:19746 doc/guix.texi:25769 #: doc/guix.texi:31848 #, no-wrap msgid "@code{config-file} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:19646 msgid "Optional configuration file to use." msgstr "" #. type: table #: doc/guix.texi:19649 msgid "List of additional command-line arguments to pass to the daemon." msgstr "" #. type: cindex #: doc/guix.texi:19652 #, no-wrap msgid "ModemManager" msgstr "" #. type: Plain text #: doc/guix.texi:19655 msgid "" "Some networking devices such as modems require special care, and this is " "what the services below focus on." msgstr "" #. type: defvr #: doc/guix.texi:19656 #, no-wrap msgid "{Scheme Variable} modem-manager-service-type" msgstr "" #. type: defvr #: doc/guix.texi:19661 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: deftp #: doc/guix.texi:19666 #, no-wrap msgid "{Data Type} modem-manager-configuration" msgstr "" #. type: deftp #: doc/guix.texi:19668 msgid "Data type representing the configuration of ModemManager." msgstr "" #. type: item #: doc/guix.texi:19670 #, no-wrap msgid "@code{modem-manager} (default: @code{modem-manager})" msgstr "" #. type: table #: doc/guix.texi:19672 msgid "The ModemManager package to use." msgstr "" #. type: cindex #: doc/guix.texi:19676 #, no-wrap msgid "USB_ModeSwitch" msgstr "" #. type: cindex #: doc/guix.texi:19677 #, no-wrap msgid "Modeswitching" msgstr "" #. type: defvr #: doc/guix.texi:19679 #, no-wrap msgid "{Scheme Variable} usb-modeswitch-service-type" msgstr "" #. type: defvr #: doc/guix.texi:19684 msgid "" "This is the service type for the @uref{https://www.draisberghof.de/" "usb_modeswitch/, USB_ModeSwitch} service. The value for this service type " "is a @code{usb-modeswitch-configuration} record." msgstr "" #. type: defvr #: doc/guix.texi:19690 msgid "" "When plugged in, some USB modems (and other USB devices) initially present " "themselves as a read-only storage medium and not as a modem. They need to " "be @dfn{modeswitched} before they are usable. The USB_ModeSwitch service " "type installs udev rules to automatically modeswitch these devices when they " "are plugged in." msgstr "" #. type: deftp #: doc/guix.texi:19695 #, no-wrap msgid "{Data Type} usb-modeswitch-configuration" msgstr "" #. type: deftp #: doc/guix.texi:19697 msgid "Data type representing the configuration of USB_ModeSwitch." msgstr "" #. type: item #: doc/guix.texi:19699 #, no-wrap msgid "@code{usb-modeswitch} (default: @code{usb-modeswitch})" msgstr "" #. type: table #: doc/guix.texi:19701 msgid "The USB_ModeSwitch package providing the binaries for modeswitching." msgstr "" #. type: item #: doc/guix.texi:19702 #, no-wrap msgid "@code{usb-modeswitch-data} (default: @code{usb-modeswitch-data})" msgstr "" #. type: table #: doc/guix.texi:19705 msgid "" "The package providing the device data and udev rules file used by " "USB_ModeSwitch." msgstr "" #. type: item #: doc/guix.texi:19706 #, no-wrap msgid "@code{config-file} (default: @code{#~(string-append #$usb-modeswitch:dispatcher \"/etc/usb_modeswitch.conf\")})" msgstr "" #. type: table #: doc/guix.texi:19711 msgid "" "Which config file to use for the USB_ModeSwitch dispatcher. By default the " "config file shipped with USB_ModeSwitch is used which disables logging to " "@file{/var/log} among other default settings. If set to @code{#f}, no " "config file is used." msgstr "" #. type: Plain text #: doc/guix.texi:19725 msgid "" "The @code{(gnu services networking)} module discussed in the previous " "section provides services for more advanced setups: providing a DHCP service " "for others to use, filtering packets with iptables or nftables, running a " "WiFi access point with @command{hostapd}, running the @command{inetd} " "``superdaemon'', and more. This section describes those." msgstr "" #. type: deffn #: doc/guix.texi:19726 #, no-wrap msgid "{Scheme Procedure} dhcpd-service-type" msgstr "" #. type: deffn #: doc/guix.texi:19730 msgid "" "This type defines a service that runs a DHCP daemon. To create a service of " "this type, you must supply a @code{}. For example:" msgstr "" #. type: lisp #: doc/guix.texi:19736 #, 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:19739 #, no-wrap msgid "{Data Type} dhcpd-configuration" msgstr "" #. type: table #: doc/guix.texi:19746 msgid "" "The package that provides the DHCP daemon. This package is expected to " "provide the daemon at @file{sbin/dhcpd} relative to its output directory. " "The default package is the @uref{https://www.isc.org/dhcp/, ISC's DHCP " "server}." msgstr "" #. type: table #: doc/guix.texi:19751 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:19751 #, no-wrap msgid "@code{version} (default: @code{\"4\"})" msgstr "" #. type: table #: doc/guix.texi:19756 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:19756 #, no-wrap msgid "@code{run-directory} (default: @code{\"/run/dhcpd\"})" msgstr "" #. type: table #: doc/guix.texi:19759 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:19759 #, no-wrap msgid "@code{pid-file} (default: @code{\"/run/dhcpd/dhcpd.pid\"})" msgstr "" #. type: table #: doc/guix.texi:19762 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:19762 #, no-wrap msgid "@code{interfaces} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:19768 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: cindex #: doc/guix.texi:19771 #, no-wrap msgid "hostapd service, for Wi-Fi access points" msgstr "" #. type: cindex #: doc/guix.texi:19772 #, no-wrap msgid "Wi-Fi access points, hostapd service" msgstr "" #. type: defvr #: doc/guix.texi:19773 #, no-wrap msgid "{Scheme Variable} hostapd-service-type" msgstr "" #. type: defvr #: doc/guix.texi:19778 msgid "" "This is the service type to run the @uref{https://w1.fi/hostapd/, hostapd} " "daemon to set up WiFi (IEEE 802.11) access points and authentication " "servers. Its associated value must be a @code{hostapd-configuration} as " "shown below:" msgstr "" #. type: lisp #: doc/guix.texi:19786 #, no-wrap msgid "" ";; Use wlan1 to run the access point for \"My Network\".\n" "(service hostapd-service-type\n" " (hostapd-configuration\n" " (interface \"wlan1\")\n" " (ssid \"My Network\")\n" " (channel 12)))\n" msgstr "" #. type: deftp #: doc/guix.texi:19789 #, no-wrap msgid "{Data Type} hostapd-configuration" msgstr "" #. type: deftp #: doc/guix.texi:19792 msgid "" "This data type represents the configuration of the hostapd service, with the " "following fields:" msgstr "" #. type: item #: doc/guix.texi:19794 #, no-wrap msgid "@code{package} (default: @code{hostapd})" msgstr "" #. type: table #: doc/guix.texi:19796 msgid "The hostapd package to use." msgstr "" #. type: item #: doc/guix.texi:19797 #, no-wrap msgid "@code{interface} (default: @code{\"wlan0\"})" msgstr "" #. type: table #: doc/guix.texi:19799 msgid "The network interface to run the WiFi access point." msgstr "" #. type: code{#1} #: doc/guix.texi:19800 #, no-wrap msgid "ssid" msgstr "" #. type: table #: doc/guix.texi:19803 msgid "" "The SSID (@dfn{service set identifier}), a string that identifies this " "network." msgstr "" #. type: item #: doc/guix.texi:19804 #, no-wrap msgid "@code{broadcast-ssid?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:19806 msgid "Whether to broadcast this SSID." msgstr "" #. type: item #: doc/guix.texi:19807 #, no-wrap msgid "@code{channel} (default: @code{1})" msgstr "" #. type: table #: doc/guix.texi:19809 msgid "The WiFi channel to use." msgstr "" #. type: item #: doc/guix.texi:19810 #, no-wrap msgid "@code{driver} (default: @code{\"nl80211\"})" msgstr "" #. type: table #: doc/guix.texi:19814 msgid "" "The driver interface type. @code{\"nl80211\"} is used with all Linux " "mac80211 drivers. Use @code{\"none\"} if building hostapd as a standalone " "RADIUS server that does # not control any wireless/wired driver." msgstr "" #. type: item #: doc/guix.texi:19815 doc/guix.texi:26620 doc/guix.texi:29632 #, no-wrap msgid "@code{extra-settings} (default: @code{\"\"})" msgstr "" #. type: table #: doc/guix.texi:19819 msgid "" "Extra settings to append as-is to the hostapd configuration file. See " "@uref{https://w1.fi/cgit/hostap/plain/hostapd/hostapd.conf} for the " "configuration file reference." msgstr "" #. type: defvr #: doc/guix.texi:19822 #, no-wrap msgid "{Scheme Variable} simulated-wifi-service-type" msgstr "" #. type: defvr #: doc/guix.texi:19829 msgid "" "This is the type of a service to simulate WiFi networking, which can be " "useful in virtual machines for testing purposes. The service loads the " "Linux kernel @uref{https://www.kernel.org/doc/html/latest/networking/" "mac80211_hwsim/mac80211_hwsim.html, @code{mac80211_hwsim} module} and starts " "hostapd to create a pseudo WiFi network that can be seen on @code{wlan0}, by " "default." msgstr "" #. type: defvr #: doc/guix.texi:19831 msgid "The service's value is a @code{hostapd-configuration} record." msgstr "" #. type: cindex #: doc/guix.texi:19834 #, no-wrap msgid "iptables" msgstr "" #. type: defvr #: doc/guix.texi:19835 #, no-wrap msgid "{Scheme Variable} iptables-service-type" msgstr "" #. type: defvr #: doc/guix.texi:19841 msgid "" "This is the service type to set up an iptables configuration. iptables is a " "packet filtering framework supported by the Linux kernel. This service " "supports configuring iptables for both IPv4 and IPv6. A simple example " "configuration rejecting all incoming connections except those to the ssh " "port 22 is shown below." msgstr "" #. type: lisp #: doc/guix.texi:19863 #, no-wrap msgid "" "(service iptables-service-type\n" " (iptables-configuration\n" " (ipv4-rules (plain-file \"iptables.rules\" \"*filter\n" ":INPUT ACCEPT\n" ":FORWARD ACCEPT\n" ":OUTPUT ACCEPT\n" "-A INPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT\n" "-A INPUT -p tcp --dport 22 -j ACCEPT\n" "-A INPUT -j REJECT --reject-with icmp-port-unreachable\n" "COMMIT\n" "\"))\n" " (ipv6-rules (plain-file \"ip6tables.rules\" \"*filter\n" ":INPUT ACCEPT\n" ":FORWARD ACCEPT\n" ":OUTPUT ACCEPT\n" "-A INPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT\n" "-A INPUT -p tcp --dport 22 -j ACCEPT\n" "-A INPUT -j REJECT --reject-with icmp6-port-unreachable\n" "COMMIT\n" "\"))))\n" msgstr "" #. type: deftp #: doc/guix.texi:19866 #, no-wrap msgid "{Data Type} iptables-configuration" msgstr "" #. type: deftp #: doc/guix.texi:19868 msgid "The data type representing the configuration of iptables." msgstr "" #. type: item #: doc/guix.texi:19870 #, no-wrap msgid "@code{iptables} (default: @code{iptables})" msgstr "" #. type: table #: doc/guix.texi:19873 msgid "" "The iptables package that provides @code{iptables-restore} and " "@code{ip6tables-restore}." msgstr "" #. type: item #: doc/guix.texi:19873 #, no-wrap msgid "@code{ipv4-rules} (default: @code{%iptables-accept-all-rules})" msgstr "" #. type: table #: doc/guix.texi:19877 msgid "" "The iptables rules to use. It will be passed to @code{iptables-restore}. " "This may be any ``file-like'' object (@pxref{G-Expressions, file-like " "objects})." msgstr "" #. type: item #: doc/guix.texi:19877 #, no-wrap msgid "@code{ipv6-rules} (default: @code{%iptables-accept-all-rules})" msgstr "" #. type: table #: doc/guix.texi:19881 msgid "" "The ip6tables rules to use. It will be passed to @code{ip6tables-restore}. " "This may be any ``file-like'' object (@pxref{G-Expressions, file-like " "objects})." msgstr "" #. type: cindex #: doc/guix.texi:19884 #, no-wrap msgid "nftables" msgstr "" #. type: defvr #: doc/guix.texi:19885 #, no-wrap msgid "{Scheme Variable} nftables-service-type" msgstr "" #. type: defvr #: doc/guix.texi:19893 msgid "" "This is the service type to set up a nftables configuration. nftables is a " "netfilter project that aims to replace the existing iptables, ip6tables, " "arptables and ebtables framework. It provides a new packet filtering " "framework, a new user-space utility @command{nft}, and a compatibility layer " "for iptables. This service comes with a default ruleset @code{%default-" "nftables-ruleset} that rejecting all incoming connections except those to " "the ssh port 22. To use it, simply write:" msgstr "" #. type: lisp #: doc/guix.texi:19896 #, no-wrap msgid "(service nftables-service-type)\n" msgstr "" #. type: deftp #: doc/guix.texi:19899 #, no-wrap msgid "{Data Type} nftables-configuration" msgstr "" #. type: deftp #: doc/guix.texi:19901 msgid "The data type representing the configuration of nftables." msgstr "" #. type: item #: doc/guix.texi:19903 #, no-wrap msgid "@code{package} (default: @code{nftables})" msgstr "" #. type: table #: doc/guix.texi:19905 msgid "The nftables package that provides @command{nft}." msgstr "" #. type: item #: doc/guix.texi:19905 #, no-wrap msgid "@code{ruleset} (default: @code{%default-nftables-ruleset})" msgstr "" #. type: table #: doc/guix.texi:19908 msgid "" "The nftables ruleset to use. This may be any ``file-like'' object (@pxref{G-" "Expressions, file-like objects})." msgstr "" #. type: cindex #: doc/guix.texi:19911 #, no-wrap msgid "NTP (Network Time Protocol), service" msgstr "" #. type: cindex #: doc/guix.texi:19912 #, no-wrap msgid "ntpd, service for the Network Time Protocol daemon" msgstr "" #. type: cindex #: doc/guix.texi:19913 #, no-wrap msgid "real time clock" msgstr "" #. type: defvr #: doc/guix.texi:19914 #, no-wrap msgid "{Scheme Variable} ntp-service-type" msgstr "" #. type: defvr #: doc/guix.texi:19918 msgid "" "This is the type of the service running the @uref{https://www.ntp.org, " "Network Time Protocol (NTP)} daemon, @command{ntpd}. The daemon will keep " "the system clock synchronized with that of the specified NTP servers." msgstr "" #. type: defvr #: doc/guix.texi:19921 msgid "" "The value of this service is an @code{ntpd-configuration} object, as " "described below." msgstr "" #. type: deftp #: doc/guix.texi:19923 #, no-wrap msgid "{Data Type} ntp-configuration" msgstr "" #. type: deftp #: doc/guix.texi:19925 msgid "This is the data type for the NTP service configuration." msgstr "" #. type: item #: doc/guix.texi:19927 #, no-wrap msgid "@code{servers} (default: @code{%ntp-servers})" msgstr "" #. type: table #: doc/guix.texi:19931 msgid "" "This is the list of servers (@code{} records) with which " "@command{ntpd} will be synchronized. See the @code{ntp-server} data type " "definition below." msgstr "" #. type: item #: doc/guix.texi:19932 #, no-wrap msgid "@code{allow-large-adjustment?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:19935 msgid "" "This determines whether @command{ntpd} is allowed to make an initial " "adjustment of more than 1,000 seconds." msgstr "" #. type: item #: doc/guix.texi:19936 #, no-wrap msgid "@code{ntp} (default: @code{ntp})" msgstr "" #. type: table #: doc/guix.texi:19938 msgid "The NTP package to use." msgstr "" #. type: defvr #: doc/guix.texi:19941 #, no-wrap msgid "{Scheme Variable} %ntp-servers" msgstr "" #. type: defvr #: doc/guix.texi:19944 msgid "" "List of host names used as the default NTP servers. These are servers of " "the @uref{https://www.ntppool.org/en/, NTP Pool Project}." msgstr "" #. type: deftp #: doc/guix.texi:19946 #, no-wrap msgid "{Data Type} ntp-server" msgstr "" #. type: deftp #: doc/guix.texi:19948 msgid "The data type representing the configuration of a NTP server." msgstr "" #. type: item #: doc/guix.texi:19950 #, no-wrap msgid "@code{type} (default: @code{'server})" msgstr "" #. type: table #: doc/guix.texi:19953 msgid "" "The type of the NTP server, given as a symbol. One of @code{'pool}, " "@code{'server}, @code{'peer}, @code{'broadcast} or @code{'manycastclient}." msgstr "" #. type: code{#1} #: doc/guix.texi:19954 #, no-wrap msgid "address" msgstr "" #. type: table #: doc/guix.texi:19956 msgid "The address of the server, as a string." msgstr "" #. type: code{#1} #: doc/guix.texi:19957 doc/guix.texi:36937 doc/guix.texi:36957 #, no-wrap msgid "options" msgstr "" #. type: table #: doc/guix.texi:19962 msgid "" "NTPD options to use with that specific server, given as a list of option " "names and/or of option names and values tuples. The following example " "define a server to use with the options @option{iburst} and @option{prefer}, " "as well as @option{version} 3 and a @option{maxpoll} time of 16 seconds." msgstr "" #. type: example #: doc/guix.texi:19968 #, no-wrap msgid "" "(ntp-server\n" " (type 'server)\n" " (address \"some.ntp.server.org\")\n" " (options `(iburst (version 3) (maxpoll 16) prefer))))\n" msgstr "" #. type: cindex #: doc/guix.texi:19972 #, no-wrap msgid "OpenNTPD" msgstr "" #. type: deffn #: doc/guix.texi:19973 #, no-wrap msgid "{Scheme Procedure} openntpd-service-type" msgstr "" #. type: deffn #: doc/guix.texi:19977 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: lisp #: doc/guix.texi:19986 #, 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" "\n" msgstr "" #. type: defvr #: doc/guix.texi:19990 #, no-wrap msgid "{Scheme Variable} %openntpd-servers" msgstr "" #. type: defvr #: doc/guix.texi:19993 msgid "" "This variable is a list of the server addresses defined in @code{%ntp-" "servers}." msgstr "" #. type: deftp #: doc/guix.texi:19995 #, no-wrap msgid "{Data Type} openntpd-configuration" msgstr "" #. type: item #: doc/guix.texi:19997 #, no-wrap msgid "@code{openntpd} (default: @code{(file-append openntpd \"/sbin/ntpd\")})" msgstr "" #. type: table #: doc/guix.texi:19999 msgid "The openntpd executable to use." msgstr "" #. type: item #: doc/guix.texi:19999 #, no-wrap msgid "@code{listen-on} (default: @code{'(\"127.0.0.1\" \"::1\")})" msgstr "" #. type: table #: doc/guix.texi:20001 msgid "" "A list of local IP addresses or hostnames the ntpd daemon should listen on." msgstr "" #. type: item #: doc/guix.texi:20001 #, no-wrap msgid "@code{query-from} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:20003 msgid "" "A list of local IP address the ntpd daemon should use for outgoing queries." msgstr "" #. type: item #: doc/guix.texi:20003 #, no-wrap msgid "@code{sensor} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:20008 msgid "" "Specify a list of timedelta sensor devices ntpd should use. @code{ntpd} " "will listen to each sensor that actually exists and ignore non-existent " "ones. See @uref{https://man.openbsd.org/ntpd.conf, upstream documentation} " "for more information." msgstr "" #. type: item #: doc/guix.texi:20008 #, no-wrap msgid "@code{server} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:20010 msgid "" "Specify a list of IP addresses or hostnames of NTP servers to synchronize to." msgstr "" #. type: item #: doc/guix.texi:20010 #, no-wrap msgid "@code{servers} (default: @code{%openntp-servers})" msgstr "" #. type: table #: doc/guix.texi:20012 msgid "" "Specify a list of IP addresses or hostnames of NTP pools to synchronize to." msgstr "" #. type: item #: doc/guix.texi:20012 #, no-wrap msgid "@code{constraint-from} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:20019 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:20019 #, no-wrap msgid "@code{constraints-from} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:20023 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: cindex #: doc/guix.texi:20026 #, no-wrap msgid "inetd" msgstr "" #. type: deffn #: doc/guix.texi:20027 #, no-wrap msgid "{Scheme variable} inetd-service-type" msgstr "" #. type: deffn #: doc/guix.texi:20032 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:20038 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: lisp #: doc/guix.texi:20061 #, 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:20064 msgid "See below for more details about @code{inetd-configuration}." msgstr "" #. type: deftp #: doc/guix.texi:20066 #, no-wrap msgid "{Data Type} inetd-configuration" msgstr "" #. type: deftp #: doc/guix.texi:20068 msgid "Data type representing the configuration of @command{inetd}." msgstr "" #. type: item #: doc/guix.texi:20070 #, no-wrap msgid "@code{program} (default: @code{(file-append inetutils \"/libexec/inetd\")})" msgstr "" #. type: table #: doc/guix.texi:20072 msgid "The @command{inetd} executable to use." msgstr "" #. type: item #: doc/guix.texi:20073 doc/guix.texi:30482 #, no-wrap msgid "@code{entries} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:20076 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:20079 #, no-wrap msgid "{Data Type} inetd-entry" msgstr "" #. type: deftp #: doc/guix.texi:20083 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:20085 #, no-wrap msgid "@code{node} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:20090 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:20092 msgid "A string, the name must correspond to an entry in @code{/etc/services}." msgstr "" #. type: code{#1} #: doc/guix.texi:20092 #, no-wrap msgid "socket-type" msgstr "" #. type: table #: doc/guix.texi:20095 msgid "" "One of @code{'stream}, @code{'dgram}, @code{'raw}, @code{'rdm} or " "@code{'seqpacket}." msgstr "" #. type: code{#1} #: doc/guix.texi:20095 #, no-wrap msgid "protocol" msgstr "" #. type: table #: doc/guix.texi:20097 msgid "A string, must correspond to an entry in @code{/etc/protocols}." msgstr "" #. type: item #: doc/guix.texi:20097 #, no-wrap msgid "@code{wait?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:20100 msgid "" "Whether @command{inetd} should wait for the server to exit before listening " "to new service requests." msgstr "" #. type: table #: doc/guix.texi:20105 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:20105 #, no-wrap msgid "@code{program} (default: @code{\"internal\"})" msgstr "" #. type: table #: doc/guix.texi:20108 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:20113 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:20117 msgid "" "@xref{Configuration file,,, inetutils, GNU Inetutils} for a more detailed " "discussion of each configuration field." msgstr "" #. type: cindex #: doc/guix.texi:20119 #, no-wrap msgid "opendht, distributed hash table network service" msgstr "" #. type: cindex #: doc/guix.texi:20120 #, no-wrap msgid "dhtproxy, for use with jami" msgstr "" #. type: defvr #: doc/guix.texi:20121 #, no-wrap msgid "{Scheme Variable} opendht-service-type" msgstr "" #. type: defvr #: doc/guix.texi:20126 msgid "" "This is the type of the service running a @uref{https://opendht.net, " "OpenDHT} node, @command{dhtnode}. The daemon can be used to host your own " "proxy service to the distributed hash table (DHT), for example to connect to " "with Jami, among other applications." msgstr "" #. type: quotation #: doc/guix.texi:20127 doc/contributing.texi:1769 #, no-wrap msgid "Important" msgstr "" #. type: quotation #: doc/guix.texi:20136 msgid "" "When using the OpenDHT proxy server, the IP addresses it ``sees'' from the " "clients should be addresses reachable from other peers. In practice this " "means that a publicly reachable address is best suited for a proxy server, " "outside of your private network. For example, hosting the proxy server on a " "IPv4 private local network and exposing it via port forwarding could work " "for external peers, but peers local to the proxy would have their private " "addresses shared with the external peers, leading to connectivity problems." msgstr "" #. type: defvr #: doc/guix.texi:20140 msgid "" "The value of this service is a @code{opendht-configuration} object, as " "described below." msgstr "" #. type: deftp #: doc/guix.texi:20145 #, no-wrap msgid "{Data Type} opendht-configuration" msgstr "" #. type: deftp #: doc/guix.texi:20147 msgid "Available @code{opendht-configuration} fields are:" msgstr "" #. type: item #: doc/guix.texi:20149 #, no-wrap msgid "@code{opendht} (default: @code{opendht}) (type: file-like)" msgstr "" #. type: table #: doc/guix.texi:20151 msgid "The @code{opendht} package to use." msgstr "" #. type: item #: doc/guix.texi:20152 #, no-wrap msgid "@code{peer-discovery?} (default: @code{#f}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:20154 msgid "Whether to enable the multicast local peer discovery mechanism." msgstr "" #. type: item #: doc/guix.texi:20155 #, no-wrap msgid "@code{enable-logging?} (default: @code{#f}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:20158 msgid "" "Whether to enable logging messages to syslog. It is disabled by default as " "it is rather verbose." msgstr "" #. type: item #: doc/guix.texi:20159 doc/guix.texi:21658 doc/guix.texi:26818 #, no-wrap msgid "@code{debug?} (default: @code{#f}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:20162 msgid "" "Whether to enable debug-level logging messages. This has no effect if " "logging is disabled." msgstr "" #. type: item #: doc/guix.texi:20163 #, no-wrap msgid "@code{bootstrap-host} (default: @code{\"bootstrap.jami.net:4222\"}) (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:20170 msgid "" "The node host name that is used to make the first connection to the " "network. A specific port value can be provided by appending the @code{:" "PORT} suffix. By default, it uses the Jami bootstrap nodes, but any host " "can be specified here. It's also possible to disable bootstrapping by " "explicitly setting this field to the @code{%unset-value} value." msgstr "" #. type: item #: doc/guix.texi:20171 #, no-wrap msgid "@code{port} (default: @code{4222}) (type: maybe-number)" msgstr "" #. type: table #: doc/guix.texi:20174 msgid "" "The UDP port to bind to. When left unspecified, an available port is " "automatically selected." msgstr "" #. type: item #: doc/guix.texi:20175 #, no-wrap msgid "@code{proxy-server-port} (type: maybe-number)" msgstr "" #. type: table #: doc/guix.texi:20177 msgid "Spawn a proxy server listening on the specified port." msgstr "" #. type: item #: doc/guix.texi:20178 #, no-wrap msgid "@code{proxy-server-port-tls} (type: maybe-number)" msgstr "" #. type: table #: doc/guix.texi:20180 msgid "" "Spawn a proxy server listening to TLS connections on the specified port." msgstr "" #. type: cindex #: doc/guix.texi:20184 #, no-wrap msgid "Tor" msgstr "" #. type: defvr #: doc/guix.texi:20185 #, no-wrap msgid "{Scheme Variable} tor-service-type" msgstr "" #. type: defvr #: doc/guix.texi:20190 msgid "" "This is the type for a service that runs the @uref{https://torproject.org, " "Tor} anonymous networking daemon. The service is configured using a " "@code{} record. By default, the Tor daemon runs as the " "@code{tor} unprivileged user, which is a member of the @code{tor} group." msgstr "" #. type: deftp #: doc/guix.texi:20193 #, no-wrap msgid "{Data Type} tor-configuration" msgstr "" #. type: item #: doc/guix.texi:20195 #, no-wrap msgid "@code{tor} (default: @code{tor})" msgstr "" #. type: table #: doc/guix.texi:20200 msgid "" "The package that provides the Tor daemon. This package is expected to " "provide the daemon at @file{bin/tor} relative to its output directory. The " "default package is the @uref{https://www.torproject.org, Tor Project's} " "implementation." msgstr "" #. type: item #: doc/guix.texi:20201 #, no-wrap msgid "@code{config-file} (default: @code{(plain-file \"empty\" \"\")})" msgstr "" #. type: table #: doc/guix.texi:20207 msgid "" "The configuration file to use. It will be appended to a default " "configuration file, and the final configuration file will be passed to " "@code{tor} via its @code{-f} option. This may be any ``file-like'' object " "(@pxref{G-Expressions, file-like objects}). See @code{man tor} for details " "on the configuration file syntax." msgstr "" #. type: item #: doc/guix.texi:20208 #, no-wrap msgid "@code{hidden-services} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:20214 msgid "" "The list of @code{} 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{} records using the @code{tor-" "hidden-service} procedure described below." msgstr "" #. type: item #: doc/guix.texi:20215 #, no-wrap msgid "@code{socks-socket-type} (default: @code{'tcp})" msgstr "" #. type: table #: doc/guix.texi:20222 msgid "" "The default socket type that Tor should use for its SOCKS socket. This must " "be either @code{'tcp} or @code{'unix}. If it is @code{'tcp}, then by " "default Tor will listen on TCP port 9050 on the loopback interface (i.e., " "localhost). If it is @code{'unix}, then Tor will listen on the UNIX domain " "socket @file{/var/run/tor/socks-sock}, which will be made writable by " "members of the @code{tor} group." msgstr "" #. type: table #: doc/guix.texi:20227 msgid "" "If you want to customize the SOCKS socket in more detail, leave @code{socks-" "socket-type} at its default value of @code{'tcp} and use @code{config-file} " "to override the default by providing your own @code{SocksPort} option." msgstr "" #. type: item #: doc/guix.texi:20228 #, no-wrap msgid "@code{control-socket?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:20234 msgid "" "Whether or not to provide a ``control socket'' by which Tor can be " "controlled to, for instance, dynamically instantiate tor onion services. If " "@code{#t}, Tor will listen for control commands on the UNIX domain socket " "@file{/var/run/tor/control-sock}, which will be made writable by members of " "the @code{tor} group." msgstr "" #. type: cindex #: doc/guix.texi:20238 #, no-wrap msgid "hidden service" msgstr "" #. type: deffn #: doc/guix.texi:20239 #, no-wrap msgid "{Scheme Procedure} tor-hidden-service @var{name} @var{mapping}" msgstr "" #. type: deffn #: doc/guix.texi:20242 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:20246 #, no-wrap msgid "" " '((22 \"127.0.0.1:22\")\n" " (80 \"127.0.0.1:8080\"))\n" msgstr "" #. type: deffn #: doc/guix.texi:20250 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:20254 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:20257 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:20260 msgid "The @code{(gnu services rsync)} module provides the following services:" msgstr "" #. type: Plain text #: doc/guix.texi:20264 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:20265 #, no-wrap msgid "{Scheme Variable} rsync-service-type" msgstr "" #. type: deffn #: doc/guix.texi:20269 msgid "" "This is the service type for the @uref{https://rsync.samba.org, rsync} " "daemon, The value for this service type is a @command{rsync-configuration} " "record as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:20282 #, no-wrap msgid "" ";; Export two directories over rsync. By default rsync listens on\n" ";; all the network interfaces.\n" "(service rsync-service-type\n" " (rsync-configuration\n" " (modules (list (rsync-module\n" " (name \"music\")\n" " (file-name \"/srv/zik\")\n" " (read-only? #f))\n" " (rsync-module\n" " (name \"movies\")\n" " (file-name \"/home/charlie/movies\"))))))\n" msgstr "" #. type: deffn #: doc/guix.texi:20285 msgid "See below for details about @code{rsync-configuration}." msgstr "" #. type: deftp #: doc/guix.texi:20287 #, no-wrap msgid "{Data Type} rsync-configuration" msgstr "" #. type: deftp #: doc/guix.texi:20289 msgid "Data type representing the configuration for @code{rsync-service}." msgstr "" #. type: item #: doc/guix.texi:20291 #, no-wrap msgid "@code{package} (default: @var{rsync})" msgstr "" #. type: table #: doc/guix.texi:20293 msgid "@code{rsync} package to use." msgstr "" #. type: item #: doc/guix.texi:20294 doc/guix.texi:34516 #, no-wrap msgid "@code{address} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:20297 msgid "" "IP address on which @command{rsync} listens for incoming connections. If " "unspecified, it defaults to listening on all available addresses." msgstr "" #. type: item #: doc/guix.texi:20298 #, no-wrap msgid "@code{port-number} (default: @code{873})" msgstr "" #. type: table #: doc/guix.texi:20302 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:20303 #, no-wrap msgid "@code{pid-file} (default: @code{\"/var/run/rsyncd/rsyncd.pid\"})" msgstr "" #. type: table #: doc/guix.texi:20305 msgid "Name of the file where @command{rsync} writes its PID." msgstr "" #. type: item #: doc/guix.texi:20306 #, no-wrap msgid "@code{lock-file} (default: @code{\"/var/run/rsyncd/rsyncd.lock\"})" msgstr "" #. type: table #: doc/guix.texi:20308 msgid "Name of the file where @command{rsync} writes its lock file." msgstr "" #. type: item #: doc/guix.texi:20309 #, no-wrap msgid "@code{log-file} (default: @code{\"/var/log/rsyncd.log\"})" msgstr "" #. type: table #: doc/guix.texi:20311 msgid "Name of the file where @command{rsync} writes its log file." msgstr "" #. type: item #: doc/guix.texi:20312 doc/guix.texi:39134 #, no-wrap msgid "@code{user} (default: @code{\"root\"})" msgstr "" #. type: table #: doc/guix.texi:20314 msgid "Owner of the @code{rsync} process." msgstr "" #. type: item #: doc/guix.texi:20315 #, no-wrap msgid "@code{group} (default: @code{\"root\"})" msgstr "" #. type: table #: doc/guix.texi:20317 msgid "Group of the @code{rsync} process." msgstr "" #. type: item #: doc/guix.texi:20318 #, no-wrap msgid "@code{uid} (default: @code{\"rsyncd\"})" msgstr "" #. type: table #: doc/guix.texi:20321 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:20322 #, no-wrap msgid "@code{gid} (default: @code{\"rsyncd\"})" msgstr "" #. type: table #: doc/guix.texi:20324 doc/guix.texi:20819 msgid "Group name or group ID that will be used when accessing the module." msgstr "" #. type: item #: doc/guix.texi:20325 doc/guix.texi:39941 #, no-wrap msgid "@code{modules} (default: @code{%default-modules})" msgstr "" #. type: table #: doc/guix.texi:20328 msgid "" "List of ``modules''---i.e., directories exported over rsync. Each element " "must be a @code{rsync-module} record, as described below." msgstr "" #. type: deftp #: doc/guix.texi:20331 #, no-wrap msgid "{Data Type} rsync-module" msgstr "" #. type: deftp #: doc/guix.texi:20334 msgid "" "This is the data type for rsync ``modules''. A module is a directory " "exported over the rsync protocol. The available fields are as follows:" msgstr "" #. type: table #: doc/guix.texi:20340 msgid "" "The module name. This is the name that shows up in URLs. For example, if " "the module is called @code{music}, the corresponding URL will be " "@code{rsync://host.example.org/music}." msgstr "" #. type: code{#1} #: doc/guix.texi:20341 #, no-wrap msgid "file-name" msgstr "" #. type: table #: doc/guix.texi:20343 msgid "Name of the directory being exported." msgstr "" #. type: table #: doc/guix.texi:20347 msgid "" "Comment associated with the module. Client user interfaces may display it " "when they obtain the list of available modules." msgstr "" #. type: item #: doc/guix.texi:20348 #, no-wrap msgid "@code{read-only?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:20352 msgid "" "Whether or not client will be able to upload files. If this is false, the " "uploads will be authorized if permissions on the daemon side permit it." msgstr "" #. type: item #: doc/guix.texi:20353 #, no-wrap msgid "@code{chroot?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:20357 msgid "" "When this is true, the rsync daemon changes root to the module's directory " "before starting file transfers with the client. This improves security, but " "requires rsync to run as root." msgstr "" #. type: item #: doc/guix.texi:20358 #, no-wrap msgid "@code{timeout} (default: @code{300})" msgstr "" #. type: table #: doc/guix.texi:20361 msgid "" "Idle time in seconds after which the daemon closes a connection with the " "client." msgstr "" #. type: Plain text #: doc/guix.texi:20365 msgid "" "The @code{(gnu services syncthing)} module provides the following services:" msgstr "" #. type: cindex #: doc/guix.texi:20365 #, no-wrap msgid "syncthing" msgstr "" #. type: Plain text #: doc/guix.texi:20370 msgid "" "You might want a syncthing daemon if you have files between two or more " "computers and want to sync them in real time, safely protected from prying " "eyes." msgstr "" #. type: deffn #: doc/guix.texi:20371 #, no-wrap msgid "{Scheme Variable} syncthing-service-type" msgstr "" #. type: deffn #: doc/guix.texi:20375 msgid "" "This is the service type for the @uref{https://syncthing.net/, syncthing} " "daemon, The value for this service type is a @command{syncthing-" "configuration} record as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:20379 #, no-wrap msgid "" "(service syncthing-service-type\n" " (syncthing-configuration (user \"alice\")))\n" msgstr "" #. type: deffn #: doc/guix.texi:20382 msgid "See below for details about @code{syncthing-configuration}." msgstr "" #. type: deftp #: doc/guix.texi:20383 #, no-wrap msgid "{Data Type} syncthing-configuration" msgstr "" #. type: deftp #: doc/guix.texi:20385 msgid "" "Data type representing the configuration for @code{syncthing-service-type}." msgstr "" #. type: item #: doc/guix.texi:20387 #, no-wrap msgid "@code{syncthing} (default: @var{syncthing})" msgstr "" #. type: table #: doc/guix.texi:20389 msgid "@code{syncthing} package to use." msgstr "" #. type: item #: doc/guix.texi:20390 #, no-wrap msgid "@code{arguments} (default: @var{'()})" msgstr "" #. type: table #: doc/guix.texi:20392 msgid "List of command-line arguments passing to @code{syncthing} binary." msgstr "" #. type: item #: doc/guix.texi:20393 #, no-wrap msgid "@code{logflags} (default: @var{0})" msgstr "" #. type: table #: doc/guix.texi:20396 msgid "" "Sum of logging flags, see @uref{https://docs.syncthing.net/users/syncthing." "html#cmdoption-logflags, Syncthing documentation logflags}." msgstr "" #. type: item #: doc/guix.texi:20397 #, no-wrap msgid "@code{user} (default: @var{#f})" msgstr "" #. type: table #: doc/guix.texi:20400 msgid "" "The user as which the Syncthing service is to be run. This assumes that the " "specified user exists." msgstr "" #. type: item #: doc/guix.texi:20401 #, no-wrap msgid "@code{group} (default: @var{\"users\"})" msgstr "" #. type: table #: doc/guix.texi:20404 msgid "" "The group as which the Syncthing service is to be run. This assumes that " "the specified group exists." msgstr "" #. type: item #: doc/guix.texi:20405 #, no-wrap msgid "@code{home} (default: @var{#f})" msgstr "" #. type: table #: doc/guix.texi:20408 msgid "" "Common configuration and data directory. The default configuration " "directory is @file{$HOME} of the specified Syncthing @code{user}." msgstr "" #. type: Plain text #: doc/guix.texi:20414 msgid "Furthermore, @code{(gnu services ssh)} provides the following services." msgstr "" #. type: cindex #: doc/guix.texi:20414 doc/guix.texi:20453 doc/guix.texi:39278 #, no-wrap msgid "SSH" msgstr "" #. type: cindex #: doc/guix.texi:20415 doc/guix.texi:20454 doc/guix.texi:39279 #, no-wrap msgid "SSH server" msgstr "" #. type: deffn #: doc/guix.texi:20417 #, no-wrap msgid "{Scheme Procedure} lsh-service [#:host-key \"/etc/lsh/host-key\"] @" msgstr "" #. type: deffn #: doc/guix.texi:20426 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:20432 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:20436 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:20441 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:20445 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:20449 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:20451 msgid "The other options should be self-descriptive." msgstr "" #. type: deffn #: doc/guix.texi:20455 #, no-wrap msgid "{Scheme Variable} openssh-service-type" msgstr "" #. type: deffn #: doc/guix.texi:20459 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: lisp #: doc/guix.texi:20468 #, no-wrap msgid "" "(service openssh-service-type\n" " (openssh-configuration\n" " (x11-forwarding? #t)\n" " (permit-root-login 'prohibit-password)\n" " (authorized-keys\n" " `((\"alice\" ,(local-file \"alice.pub\"))\n" " (\"bob\" ,(local-file \"bob.pub\"))))))\n" msgstr "" #. type: deffn #: doc/guix.texi:20471 msgid "See below for details about @code{openssh-configuration}." msgstr "" #. type: deffn #: doc/guix.texi:20474 msgid "" "This service can be extended with extra authorized keys, as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:20479 #, no-wrap msgid "" "(service-extension openssh-service-type\n" " (const `((\"charlie\"\n" " ,(local-file \"charlie.pub\")))))\n" msgstr "" #. type: deftp #: doc/guix.texi:20482 #, no-wrap msgid "{Data Type} openssh-configuration" msgstr "" #. type: deftp #: doc/guix.texi:20484 msgid "This is the configuration record for OpenSSH's @command{sshd}." msgstr "" #. type: item #: doc/guix.texi:20486 #, no-wrap msgid "@code{openssh} (default @var{openssh})" msgstr "" #. type: table #: doc/guix.texi:20488 msgid "The OpenSSH package to use." msgstr "" #. type: item #: doc/guix.texi:20489 #, no-wrap msgid "@code{pid-file} (default: @code{\"/var/run/sshd.pid\"})" msgstr "" #. type: table #: doc/guix.texi:20491 msgid "Name of the file where @command{sshd} writes its PID." msgstr "" #. type: item #: doc/guix.texi:20492 #, no-wrap msgid "@code{port-number} (default: @code{22})" msgstr "" #. type: table #: doc/guix.texi:20494 msgid "TCP port on which @command{sshd} listens for incoming connections." msgstr "" #. type: item #: doc/guix.texi:20495 #, no-wrap msgid "@code{max-connections} (default: @code{200})" msgstr "" #. type: table #: doc/guix.texi:20500 msgid "" "Hard limit on the maximum number of simultaneous client connections, " "enforced by the inetd-style Shepherd service (@pxref{Service De- and " "Constructors, @code{make-inetd-constructor},, shepherd, The GNU Shepherd " "Manual})." msgstr "" #. type: item #: doc/guix.texi:20501 #, no-wrap msgid "@code{permit-root-login} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:20506 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{'prohibit-password}, then root logins are permitted " "but not with password-based authentication." msgstr "" #. type: item #: doc/guix.texi:20507 doc/guix.texi:20678 #, no-wrap msgid "@code{allow-empty-passwords?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:20510 msgid "" "When true, users with empty passwords may log in. When false, they may not." msgstr "" #. type: item #: doc/guix.texi:20511 doc/guix.texi:20681 #, no-wrap msgid "@code{password-authentication?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:20514 msgid "" "When true, users may log in with their password. When false, they have " "other authentication methods." msgstr "" #. type: item #: doc/guix.texi:20515 #, no-wrap msgid "@code{public-key-authentication?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:20518 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:20521 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:20522 #, no-wrap msgid "@code{x11-forwarding?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:20526 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:20527 #, no-wrap msgid "@code{allow-agent-forwarding?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:20529 msgid "Whether to allow agent forwarding." msgstr "" #. type: item #: doc/guix.texi:20530 #, no-wrap msgid "@code{allow-tcp-forwarding?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:20532 msgid "Whether to allow TCP forwarding." msgstr "" #. type: item #: doc/guix.texi:20533 #, no-wrap msgid "@code{gateway-ports?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:20535 msgid "Whether to allow gateway ports." msgstr "" #. type: item #: doc/guix.texi:20536 #, no-wrap msgid "@code{challenge-response-authentication?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:20539 msgid "" "Specifies whether challenge response authentication is allowed (e.g.@: via " "PAM)." msgstr "" #. type: item #: doc/guix.texi:20540 #, no-wrap msgid "@code{use-pam?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:20546 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:20551 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:20552 #, no-wrap msgid "@code{print-last-log?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:20555 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:20556 #, no-wrap msgid "@code{subsystems} (default: @code{'((\"sftp\" \"internal-sftp\"))})" msgstr "" #. type: table #: doc/guix.texi:20558 msgid "Configures external subsystems (e.g.@: file transfer daemon)." msgstr "" #. type: table #: doc/guix.texi:20562 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:20565 msgid "" "The command @command{internal-sftp} implements an in-process SFTP server. " "Alternatively, one can specify the @command{sftp-server} command:" msgstr "" #. type: lisp #: doc/guix.texi:20570 #, 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:20572 #, no-wrap msgid "@code{accepted-environment} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:20574 msgid "List of strings describing which environment variables may be exported." msgstr "" #. type: table #: doc/guix.texi:20577 msgid "" "Each string gets on its own line. See the @code{AcceptEnv} option in " "@code{man sshd_config}." msgstr "" #. type: table #: doc/guix.texi:20582 msgid "" "This example allows ssh-clients to export the @env{COLORTERM} variable. It " "is set by terminal emulators, which support colors. You can use it in your " "shell's resource file to enable colors for the prompt and commands if this " "variable is set." msgstr "" #. type: lisp #: doc/guix.texi:20587 #, no-wrap msgid "" "(service openssh-service-type\n" " (openssh-configuration\n" " (accepted-environment '(\"COLORTERM\"))))\n" msgstr "" #. type: cindex #: doc/guix.texi:20590 #, no-wrap msgid "authorized keys, SSH" msgstr "" #. type: cindex #: doc/guix.texi:20591 #, no-wrap msgid "SSH authorized keys" msgstr "" #. type: table #: doc/guix.texi:20595 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: lisp #: doc/guix.texi:20602 #, 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:20607 msgid "" "registers the specified public keys for user accounts @code{rekado}, " "@code{chris}, and @code{root}." msgstr "" #. type: table #: doc/guix.texi:20610 msgid "" "Additional authorized keys can be specified @i{via} @code{service-extension}." msgstr "" #. type: table #: doc/guix.texi:20613 msgid "" "Note that this does @emph{not} interfere with the use of @file{~/.ssh/" "authorized_keys}." msgstr "" #. type: item #: doc/guix.texi:20614 #, no-wrap msgid "@code{generate-host-keys?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:20617 msgid "" "Whether to generate host key pairs with @command{ssh-keygen -A} under @file{/" "etc/ssh} if there are none." msgstr "" #. type: table #: doc/guix.texi:20623 msgid "" "Generating key pairs takes a few seconds when enough entropy is available " "and is only done once. You might want to turn it off for instance in a " "virtual machine that does not need it because host keys are provided in some " "other way, and where the extra boot time is a problem." msgstr "" #. type: item #: doc/guix.texi:20624 doc/guix.texi:21048 #, no-wrap msgid "@code{log-level} (default: @code{'info})" msgstr "" #. type: table #: doc/guix.texi:20628 msgid "" "This is a symbol specifying the logging level: @code{quiet}, @code{fatal}, " "@code{error}, @code{info}, @code{verbose}, @code{debug}, etc. See the man " "page for @file{sshd_config} for the full list of level names." msgstr "" #. type: item #: doc/guix.texi:20629 doc/guix.texi:24213 doc/guix.texi:29290 #, no-wrap msgid "@code{extra-content} (default: @code{\"\"})" msgstr "" #. type: table #: doc/guix.texi:20634 msgid "" "This field can be used to append arbitrary text to the configuration file. " "It is especially useful for elaborate configurations that cannot be " "expressed otherwise. This configuration, for example, would generally " "disable root logins, but permit them from one specific IP address:" msgstr "" #. type: lisp #: doc/guix.texi:20640 #, no-wrap msgid "" "(openssh-configuration\n" " (extra-content \"\\\n" "Match Address 192.168.0.1\n" " PermitRootLogin yes\"))\n" msgstr "" #. type: deffn #: doc/guix.texi:20645 #, no-wrap msgid "{Scheme Procedure} dropbear-service [@var{config}]" msgstr "" #. type: deffn #: doc/guix.texi:20649 msgid "" "Run the @uref{https://matt.ucc.asn.au/dropbear/dropbear.html,Dropbear SSH " "daemon} with the given @var{config}, a @code{} " "object." msgstr "" #. type: deffn #: doc/guix.texi:20652 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: lisp #: doc/guix.texi:20656 #, no-wrap msgid "" "(dropbear-service (dropbear-configuration\n" " (port-number 1234)))\n" msgstr "" #. type: deftp #: doc/guix.texi:20659 #, no-wrap msgid "{Data Type} dropbear-configuration" msgstr "" #. type: deftp #: doc/guix.texi:20661 msgid "This data type represents the configuration of a Dropbear SSH daemon." msgstr "" #. type: item #: doc/guix.texi:20663 #, no-wrap msgid "@code{dropbear} (default: @var{dropbear})" msgstr "" #. type: table #: doc/guix.texi:20665 msgid "The Dropbear package to use." msgstr "" #. type: item #: doc/guix.texi:20666 #, no-wrap msgid "@code{port-number} (default: 22)" msgstr "" #. type: table #: doc/guix.texi:20668 msgid "The TCP port where the daemon waits for incoming connections." msgstr "" #. type: item #: doc/guix.texi:20669 #, no-wrap msgid "@code{syslog-output?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:20671 msgid "Whether to enable syslog output." msgstr "" #. type: item #: doc/guix.texi:20672 #, no-wrap msgid "@code{pid-file} (default: @code{\"/var/run/dropbear.pid\"})" msgstr "" #. type: table #: doc/guix.texi:20674 msgid "File name of the daemon's PID file." msgstr "" #. type: item #: doc/guix.texi:20675 #, no-wrap msgid "@code{root-login?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:20677 msgid "Whether to allow @code{root} logins." msgstr "" #. type: table #: doc/guix.texi:20680 msgid "Whether to allow empty passwords." msgstr "" #. type: table #: doc/guix.texi:20683 msgid "Whether to enable password-based authentication." msgstr "" #. type: cindex #: doc/guix.texi:20686 #, no-wrap msgid "AutoSSH" msgstr "" #. type: deffn #: doc/guix.texi:20687 #, no-wrap msgid "{Scheme Variable} autossh-service-type" msgstr "" #. type: deffn #: doc/guix.texi:20695 msgid "" "This is the type for the @uref{https://www.harding.motd.ca/autossh, AutoSSH} " "program that runs a copy of @command{ssh} and monitors it, restarting it as " "necessary should it die or stop passing traffic. AutoSSH can be run " "manually from the command-line by passing arguments to the binary " "@command{autossh} from the package @code{autossh}, but it can also be run as " "a Guix service. This latter use case is documented here." msgstr "" #. type: deffn #: doc/guix.texi:20699 msgid "" "AutoSSH can be used to forward local traffic to a remote machine using an " "SSH tunnel, and it respects the @file{~/.ssh/config} of the user it is run " "as." msgstr "" #. type: deffn #: doc/guix.texi:20704 msgid "" "For example, to specify a service running autossh as the user @code{pino} " "and forwarding all local connections to port @code{8081} to " "@code{remote:8081} using an SSH tunnel, add this call to the operating " "system's @code{services} field:" msgstr "" #. type: lisp #: doc/guix.texi:20710 #, no-wrap msgid "" "(service autossh-service-type\n" " (autossh-configuration\n" " (user \"pino\")\n" " (ssh-options (list \"-T\" \"-N\" \"-L\" \"8081:localhost:8081\" \"remote.net\"))))\n" msgstr "" #. type: deftp #: doc/guix.texi:20713 #, no-wrap msgid "{Data Type} autossh-configuration" msgstr "" #. type: deftp #: doc/guix.texi:20715 msgid "This data type represents the configuration of an AutoSSH service." msgstr "" #. type: item #: doc/guix.texi:20718 #, no-wrap msgid "@code{user} (default @code{\"autossh\"})" msgstr "" #. type: table #: doc/guix.texi:20721 msgid "" "The user as which the AutoSSH service is to be run. This assumes that the " "specified user exists." msgstr "" #. type: item #: doc/guix.texi:20722 #, no-wrap msgid "@code{poll} (default @code{600})" msgstr "" #. type: table #: doc/guix.texi:20724 msgid "Specifies the connection poll time in seconds." msgstr "" #. type: item #: doc/guix.texi:20725 #, no-wrap msgid "@code{first-poll} (default @code{#f})" msgstr "" #. type: table #: doc/guix.texi:20731 msgid "" "Specifies how many seconds AutoSSH waits before the first connection test. " "After this first test, polling is resumed at the pace defined in " "@code{poll}. When set to @code{#f}, the first poll is not treated specially " "and will also use the connection poll specified in @code{poll}." msgstr "" #. type: item #: doc/guix.texi:20732 #, no-wrap msgid "@code{gate-time} (default @code{30})" msgstr "" #. type: table #: doc/guix.texi:20735 msgid "" "Specifies how many seconds an SSH connection must be active before it is " "considered successful." msgstr "" #. type: item #: doc/guix.texi:20736 #, no-wrap msgid "@code{log-level} (default @code{1})" msgstr "" #. type: table #: doc/guix.texi:20739 msgid "" "The log level, corresponding to the levels used by syslog---so @code{0} is " "the most silent while @code{7} is the chattiest." msgstr "" #. type: item #: doc/guix.texi:20740 #, no-wrap msgid "@code{max-start} (default @code{#f})" msgstr "" #. type: table #: doc/guix.texi:20743 msgid "" "The maximum number of times SSH may be (re)started before AutoSSH exits. " "When set to @code{#f}, no maximum is configured and AutoSSH may restart " "indefinitely." msgstr "" #. type: item #: doc/guix.texi:20744 #, no-wrap msgid "@code{message} (default @code{\"\"})" msgstr "" #. type: table #: doc/guix.texi:20746 msgid "" "The message to append to the echo message sent when testing connections." msgstr "" #. type: item #: doc/guix.texi:20747 #, no-wrap msgid "@code{port} (default @code{\"0\"})" msgstr "" #. type: table #: doc/guix.texi:20757 msgid "" "The ports used for monitoring the connection. When set to @code{\"0\"}, " "monitoring is disabled. When set to @code{\"@var{n}\"} where @var{n} is a " "positive integer, ports @var{n} and @var{n}+1 are used for monitoring the " "connection, such that port @var{n} is the base monitoring port and @code{n" "+1} is the echo port. When set to @code{\"@var{n}:@var{m}\"} where @var{n} " "and @var{m} are positive integers, the ports @var{n} and @var{m} are used " "for monitoring the connection, such that port @var{n} is the base monitoring " "port and @var{m} is the echo port." msgstr "" #. type: item #: doc/guix.texi:20758 #, no-wrap msgid "@code{ssh-options} (default @code{'()})" msgstr "" #. type: table #: doc/guix.texi:20762 msgid "" "The list of command-line arguments to pass to @command{ssh} when it is run. " "Options @option{-f} and @option{-M} are reserved for AutoSSH and may cause " "undefined behaviour." msgstr "" #. type: cindex #: doc/guix.texi:20766 #, no-wrap msgid "WebSSH" msgstr "" #. type: deffn #: doc/guix.texi:20767 #, no-wrap msgid "{Scheme Variable} webssh-service-type" msgstr "" #. type: deffn #: doc/guix.texi:20773 msgid "" "This is the type for the @uref{https://webssh.huashengdun.org/, WebSSH} " "program that runs a web SSH client. WebSSH can be run manually from the " "command-line by passing arguments to the binary @command{wssh} from the " "package @code{webssh}, but it can also be run as a Guix service. This " "latter use case is documented here." msgstr "" #. type: deffn #: doc/guix.texi:20779 msgid "" "For example, to specify a service running WebSSH on loopback interface on " "port @code{8888} with reject policy with a list of allowed to connection " "hosts, and NGINX as a reverse-proxy to this service listening for HTTPS " "connection, add this call to the operating system's @code{services} field:" msgstr "" #. type: lisp #: doc/guix.texi:20787 #, no-wrap msgid "" "(service webssh-service-type\n" " (webssh-configuration (address \"127.0.0.1\")\n" " (port 8888)\n" " (policy 'reject)\n" " (known-hosts '(\"localhost ecdsa-sha2-nistp256 AAAA…\"\n" " \"127.0.0.1 ecdsa-sha2-nistp256 AAAA…\"))))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:20803 #, no-wrap msgid "" "(service nginx-service-type\n" " (nginx-configuration\n" " (server-blocks\n" " (list\n" " (nginx-server-configuration\n" " (inherit %webssh-configuration-nginx)\n" " (server-name '(\"webssh.example.com\"))\n" " (listen '(\"443 ssl\"))\n" " (ssl-certificate (letsencrypt-certificate \"webssh.example.com\"))\n" " (ssl-certificate-key (letsencrypt-key \"webssh.example.com\"))\n" " (locations\n" " (cons (nginx-location-configuration\n" " (uri \"/.well-known\")\n" " (body '(\"root /var/www;\")))\n" " (nginx-server-configuration-locations %webssh-configuration-nginx))))))))\n" msgstr "" #. type: deftp #: doc/guix.texi:20806 #, no-wrap msgid "{Data Type} webssh-configuration" msgstr "" #. type: deftp #: doc/guix.texi:20808 msgid "Data type representing the configuration for @code{webssh-service}." msgstr "" #. type: item #: doc/guix.texi:20810 #, no-wrap msgid "@code{package} (default: @var{webssh})" msgstr "" #. type: table #: doc/guix.texi:20812 msgid "@code{webssh} package to use." msgstr "" #. type: item #: doc/guix.texi:20813 #, no-wrap msgid "@code{user-name} (default: @var{\"webssh\"})" msgstr "" #. type: table #: doc/guix.texi:20816 msgid "" "User name or user ID that file transfers to and from that module should take " "place." msgstr "" #. type: item #: doc/guix.texi:20817 #, no-wrap msgid "@code{group-name} (default: @var{\"webssh\"})" msgstr "" #. type: item #: doc/guix.texi:20820 #, no-wrap msgid "@code{address} (default: @var{#f})" msgstr "" #. type: table #: doc/guix.texi:20822 msgid "IP address on which @command{webssh} listens for incoming connections." msgstr "" #. type: item #: doc/guix.texi:20823 #, no-wrap msgid "@code{port} (default: @var{8888})" msgstr "" #. type: table #: doc/guix.texi:20825 msgid "TCP port on which @command{webssh} listens for incoming connections." msgstr "" #. type: item #: doc/guix.texi:20826 #, no-wrap msgid "@code{policy} (default: @var{#f})" msgstr "" #. type: table #: doc/guix.texi:20828 msgid "" "Connection policy. @var{reject} policy requires to specify @var{known-" "hosts}." msgstr "" #. type: item #: doc/guix.texi:20829 #, no-wrap msgid "@code{known-hosts} (default: @var{'()})" msgstr "" #. type: table #: doc/guix.texi:20831 msgid "List of hosts which allowed for SSH connection from @command{webssh}." msgstr "" #. type: item #: doc/guix.texi:20832 #, no-wrap msgid "@code{log-file} (default: @file{\"/var/log/webssh.log\"})" msgstr "" #. type: table #: doc/guix.texi:20834 msgid "Name of the file where @command{webssh} writes its log file." msgstr "" #. type: item #: doc/guix.texi:20835 #, no-wrap msgid "@code{log-level} (default: @var{#f})" msgstr "" #. type: table #: doc/guix.texi:20837 msgid "Logging level." msgstr "" #. type: defvr #: doc/guix.texi:20841 #, no-wrap msgid "{Scheme Variable} %facebook-host-aliases" msgstr "" #. type: defvr #: doc/guix.texi:20847 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:20851 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: lisp #: doc/guix.texi:20864 #, 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:20868 msgid "" "This mechanism can prevent programs running locally, such as Web browsers, " "from accessing Facebook." msgstr "" #. type: Plain text #: doc/guix.texi:20871 msgid "The @code{(gnu services avahi)} provides the following definition." msgstr "" #. type: defvr #: doc/guix.texi:20872 #, no-wrap msgid "{Scheme Variable} avahi-service-type" msgstr "" #. type: defvr #: doc/guix.texi:20877 msgid "" "This is the service that runs @command{avahi-daemon}, a system-wide mDNS/DNS-" "SD responder that allows for service discovery and ``zero-configuration'' " "host name lookups (see @uref{https://avahi.org/}). Its value must be an " "@code{avahi-configuration} record---see below." msgstr "" #. type: defvr #: doc/guix.texi:20882 msgid "" "This service extends the name service cache daemon (nscd) so that it can " "resolve @code{.local} host names using @uref{https://0pointer.de/lennart/" "projects/nss-mdns/, nss-mdns}. @xref{Name Service Switch}, for information " "on host name resolution." msgstr "" #. type: defvr #: doc/guix.texi:20885 msgid "" "Additionally, add the @var{avahi} package to the system profile so that " "commands such as @command{avahi-browse} are directly usable." msgstr "" #. type: deftp #: doc/guix.texi:20887 #, no-wrap msgid "{Data Type} avahi-configuration" msgstr "" #. type: deftp #: doc/guix.texi:20889 msgid "Data type representation the configuration for Avahi." msgstr "" #. type: item #: doc/guix.texi:20892 doc/guix.texi:31919 #, no-wrap msgid "@code{host-name} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:20895 msgid "" "If different from @code{#f}, use that as the host name to publish for this " "machine; otherwise, use the machine's actual host name." msgstr "" #. type: item #: doc/guix.texi:20896 doc/guix.texi:32114 #, no-wrap msgid "@code{publish?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:20899 msgid "" "When true, allow host names and services to be published (broadcast) over " "the network." msgstr "" #. type: item #: doc/guix.texi:20900 #, no-wrap msgid "@code{publish-workstation?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:20904 msgid "" "When true, @command{avahi-daemon} publishes the machine's host name and IP " "address via mDNS on the local network. To view the host names published on " "your local network, you can run:" msgstr "" #. type: example #: doc/guix.texi:20907 #, no-wrap msgid "avahi-browse _workstation._tcp\n" msgstr "" #. type: item #: doc/guix.texi:20909 #, no-wrap msgid "@code{wide-area?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:20911 msgid "When true, DNS-SD over unicast DNS is enabled." msgstr "" #. type: item #: doc/guix.texi:20912 #, no-wrap msgid "@code{ipv4?} (default: @code{#t})" msgstr "" #. type: itemx #: doc/guix.texi:20913 #, no-wrap msgid "@code{ipv6?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:20915 msgid "These fields determine whether to use IPv4/IPv6 sockets." msgstr "" #. type: item #: doc/guix.texi:20916 #, no-wrap msgid "@code{domains-to-browse} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:20918 msgid "This is a list of domains to browse." msgstr "" #. type: deffn #: doc/guix.texi:20921 #, no-wrap msgid "{Scheme Variable} openvswitch-service-type" msgstr "" #. type: deffn #: doc/guix.texi:20925 msgid "" "This is the type of the @uref{https://www.openvswitch.org, Open vSwitch} " "service, whose value should be an @code{openvswitch-configuration} object." msgstr "" #. type: deftp #: doc/guix.texi:20927 #, no-wrap msgid "{Data Type} openvswitch-configuration" msgstr "" #. type: deftp #: doc/guix.texi:20931 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:20933 #, no-wrap msgid "@code{package} (default: @var{openvswitch})" msgstr "" #. type: table #: doc/guix.texi:20935 msgid "Package object of the Open vSwitch." msgstr "" #. type: defvr #: doc/guix.texi:20939 #, no-wrap msgid "{Scheme Variable} pagekite-service-type" msgstr "" #. type: defvr #: doc/guix.texi:20944 msgid "" "This is the service type for the @uref{https://pagekite.net, PageKite} " "service, a tunneling solution for making localhost servers publicly visible, " "even from behind restrictive firewalls or NAT without forwarded ports. The " "value for this service type is a @code{pagekite-configuration} record." msgstr "" #. type: defvr #: doc/guix.texi:20946 msgid "Here's an example exposing the local HTTP and SSH daemons:" msgstr "" #. type: lisp #: doc/guix.texi:20953 #, no-wrap msgid "" "(service pagekite-service-type\n" " (pagekite-configuration\n" " (kites '(\"http:@@kitename:localhost:80:@@kitesecret\"\n" " \"raw/22:@@kitename:localhost:22:@@kitesecret\"))\n" " (extra-file \"/etc/pagekite.rc\")))\n" msgstr "" #. type: deftp #: doc/guix.texi:20956 #, no-wrap msgid "{Data Type} pagekite-configuration" msgstr "" #. type: deftp #: doc/guix.texi:20958 msgid "Data type representing the configuration of PageKite." msgstr "" #. type: item #: doc/guix.texi:20960 #, no-wrap msgid "@code{package} (default: @var{pagekite})" msgstr "" #. type: table #: doc/guix.texi:20962 msgid "Package object of PageKite." msgstr "" #. type: item #: doc/guix.texi:20963 #, no-wrap msgid "@code{kitename} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:20965 msgid "PageKite name for authenticating to the frontend server." msgstr "" #. type: item #: doc/guix.texi:20966 #, no-wrap msgid "@code{kitesecret} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:20969 msgid "" "Shared secret for authenticating to the frontend server. You should " "probably put this inside @code{extra-file} instead." msgstr "" #. type: item #: doc/guix.texi:20970 #, no-wrap msgid "@code{frontend} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:20973 msgid "" "Connect to the named PageKite frontend server instead of the @uref{https://" "pagekite.net,,pagekite.net} service." msgstr "" #. type: item #: doc/guix.texi:20974 #, no-wrap msgid "@code{kites} (default: @code{'(\"http:@@kitename:localhost:80:@@kitesecret\")})" msgstr "" #. type: table #: doc/guix.texi:20977 msgid "" "List of service kites to use. Exposes HTTP on port 80 by default. The " "format is @code{proto:kitename:host:port:secret}." msgstr "" #. type: item #: doc/guix.texi:20978 #, no-wrap msgid "@code{extra-file} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:20981 msgid "" "Extra configuration file to read, which you are expected to create " "manually. Use this to add additional options and manage shared secrets out-" "of-band." msgstr "" #. type: defvr #: doc/guix.texi:20985 #, no-wrap msgid "{Scheme Variable} yggdrasil-service-type" msgstr "" #. type: defvr #: doc/guix.texi:20989 msgid "" "The service type for connecting to the @uref{https://yggdrasil-network." "github.io/, Yggdrasil network}, an early-stage implementation of a fully end-" "to-end encrypted IPv6 network." msgstr "" #. type: quotation #: doc/guix.texi:20996 msgid "" "Yggdrasil provides name-independent routing with cryptographically generated " "addresses. Static addressing means you can keep the same address as long as " "you want, even if you move to a new location, or generate a new address (by " "generating new keys) whenever you want. @uref{https://yggdrasil-network." "github.io/2018/07/28/addressing.html}" msgstr "" #. type: defvr #: doc/guix.texi:21000 msgid "" "Pass it a value of @code{yggdrasil-configuration} to connect it to public " "peers and/or local peers." msgstr "" #. type: defvr #: doc/guix.texi:21004 msgid "" "Here is an example using public peers and a static address. The static " "signing and encryption keys are defined in @file{/etc/yggdrasil-private." "conf} (the default value for @code{config-file})." msgstr "" #. type: lisp #: doc/guix.texi:21016 #, no-wrap msgid "" ";; part of the operating-system declaration\n" "(service yggdrasil-service-type\n" " (yggdrasil-configuration\n" " (autoconf? #f) ;; use only the public peers\n" " (json-config\n" " ;; choose one from\n" " ;; https://github.com/yggdrasil-network/public-peers\n" " '((peers . #(\"tcp://1.2.3.4:1337\"))))\n" " ;; /etc/yggdrasil-private.conf is the default value for config-file\n" " ))\n" msgstr "" #. type: example #: doc/guix.texi:21023 #, no-wrap msgid "" "# sample content for /etc/yggdrasil-private.conf\n" "@{\n" " # Your public key. Your peers may ask you for this to put\n" " # into their AllowedPublicKeys configuration.\n" " PublicKey: 64277...\n" "\n" msgstr "" #. type: example #: doc/guix.texi:21027 #, no-wrap msgid "" " # Your private key. DO NOT share this with anyone!\n" " PrivateKey: 5c750...\n" "@}\n" msgstr "" #. type: deftp #: doc/guix.texi:21030 #, no-wrap msgid "{Data Type} yggdrasil-configuration" msgstr "" #. type: deftp #: doc/guix.texi:21032 msgid "Data type representing the configuration of Yggdrasil." msgstr "" #. type: item #: doc/guix.texi:21034 #, no-wrap msgid "@code{package} (default: @code{yggdrasil})" msgstr "" #. type: table #: doc/guix.texi:21036 msgid "Package object of Yggdrasil." msgstr "" #. type: item #: doc/guix.texi:21037 #, no-wrap msgid "@code{json-config} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:21043 msgid "" "Contents of @file{/etc/yggdrasil.conf}. Will be merged with @file{/etc/" "yggdrasil-private.conf}. Note that these settings are stored in the Guix " "store, which is readable to all users. @strong{Do not store your private " "keys in it}. See the output of @code{yggdrasil -genconf} for a quick " "overview of valid keys and their default values." msgstr "" #. type: item #: doc/guix.texi:21044 #, no-wrap msgid "@code{autoconf?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:21047 msgid "" "Whether to use automatic mode. Enabling it makes Yggdrasil use adynamic IP " "and peer with IPv6 neighbors." msgstr "" #. type: table #: doc/guix.texi:21050 msgid "How much detail to include in logs. Use @code{'debug} for more detail." msgstr "" #. type: item #: doc/guix.texi:21051 #, no-wrap msgid "@code{log-to} (default: @code{'stdout})" msgstr "" #. type: table #: doc/guix.texi:21055 msgid "" "Where to send logs. By default, the service logs standard output to @file{/" "var/log/yggdrasil.log}. The alternative is @code{'syslog}, which sends " "output to the running syslog service." msgstr "" #. type: item #: doc/guix.texi:21056 #, no-wrap msgid "@code{config-file} (default: @code{\"/etc/yggdrasil-private.conf\"})" msgstr "" #. type: table #: doc/guix.texi:21063 msgid "" "What HJSON file to load sensitive data from. This is where private keys " "should be stored, which are necessary to specify if you don't want a " "randomized address after each restart. Use @code{#f} to disable. Options " "defined in this file take precedence over @code{json-config}. Use the " "output of @code{yggdrasil -genconf} as a starting point. To configure a " "static address, delete everything except these options:" msgstr "" #. type: code{#1} #: doc/guix.texi:21065 #, no-wrap msgid "EncryptionPublicKey" msgstr "" #. type: code{#1} #: doc/guix.texi:21066 #, no-wrap msgid "EncryptionPrivateKey" msgstr "" #. type: code{#1} #: doc/guix.texi:21067 #, no-wrap msgid "SigningPublicKey" msgstr "" #. type: code{#1} #: doc/guix.texi:21068 #, no-wrap msgid "SigningPrivateKey" msgstr "" #. type: cindex #: doc/guix.texi:21073 #, no-wrap msgid "IPFS" msgstr "" #. type: defvr #: doc/guix.texi:21074 #, no-wrap msgid "{Scheme Variable} ipfs-service-type" msgstr "" #. type: defvr #: doc/guix.texi:21078 msgid "" "The service type for connecting to the @uref{https://ipfs.io,IPFS network}, " "a global, versioned, peer-to-peer file system. Pass it a @code{ipfs-" "configuration} to change the ports used for the gateway and API." msgstr "" #. type: defvr #: doc/guix.texi:21080 msgid "Here's an example configuration, using some non-standard ports:" msgstr "" #. type: lisp #: doc/guix.texi:21086 #, no-wrap msgid "" "(service ipfs-service-type\n" " (ipfs-configuration\n" " (gateway \"/ip4/127.0.0.1/tcp/8880\")\n" " (api \"/ip4/127.0.0.1/tcp/8881\")))\n" msgstr "" #. type: deftp #: doc/guix.texi:21089 #, no-wrap msgid "{Data Type} ipfs-configuration" msgstr "" #. type: deftp #: doc/guix.texi:21091 msgid "Data type representing the configuration of IPFS." msgstr "" #. type: item #: doc/guix.texi:21093 #, no-wrap msgid "@code{package} (default: @code{go-ipfs})" msgstr "" #. type: table #: doc/guix.texi:21095 msgid "Package object of IPFS." msgstr "" #. type: item #: doc/guix.texi:21096 #, no-wrap msgid "@code{gateway} (default: @code{\"/ip4/127.0.0.1/tcp/8082\"})" msgstr "" #. type: table #: doc/guix.texi:21098 msgid "Address of the gateway, in ‘multiaddress’ format." msgstr "" #. type: item #: doc/guix.texi:21099 #, no-wrap msgid "@code{api} (default: @code{\"/ip4/127.0.0.1/tcp/5001\"})" msgstr "" #. type: table #: doc/guix.texi:21101 msgid "Address of the API endpoint, in ‘multiaddress’ format." msgstr "" #. type: cindex #: doc/guix.texi:21104 #, no-wrap msgid "keepalived" msgstr "" #. type: deffn #: doc/guix.texi:21105 #, no-wrap msgid "{Scheme Variable} keepalived-service-type" msgstr "" #. type: deffn #: doc/guix.texi:21110 msgid "" "This is the type for the @uref{https://www.keepalived.org/, Keepalived} " "routing software, @command{keepalived}. Its value must be an " "@code{keepalived-configuration} record as in this example for master machine:" msgstr "" #. type: lisp #: doc/guix.texi:21115 #, no-wrap msgid "" "(service keepalived-service-type\n" " (keepalived-configuration\n" " (config-file (local-file \"keepalived-master.conf\"))))\n" msgstr "" #. type: deffn #: doc/guix.texi:21118 msgid "where @file{keepalived-master.conf}:" msgstr "" #. type: example #: doc/guix.texi:21130 #, no-wrap msgid "" "vrrp_instance my-group @{\n" " state MASTER\n" " interface enp9s0\n" " virtual_router_id 100\n" " priority 100\n" " unicast_peer @{ 10.0.0.2 @}\n" " virtual_ipaddress @{\n" " 10.0.0.4/24\n" " @}\n" "@}\n" msgstr "" #. type: deffn #: doc/guix.texi:21133 msgid "and for backup machine:" msgstr "" #. type: lisp #: doc/guix.texi:21138 #, no-wrap msgid "" "(service keepalived-service-type\n" " (keepalived-configuration\n" " (config-file (local-file \"keepalived-backup.conf\"))))\n" msgstr "" #. type: deffn #: doc/guix.texi:21141 msgid "where @file{keepalived-backup.conf}:" msgstr "" #. type: example #: doc/guix.texi:21153 #, no-wrap msgid "" "vrrp_instance my-group @{\n" " state BACKUP\n" " interface enp9s0\n" " virtual_router_id 100\n" " priority 99\n" " unicast_peer @{ 10.0.0.3 @}\n" " virtual_ipaddress @{\n" " 10.0.0.4/24\n" " @}\n" "@}\n" msgstr "" #. type: cindex #: doc/guix.texi:21159 #, no-wrap msgid "unattended upgrades" msgstr "" #. type: cindex #: doc/guix.texi:21160 #, no-wrap msgid "upgrades, unattended" msgstr "" #. type: Plain text #: doc/guix.texi:21165 msgid "" "Guix provides a service to perform @emph{unattended upgrades}: periodically, " "the system automatically reconfigures itself from the latest Guix. Guix " "System has several properties that make unattended upgrades safe:" msgstr "" #. type: itemize #: doc/guix.texi:21170 msgid "" "upgrades are transactional (either the upgrade succeeds or it fails, but you " "cannot end up with an ``in-between'' system state);" msgstr "" #. type: itemize #: doc/guix.texi:21174 msgid "" "the upgrade log is kept---you can view it with @command{guix system list-" "generations}---and you can roll back to any previous generation, should the " "upgraded system fail to behave as intended;" msgstr "" #. type: itemize #: doc/guix.texi:21177 msgid "" "channel code is authenticated so you know you can only run genuine code " "(@pxref{Channels});" msgstr "" #. type: itemize #: doc/guix.texi:21180 msgid "" "@command{guix system reconfigure} prevents downgrades, which makes it immune " "to @dfn{downgrade attacks}." msgstr "" #. type: Plain text #: doc/guix.texi:21185 msgid "" "To set up unattended upgrades, add an instance of @code{unattended-upgrade-" "service-type} like the one below to the list of your operating system " "services:" msgstr "" #. type: lisp #: doc/guix.texi:21188 #, no-wrap msgid "(service unattended-upgrade-service-type)\n" msgstr "" #. type: Plain text #: doc/guix.texi:21195 msgid "" "The defaults above set up weekly upgrades: every Sunday at midnight. You do " "not need to provide the operating system configuration file: it uses @file{/" "run/current-system/configuration.scm}, which ensures it always uses your " "latest configuration---@pxref{provenance-service-type}, for more information " "about this file." msgstr "" #. type: Plain text #: doc/guix.texi:21201 msgid "" "There are several things that can be configured, in particular the " "periodicity and services (daemons) to be restarted upon completion. When " "the upgrade is successful, the service takes care of deleting system " "generations older that some threshold, as per @command{guix system delete-" "generations}. See the reference below for details." msgstr "" #. type: Plain text #: doc/guix.texi:21205 msgid "" "To ensure that upgrades are actually happening, you can run @command{guix " "system describe}. To investigate upgrade failures, visit the unattended " "upgrade log file (see below)." msgstr "" #. type: defvr #: doc/guix.texi:21206 #, no-wrap msgid "{Scheme Variable} unattended-upgrade-service-type" msgstr "" #. type: defvr #: doc/guix.texi:21210 msgid "" "This is the service type for unattended upgrades. It sets up an mcron job " "(@pxref{Scheduled Job Execution}) that runs @command{guix system " "reconfigure} from the latest version of the specified channels." msgstr "" #. type: defvr #: doc/guix.texi:21213 msgid "" "Its value must be a @code{unattended-upgrade-configuration} record (see " "below)." msgstr "" #. type: deftp #: doc/guix.texi:21215 #, no-wrap msgid "{Data Type} unattended-upgrade-configuration" msgstr "" #. type: deftp #: doc/guix.texi:21218 msgid "" "This data type represents the configuration of the unattended upgrade " "service. The following fields are available:" msgstr "" #. type: item #: doc/guix.texi:21220 #, no-wrap msgid "@code{schedule} (default: @code{\"30 01 * * 0\"})" msgstr "" #. type: table #: doc/guix.texi:21224 msgid "" "This is the schedule of upgrades, expressed as a gexp containing an mcron " "job schedule (@pxref{Guile Syntax, mcron job specifications,, mcron, " "GNU@tie{}mcron})." msgstr "" #. type: item #: doc/guix.texi:21225 #, no-wrap msgid "@code{channels} (default: @code{#~%default-channels})" msgstr "" #. type: table #: doc/guix.texi:21229 msgid "" "This gexp specifies the channels to use for the upgrade (@pxref{Channels}). " "By default, the tip of the official @code{guix} channel is used." msgstr "" #. type: item #: doc/guix.texi:21230 #, no-wrap msgid "@code{operating-system-file} (default: @code{\"/run/current-system/configuration.scm\"})" msgstr "" #. type: table #: doc/guix.texi:21233 msgid "" "This field specifies the operating system configuration file to use. The " "default is to reuse the config file of the current configuration." msgstr "" #. type: table #: doc/guix.texi:21239 msgid "" "There are cases, though, where referring to @file{/run/current-system/" "configuration.scm} is not enough, for instance because that file refers to " "extra files (SSH public keys, extra configuration files, etc.) @i{via} " "@code{local-file} and similar constructs. For those cases, we recommend " "something along these lines:" msgstr "" #. type: lisp #: doc/guix.texi:21245 #, no-wrap msgid "" "(unattended-upgrade-configuration\n" " (operating-system-file\n" " (file-append (local-file \".\" \"config-dir\" #:recursive? #t)\n" " \"/config.scm\")))\n" msgstr "" #. type: table #: doc/guix.texi:21252 msgid "" "The effect here is to import all of the current directory into the store, " "and to refer to @file{config.scm} within that directory. Therefore, uses of " "@code{local-file} within @file{config.scm} will work as expected. @xref{G-" "Expressions}, for information about @code{local-file} and @code{file-append}." msgstr "" #. type: item #: doc/guix.texi:21253 #, no-wrap msgid "@code{services-to-restart} (default: @code{'(mcron)})" msgstr "" #. type: table #: doc/guix.texi:21256 msgid "" "This field specifies the Shepherd services to restart when the upgrade " "completes." msgstr "" #. type: table #: doc/guix.texi:21263 msgid "" "Those services are restarted right away upon completion, as with " "@command{herd restart}, which ensures that the latest version is running---" "remember that by default @command{guix system reconfigure} only restarts " "services that are not currently running, which is conservative: it minimizes " "disruption but leaves outdated services running." msgstr "" #. type: table #: doc/guix.texi:21267 msgid "" "Use @command{herd status} to find out candidates for restarting. " "@xref{Services}, for general information about services. Common services to " "restart would include @code{ntpd} and @code{ssh-daemon}." msgstr "" #. type: table #: doc/guix.texi:21270 msgid "" "By default, the @code{mcron} service is restarted. This ensures that the " "latest version of the unattended upgrade job will be used next time." msgstr "" #. type: item #: doc/guix.texi:21271 #, no-wrap msgid "@code{system-expiration} (default: @code{(* 3 30 24 3600)})" msgstr "" #. type: table #: doc/guix.texi:21275 msgid "" "This is the expiration time in seconds for system generations. System " "generations older that this amount of time are deleted with @command{guix " "system delete-generations} when an upgrade completes." msgstr "" #. type: quotation #: doc/guix.texi:21280 msgid "" "The unattended upgrade service does not run the garbage collector. You will " "probably want to set up your own mcron job to run @command{guix gc} " "periodically." msgstr "" #. type: item #: doc/guix.texi:21282 #, no-wrap msgid "@code{maximum-duration} (default: @code{3600})" msgstr "" #. type: table #: doc/guix.texi:21285 msgid "" "Maximum duration in seconds for the upgrade; past that time, the upgrade " "aborts." msgstr "" #. type: table #: doc/guix.texi:21288 msgid "" "This is primarily useful to ensure the upgrade does not end up rebuilding or " "re-downloading ``the world''." msgstr "" #. type: item #: doc/guix.texi:21289 #, no-wrap msgid "@code{log-file} (default: @code{\"/var/log/unattended-upgrade.log\"})" msgstr "" #. type: table #: doc/guix.texi:21291 msgid "File where unattended upgrades are logged." msgstr "" #. type: cindex #: doc/guix.texi:21297 #, no-wrap msgid "X11" msgstr "" #. type: cindex #: doc/guix.texi:21298 #, no-wrap msgid "X Window System" msgstr "" #. type: cindex #: doc/guix.texi:21299 doc/guix.texi:21495 #, no-wrap msgid "login manager" msgstr "" #. type: Plain text #: doc/guix.texi:21304 msgid "" "Support for the X Window graphical display system---specifically Xorg---is " "provided by the @code{(gnu services xorg)} module. Note that there is no " "@code{xorg-service} procedure. Instead, the X server is started by the " "@dfn{login manager}, by default the GNOME Display Manager (GDM)." msgstr "" #. type: cindex #: doc/guix.texi:21305 #, no-wrap msgid "GDM" msgstr "" #. type: cindex #: doc/guix.texi:21306 #, no-wrap msgid "GNOME, login manager" msgstr "" #. type: anchor{#1} #: doc/guix.texi:21311 msgid "gdm" msgstr "" #. type: Plain text #: doc/guix.texi:21311 msgid "" "GDM of course allows users to log in into window managers and desktop " "environments other than GNOME; for those using GNOME, GDM is required for " "features such as automatic screen locking." msgstr "" #. type: cindex #: doc/guix.texi:21312 #, no-wrap msgid "window manager" msgstr "" #. type: Plain text #: doc/guix.texi:21317 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: anchor{#1} #: doc/guix.texi:21323 msgid "wayland-gdm" msgstr "" #. type: Plain text #: doc/guix.texi:21323 msgid "" "GDM also supports Wayland: it can itself use Wayland instead of X11 for its " "user interface, and it can also start Wayland sessions. The former is " "required for the latter, to enable, set @code{wayland?} to @code{#t} in " "@code{gdm-configuration}." msgstr "" #. type: defvr #: doc/guix.texi:21324 #, no-wrap msgid "{Scheme Variable} gdm-service-type" msgstr "" #. type: defvr #: doc/guix.texi:21329 msgid "" "This is the type for the @uref{https://wiki.gnome.org/Projects/GDM/, GNOME " "Desktop Manager} (GDM), a program that manages graphical display servers and " "handles graphical user logins. Its value must be a @code{gdm-configuration} " "(see below)." msgstr "" #. type: cindex #: doc/guix.texi:21330 #, no-wrap msgid "session types" msgstr "" #. type: defvr #: doc/guix.texi:21338 msgid "" "GDM looks for @dfn{session types} described by the @file{.desktop} files in " "@file{/run/current-system/profile/share/xsessions} (for X11 sessions) and " "@file{/run/current-system/profile/share/wayland-sessions} (for Wayland " "sessions) and allows users to choose a session from the log-in screen. " "Packages such as @code{gnome}, @code{xfce}, @code{i3} and @code{sway} " "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:21342 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:21344 #, no-wrap msgid "{Data Type} gdm-configuration" msgstr "" #. type: item #: doc/guix.texi:21346 doc/guix.texi:21440 #, no-wrap msgid "@code{auto-login?} (default: @code{#f})" msgstr "" #. type: itemx #: doc/guix.texi:21347 #, no-wrap msgid "@code{default-user} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:21349 msgid "When @code{auto-login?} is false, GDM presents a log-in screen." msgstr "" #. type: table #: doc/guix.texi:21352 msgid "" "When @code{auto-login?} is true, GDM logs in directly as @code{default-user}." msgstr "" #. type: item #: doc/guix.texi:21353 #, no-wrap msgid "@code{auto-suspend?} (default @code{#t})" msgstr "" #. type: table #: doc/guix.texi:21358 msgid "" "When true, GDM will automatically suspend to RAM when nobody is physically " "connected. When a machine is used via remote desktop or SSH, this should be " "set to false to avoid GDM interrupting remote sessions or rendering the " "machine unavailable." msgstr "" #. type: item #: doc/guix.texi:21359 doc/guix.texi:27980 doc/guix.texi:29611 #: doc/guix.texi:34302 doc/guix.texi:34331 doc/guix.texi:34360 #: doc/guix.texi:34387 doc/guix.texi:34442 doc/guix.texi:34467 #: doc/guix.texi:34494 doc/guix.texi:34520 doc/guix.texi:34562 #, no-wrap msgid "@code{debug?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:21361 msgid "When true, GDM writes debug messages to its log." msgstr "" #. type: item #: doc/guix.texi:21362 #, no-wrap msgid "@code{gnome-shell-assets} (default: ...)" msgstr "" #. type: table #: doc/guix.texi:21364 msgid "List of GNOME Shell assets needed by GDM: icon theme, fonts, etc." msgstr "" #. type: item #: doc/guix.texi:21365 #, no-wrap msgid "@code{xorg-configuration} (default: @code{(xorg-configuration)})" msgstr "" #. type: table #: doc/guix.texi:21367 doc/guix.texi:21467 doc/guix.texi:21572 msgid "Configuration of the Xorg graphical server." msgstr "" #. type: item #: doc/guix.texi:21368 #, no-wrap msgid "@code{x-session} (default: @code{(xinitrc)})" msgstr "" #. type: table #: doc/guix.texi:21370 doc/guix.texi:21587 msgid "Script to run before starting a X session." msgstr "" #. type: item #: doc/guix.texi:21371 #, no-wrap msgid "@code{xdmcp?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:21376 msgid "" "When true, enable the X Display Manager Control Protocol (XDMCP). This " "should only be enabled in trusted environments, as the protocol is not " "secure. When enabled, GDM listens for XDMCP queries on the UDP port 177." msgstr "" #. type: item #: doc/guix.texi:21377 #, no-wrap msgid "@code{dbus-daemon} (default: @code{dbus-daemon-wrapper})" msgstr "" #. type: table #: doc/guix.texi:21379 msgid "File name of the @code{dbus-daemon} executable." msgstr "" #. type: item #: doc/guix.texi:21380 #, no-wrap msgid "@code{gdm} (default: @code{gdm})" msgstr "" #. type: table #: doc/guix.texi:21382 msgid "The GDM package to use." msgstr "" #. type: item #: doc/guix.texi:21383 #, no-wrap msgid "@code{wayland?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:21385 msgid "When true, enables Wayland in GDM, necessary to use Wayland sessions." msgstr "" #. type: item #: doc/guix.texi:21386 #, no-wrap msgid "@code{wayland-session} (default: @code{gdm-wayland-session-wrapper})" msgstr "" #. type: table #: doc/guix.texi:21389 msgid "The Wayland session wrapper to use, needed to setup the environment." msgstr "" #. type: defvr #: doc/guix.texi:21392 #, no-wrap msgid "{Scheme Variable} slim-service-type" msgstr "" #. type: defvr #: doc/guix.texi:21394 msgid "This is the type for the SLiM graphical login manager for X11." msgstr "" #. type: defvr #: doc/guix.texi:21398 msgid "" "Like GDM, SLiM looks for session types described by @file{.desktop} files " "and allows users to choose a session from the log-in screen using @kbd{F1}. " "It also honors @file{~/.xsession} files." msgstr "" #. type: defvr #: doc/guix.texi:21405 msgid "" "Unlike GDM, SLiM does not spawn the user session on a different VT after " "logging in, which means that you can only start one graphical session. If " "you want to be able to run multiple graphical sessions at the same time you " "have to add multiple SLiM services to your system services. The following " "example shows how to replace the default GDM service with two SLiM services " "on tty7 and tty8." msgstr "" #. type: lisp #: doc/guix.texi:21410 #, no-wrap msgid "" "(use-modules (gnu services)\n" " (gnu services desktop)\n" " (gnu services xorg))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:21421 #, no-wrap msgid "" "(operating-system\n" " ;; ...\n" " (services (cons* (service slim-service-type (slim-configuration\n" " (display \":0\")\n" " (vt \"vt7\")))\n" " (service slim-service-type (slim-configuration\n" " (display \":1\")\n" " (vt \"vt8\")))\n" " (modify-services %desktop-services\n" " (delete gdm-service-type)))))\n" msgstr "" #. type: deftp #: doc/guix.texi:21425 #, no-wrap msgid "{Data Type} slim-configuration" msgstr "" #. type: deftp #: doc/guix.texi:21427 msgid "Data type representing the configuration of @code{slim-service-type}." msgstr "" #. type: table #: doc/guix.texi:21431 msgid "Whether to allow logins with empty passwords." msgstr "" #. type: item #: doc/guix.texi:21432 #, no-wrap msgid "@code{gnupg?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:21439 msgid "" "If enabled, @code{pam-gnupg} will attempt to automatically unlock the user's " "GPG keys with the login password via @code{gpg-agent}. The keygrips of all " "keys to be unlocked should be written to @file{~/.pam-gnupg}, and can be " "queried with @code{gpg -K --with-keygrip}. Presetting passphrases must be " "enabled by adding @code{allow-preset-passphrase} in @file{~/.gnupg/gpg-agent." "conf}." msgstr "" #. type: itemx #: doc/guix.texi:21441 #, no-wrap msgid "@code{default-user} (default: @code{\"\"})" msgstr "" #. type: table #: doc/guix.texi:21443 msgid "When @code{auto-login?} is false, SLiM presents a log-in screen." msgstr "" #. type: table #: doc/guix.texi:21446 msgid "" "When @code{auto-login?} is true, SLiM logs in directly as @code{default-" "user}." msgstr "" #. type: item #: doc/guix.texi:21447 #, no-wrap msgid "@code{theme} (default: @code{%default-slim-theme})" msgstr "" #. type: itemx #: doc/guix.texi:21448 #, no-wrap msgid "@code{theme-name} (default: @code{%default-slim-theme-name})" msgstr "" #. type: table #: doc/guix.texi:21450 msgid "The graphical theme to use and its name." msgstr "" #. type: item #: doc/guix.texi:21451 #, no-wrap msgid "@code{auto-login-session} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:21454 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:21458 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:21463 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:21465 doc/guix.texi:21570 #, no-wrap msgid "@code{xorg-configuration} (default @code{(xorg-configuration)})" msgstr "" #. type: item #: doc/guix.texi:21468 #, no-wrap msgid "@code{display} (default @code{\":0\"})" msgstr "" #. type: table #: doc/guix.texi:21470 msgid "The display on which to start the Xorg graphical server." msgstr "" #. type: item #: doc/guix.texi:21471 #, no-wrap msgid "@code{vt} (default @code{\"vt7\"})" msgstr "" #. type: table #: doc/guix.texi:21473 msgid "The VT on which to start the Xorg graphical server." msgstr "" #. type: item #: doc/guix.texi:21474 #, no-wrap msgid "@code{xauth} (default: @code{xauth})" msgstr "" #. type: table #: doc/guix.texi:21476 msgid "The XAuth package to use." msgstr "" #. type: item #: doc/guix.texi:21477 #, no-wrap msgid "@code{shepherd} (default: @code{shepherd})" msgstr "" #. type: table #: doc/guix.texi:21480 msgid "" "The Shepherd package used when invoking @command{halt} and @command{reboot}." msgstr "" #. type: item #: doc/guix.texi:21481 #, no-wrap msgid "@code{sessreg} (default: @code{sessreg})" msgstr "" #. type: table #: doc/guix.texi:21483 msgid "The sessreg package used in order to register the session." msgstr "" #. type: item #: doc/guix.texi:21484 #, no-wrap msgid "@code{slim} (default: @code{slim})" msgstr "" #. type: table #: doc/guix.texi:21486 msgid "The SLiM package to use." msgstr "" #. type: defvr #: doc/guix.texi:21489 #, no-wrap msgid "{Scheme Variable} %default-theme" msgstr "" #. type: defvrx #: doc/guix.texi:21490 #, no-wrap msgid "{Scheme Variable} %default-theme-name" msgstr "" #. type: defvr #: doc/guix.texi:21492 msgid "The default SLiM theme and its name." msgstr "" #. type: cindex #: doc/guix.texi:21496 #, no-wrap msgid "X11 login" msgstr "" #. type: defvr #: doc/guix.texi:21497 #, no-wrap msgid "{Scheme Variable} sddm-service-type" msgstr "" #. type: defvr #: doc/guix.texi:21501 msgid "" "This is the type of the service to run the @uref{https://github.com/sddm/" "sddm,SDDM display manager}. Its value must be a @code{sddm-configuration} " "record (see below)." msgstr "" #. type: defvr #: doc/guix.texi:21503 msgid "Here's an example use:" msgstr "" #. type: lisp #: doc/guix.texi:21509 #, no-wrap msgid "" "(service sddm-service-type\n" " (sddm-configuration\n" " (auto-login-user \"alice\")\n" " (auto-login-session \"xfce.desktop\")))\n" msgstr "" #. type: deftp #: doc/guix.texi:21512 #, no-wrap msgid "{Data Type} sddm-configuration" msgstr "" #. type: deftp #: doc/guix.texi:21515 msgid "" "This data type represents the configuration of the SDDM login manager. The " "available fields are:" msgstr "" #. type: item #: doc/guix.texi:21517 #, no-wrap msgid "@code{sddm} (default: @code{sddm})" msgstr "" #. type: table #: doc/guix.texi:21519 msgid "The SDDM package to use." msgstr "" #. type: item #: doc/guix.texi:21520 #, no-wrap msgid "@code{display-server} (default: \"x11\")" msgstr "" #. type: table #: doc/guix.texi:21523 msgid "" "Select display server to use for the greeter. Valid values are " "@samp{\"x11\"} or @samp{\"wayland\"}." msgstr "" #. type: item #: doc/guix.texi:21524 #, no-wrap msgid "@code{numlock} (default: \"on\")" msgstr "" #. type: table #: doc/guix.texi:21526 msgid "Valid values are @samp{\"on\"}, @samp{\"off\"} or @samp{\"none\"}." msgstr "" #. type: item #: doc/guix.texi:21527 #, no-wrap msgid "@code{halt-command} (default @code{#~(string-append #$shepherd \"/sbin/halt\")})" msgstr "" #. type: table #: doc/guix.texi:21529 msgid "Command to run when halting." msgstr "" #. type: item #: doc/guix.texi:21530 #, no-wrap msgid "@code{reboot-command} (default @code{#~(string-append #$shepherd \"/sbin/reboot\")})" msgstr "" #. type: table #: doc/guix.texi:21532 msgid "Command to run when rebooting." msgstr "" #. type: item #: doc/guix.texi:21533 #, no-wrap msgid "@code{theme} (default \"maldives\")" msgstr "" #. type: table #: doc/guix.texi:21536 msgid "" "Theme to use. Default themes provided by SDDM are @samp{\"elarun\"}, " "@samp{\"maldives\"} or @samp{\"maya\"}." msgstr "" #. type: item #: doc/guix.texi:21537 #, no-wrap msgid "@code{themes-directory} (default \"/run/current-system/profile/share/sddm/themes\")" msgstr "" #. type: table #: doc/guix.texi:21539 msgid "Directory to look for themes." msgstr "" #. type: item #: doc/guix.texi:21540 #, no-wrap msgid "@code{faces-directory} (default \"/run/current-system/profile/share/sddm/faces\")" msgstr "" #. type: table #: doc/guix.texi:21542 msgid "Directory to look for faces." msgstr "" #. type: item #: doc/guix.texi:21543 #, no-wrap msgid "@code{default-path} (default \"/run/current-system/profile/bin\")" msgstr "" #. type: table #: doc/guix.texi:21545 msgid "Default PATH to use." msgstr "" #. type: item #: doc/guix.texi:21546 #, no-wrap msgid "@code{minimum-uid} (default: 1000)" msgstr "" #. type: table #: doc/guix.texi:21548 msgid "Minimum UID displayed in SDDM and allowed for log-in." msgstr "" #. type: item #: doc/guix.texi:21549 #, no-wrap msgid "@code{maximum-uid} (default: 2000)" msgstr "" #. type: table #: doc/guix.texi:21551 msgid "Maximum UID to display in SDDM." msgstr "" #. type: item #: doc/guix.texi:21552 #, no-wrap msgid "@code{remember-last-user?} (default #t)" msgstr "" #. type: table #: doc/guix.texi:21554 msgid "Remember last user." msgstr "" #. type: item #: doc/guix.texi:21555 #, no-wrap msgid "@code{remember-last-session?} (default #t)" msgstr "" #. type: table #: doc/guix.texi:21557 msgid "Remember last session." msgstr "" #. type: item #: doc/guix.texi:21558 #, no-wrap msgid "@code{hide-users} (default \"\")" msgstr "" #. type: table #: doc/guix.texi:21560 msgid "Usernames to hide from SDDM greeter." msgstr "" #. type: item #: doc/guix.texi:21561 #, no-wrap msgid "@code{hide-shells} (default @code{#~(string-append #$shadow \"/sbin/nologin\")})" msgstr "" #. type: table #: doc/guix.texi:21563 msgid "Users with shells listed will be hidden from the SDDM greeter." msgstr "" #. type: item #: doc/guix.texi:21564 #, no-wrap msgid "@code{session-command} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/wayland-session\")})" msgstr "" #. type: table #: doc/guix.texi:21566 msgid "Script to run before starting a wayland session." msgstr "" #. type: item #: doc/guix.texi:21567 #, no-wrap msgid "@code{sessions-directory} (default \"/run/current-system/profile/share/wayland-sessions\")" msgstr "" #. type: table #: doc/guix.texi:21569 msgid "Directory to look for desktop files starting wayland sessions." msgstr "" #. type: item #: doc/guix.texi:21573 #, no-wrap msgid "@code{xauth-path} (default @code{#~(string-append #$xauth \"/bin/xauth\")})" msgstr "" #. type: table #: doc/guix.texi:21575 msgid "Path to xauth." msgstr "" #. type: item #: doc/guix.texi:21576 #, no-wrap msgid "@code{xephyr-path} (default @code{#~(string-append #$xorg-server \"/bin/Xephyr\")})" msgstr "" #. type: table #: doc/guix.texi:21578 msgid "Path to Xephyr." msgstr "" #. type: item #: doc/guix.texi:21579 #, no-wrap msgid "@code{xdisplay-start} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/Xsetup\")})" msgstr "" #. type: table #: doc/guix.texi:21581 msgid "Script to run after starting xorg-server." msgstr "" #. type: item #: doc/guix.texi:21582 #, no-wrap msgid "@code{xdisplay-stop} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/Xstop\")})" msgstr "" #. type: table #: doc/guix.texi:21584 msgid "Script to run before stopping xorg-server." msgstr "" #. type: item #: doc/guix.texi:21585 #, no-wrap msgid "@code{xsession-command} (default: @code{xinitrc})" msgstr "" #. type: item #: doc/guix.texi:21588 #, no-wrap msgid "@code{xsessions-directory} (default: \"/run/current-system/profile/share/xsessions\")" msgstr "" #. type: table #: doc/guix.texi:21590 msgid "Directory to look for desktop files starting X sessions." msgstr "" #. type: item #: doc/guix.texi:21591 #, no-wrap msgid "@code{minimum-vt} (default: 7)" msgstr "" #. type: table #: doc/guix.texi:21593 msgid "Minimum VT to use." msgstr "" #. type: item #: doc/guix.texi:21594 #, no-wrap msgid "@code{auto-login-user} (default \"\")" msgstr "" #. type: table #: doc/guix.texi:21597 msgid "" "User account that will be automatically logged in. Setting this to the " "empty string disables auto-login." msgstr "" #. type: item #: doc/guix.texi:21598 #, no-wrap msgid "@code{auto-login-session} (default \"\")" msgstr "" #. type: table #: doc/guix.texi:21600 msgid "" "The @file{.desktop} file name to use as the auto-login session, or the empty " "string." msgstr "" #. type: item #: doc/guix.texi:21601 #, no-wrap msgid "@code{relogin?} (default #f)" msgstr "" #. type: table #: doc/guix.texi:21603 msgid "Relogin after logout." msgstr "" #. type: cindex #: doc/guix.texi:21607 #, no-wrap msgid "lightdm, graphical login manager" msgstr "" #. type: cindex #: doc/guix.texi:21608 #, no-wrap msgid "display manager, lightdm" msgstr "" #. type: anchor{#1} #: doc/guix.texi:21610 msgid "lightdm" msgstr "" #. type: defvr #: doc/guix.texi:21610 #, no-wrap msgid "{Scheme Variable} lightdm-service-type" msgstr "" #. type: defvr #: doc/guix.texi:21618 msgid "" "This is the type of the service to run the @url{https://github.com/canonical/" "lightdm,LightDM display manager}. Its value must be a @code{lightdm-" "configuration} record, which is documented below. Among its distinguishing " "features are TigerVNC integration for easily remoting your desktop as well " "as support for the XDMCP protocol, which can be used by remote clients to " "start a session from the login manager." msgstr "" #. type: defvr #: doc/guix.texi:21620 msgid "In its most basic form, it can be used simply as:" msgstr "" #. type: lisp #: doc/guix.texi:21623 #, no-wrap msgid "(service lightdm-service-type)\n" msgstr "" #. type: defvr #: doc/guix.texi:21627 msgid "" "A more elaborate example making use of the VNC capabilities and enabling " "more features and verbose logs could look like:" msgstr "" #. type: lisp #: doc/guix.texi:21641 #, no-wrap msgid "" "(service lightdm-service-type\n" " (lightdm-configuration\n" " (allow-empty-passwords? #t)\n" " (xdmcp? #t)\n" " (vnc-server? #t)\n" " (vnc-server-command\n" " (file-append tigervnc-server \"/bin/Xvnc\"\n" " \" -SecurityTypes None\"))\n" " (seats\n" " (list (lightdm-seat-configuration\n" " (name \"*\")\n" " (user-session \"ratpoison\"))))))\n" msgstr "" #. type: deftp #: doc/guix.texi:21648 #, no-wrap msgid "{Data Type} lightdm-configuration" msgstr "" #. type: deftp #: doc/guix.texi:21650 msgid "Available @code{lightdm-configuration} fields are:" msgstr "" #. type: item #: doc/guix.texi:21652 #, no-wrap msgid "@code{lightdm} (default: @code{lightdm}) (type: file-like)" msgstr "" #. type: table #: doc/guix.texi:21654 msgid "The lightdm package to use." msgstr "" #. type: item #: doc/guix.texi:21655 #, no-wrap msgid "@code{allow-empty-passwords?} (default: @code{#f}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:21657 msgid "Whether users not having a password set can login." msgstr "" #. type: table #: doc/guix.texi:21660 msgid "Enable verbose output." msgstr "" #. type: item #: doc/guix.texi:21661 #, no-wrap msgid "@code{xorg-configuration} (type: xorg-configuration)" msgstr "" #. type: table #: doc/guix.texi:21665 msgid "" "The default Xorg server configuration to use to generate the Xorg server " "start script. It can be refined per seat via the @code{xserver-command} of " "the @code{} record, if desired." msgstr "" #. type: item #: doc/guix.texi:21666 #, no-wrap msgid "@code{greeters} (type: list-of-greeter-configurations)" msgstr "" #. type: table #: doc/guix.texi:21668 msgid "The LightDM greeter configurations specifying the greeters to use." msgstr "" #. type: item #: doc/guix.texi:21669 #, no-wrap msgid "@code{seats} (type: list-of-seat-configurations)" msgstr "" #. type: table #: doc/guix.texi:21671 msgid "The seat configurations to use. A LightDM seat is akin to a user." msgstr "" #. type: item #: doc/guix.texi:21672 doc/guix.texi:31199 #, no-wrap msgid "@code{xdmcp?} (default: @code{#f}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:21674 msgid "Whether a XDMCP server should listen on port UDP 177." msgstr "" #. type: item #: doc/guix.texi:21675 #, no-wrap msgid "@code{xdmcp-listen-address} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:21678 msgid "" "The host or IP address the XDMCP server listens for incoming connections. " "When unspecified, listen on for any hosts/IP addresses." msgstr "" #. type: item #: doc/guix.texi:21679 #, no-wrap msgid "@code{vnc-server?} (default: @code{#f}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:21681 msgid "Whether a VNC server is started." msgstr "" #. type: item #: doc/guix.texi:21682 #, no-wrap msgid "@code{vnc-server-command} (type: file-like)" msgstr "" #. type: table #: doc/guix.texi:21686 msgid "" "The Xvnc command to use for the VNC server, it's possible to provide extra " "options not otherwise exposed along the command, for example to disable " "security:" msgstr "" #. type: lisp #: doc/guix.texi:21690 #, no-wrap msgid "" "(vnc-server-command (file-append tigervnc-server \"/bin/Xvnc\"\n" " \" -SecurityTypes None\" ))\n" msgstr "" #. type: table #: doc/guix.texi:21694 msgid "Or to set a PasswordFile for the classic (unsecure) VncAuth mecanism:" msgstr "" #. type: lisp #: doc/guix.texi:21698 #, no-wrap msgid "" "(vnc-server-command (file-append tigervnc-server \"/bin/Xvnc\"\n" " \" -PasswordFile /var/lib/lightdm/.vnc/passwd\"))\n" msgstr "" #. type: table #: doc/guix.texi:21704 msgid "" "The password file should be manually created using the @command{vncpasswd} " "command. Note that LightDM will create new sessions for VNC users, which " "means they need to authenticate in the same way as local users would." msgstr "" #. type: item #: doc/guix.texi:21705 #, no-wrap msgid "@code{vnc-server-listen-address} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:21708 msgid "" "The host or IP address the VNC server listens for incoming connections. " "When unspecified, listen for any hosts/IP addresses." msgstr "" #. type: item #: doc/guix.texi:21709 #, no-wrap msgid "@code{vnc-server-port} (default: @code{5900}) (type: number)" msgstr "" #. type: table #: doc/guix.texi:21711 msgid "The TCP port the VNC server should listen to." msgstr "" #. type: item #: doc/guix.texi:21712 doc/guix.texi:21764 doc/guix.texi:21803 #, no-wrap msgid "@code{extra-config} (default: @code{()}) (type: list-of-strings)" msgstr "" #. type: table #: doc/guix.texi:21714 msgid "Extra configuration values to append to the LightDM configuration file." msgstr "" #. type: deftp #: doc/guix.texi:21722 #, no-wrap msgid "{Data Type} lightdm-gtk-greeter-configuration" msgstr "" #. type: deftp #: doc/guix.texi:21724 msgid "Available @code{lightdm-gtk-greeter-configuration} fields are:" msgstr "" #. type: item #: doc/guix.texi:21726 #, no-wrap msgid "@code{lightdm-gtk-greeter} (default: @code{lightdm-gtk-greeter}) (type: file-like)" msgstr "" #. type: table #: doc/guix.texi:21728 msgid "The lightdm-gtk-greeter package to use." msgstr "" #. type: item #: doc/guix.texi:21729 #, no-wrap msgid "@code{assets} @" msgstr "" #. type: table #: doc/guix.texi:21734 msgid "" "(default: @code{(adwaita-icon-theme gnome-themes-extrahicolor-icon-theme)}) " "@ (type: list-of-file-likes) The list of packages complementing the " "greeter, such as package providing icon themes." msgstr "" #. type: item #: doc/guix.texi:21735 #, no-wrap msgid "@code{theme-name} (default: @code{\"Adwaita\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:21737 msgid "The name of the theme to use." msgstr "" #. type: item #: doc/guix.texi:21738 #, no-wrap msgid "@code{icon-theme-name} (default: @code{\"Adwaita\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:21740 msgid "The name of the icon theme to use." msgstr "" #. type: item #: doc/guix.texi:21741 #, no-wrap msgid "@code{cursor-theme-name} (default: @code{\"Adwaita\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:21743 msgid "The name of the cursor theme to use." msgstr "" #. type: item #: doc/guix.texi:21744 #, no-wrap msgid "@code{cursor-theme-size} (default: @code{16}) (type: number)" msgstr "" #. type: table #: doc/guix.texi:21746 msgid "The size to use for the cursor theme." msgstr "" #. type: item #: doc/guix.texi:21747 #, no-wrap msgid "@code{allow-debugging?} (type: maybe-boolean)" msgstr "" #. type: table #: doc/guix.texi:21749 msgid "Set to #t to enable debug log level." msgstr "" #. type: item #: doc/guix.texi:21750 #, no-wrap msgid "@code{background} (type: file-like)" msgstr "" #. type: table #: doc/guix.texi:21752 msgid "The background image to use." msgstr "" #. type: item #: doc/guix.texi:21753 #, no-wrap msgid "@code{at-spi-enabled?} (default: @code{#f}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:21756 msgid "" "Enable accessibility support through the Assistive Technology Service " "Provider Interface (AT-SPI)." msgstr "" #. type: item #: doc/guix.texi:21757 #, no-wrap msgid "@code{a11y-states} @" msgstr "" #. type: table #: doc/guix.texi:21760 msgid "" "(default: @code{(contrast font keyboard reader)}) (type: list-of-a11y-" "states) The accessibility features to enable, given as list of symbols." msgstr "" #. type: item #: doc/guix.texi:21761 #, no-wrap msgid "@code{reader} (type: maybe-file-like)" msgstr "" #. type: table #: doc/guix.texi:21763 msgid "The command to use to launch a screen reader." msgstr "" #. type: table #: doc/guix.texi:21767 msgid "" "Extra configuration values to append to the LightDM GTK Greeter " "configuration file." msgstr "" #. type: deftp #: doc/guix.texi:21774 #, no-wrap msgid "{Data Type} lightdm-seat-configuration" msgstr "" #. type: deftp #: doc/guix.texi:21776 msgid "Available @code{lightdm-seat-configuration} fields are:" msgstr "" #. type: item #: doc/guix.texi:21778 #, no-wrap msgid "@code{name} (type: seat-name)" msgstr "" #. type: table #: doc/guix.texi:21781 msgid "" "The name of the seat. An asterisk (*) can be used in the name to apply the " "seat configuration to all the seat names it matches." msgstr "" #. type: item #: doc/guix.texi:21782 #, no-wrap msgid "@code{user-session} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:21785 msgid "" "The session to use by default. The session name must be provided as a " "lowercase string, such as @code{\"gnome\"}, @code{\"ratpoison\"}, etc." msgstr "" #. type: item #: doc/guix.texi:21786 #, no-wrap msgid "@code{type} (default: @code{local}) (type: seat-type)" msgstr "" #. type: table #: doc/guix.texi:21788 msgid "The type of the seat, either the @code{local} or @code{xremote} symbol." msgstr "" #. type: item #: doc/guix.texi:21789 #, no-wrap msgid "@code{autologin-user} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:21791 msgid "The username to automatically log in with by default." msgstr "" #. type: item #: doc/guix.texi:21792 #, no-wrap msgid "@code{greeter-session} @" msgstr "" #. type: table #: doc/guix.texi:21796 msgid "" "(default: @code{lightdm-gtk-greeter}) (type: greeter-session) The greeter " "session to use, specified as a symbol. Currently, only @code{lightdm-gtk-" "greeter} is supported." msgstr "" #. type: item #: doc/guix.texi:21797 #, no-wrap msgid "@code{xserver-command} (type: maybe-file-like)" msgstr "" #. type: table #: doc/guix.texi:21799 msgid "The Xorg server command to run." msgstr "" #. type: item #: doc/guix.texi:21800 #, no-wrap msgid "@code{session-wrapper} (type: file-like)" msgstr "" #. type: table #: doc/guix.texi:21802 msgid "The xinitrc session wrapper to use." msgstr "" #. type: table #: doc/guix.texi:21805 msgid "Extra configuration values to append to the seat configuration section." msgstr "" #. type: cindex #: doc/guix.texi:21811 #, no-wrap msgid "Xorg, configuration" msgstr "" #. type: deftp #: doc/guix.texi:21812 #, no-wrap msgid "{Data Type} xorg-configuration" msgstr "" #. type: deftp #: doc/guix.texi:21818 msgid "" "This data type represents the configuration of the Xorg graphical display " "server. Note that there is no Xorg service; instead, the X server is " "started by a ``display manager'' such as GDM, SDDM, LightDM or SLiM@. Thus, " "the configuration of these display managers aggregates an @code{xorg-" "configuration} record." msgstr "" #. type: item #: doc/guix.texi:21820 #, no-wrap msgid "@code{modules} (default: @code{%default-xorg-modules})" msgstr "" #. type: table #: doc/guix.texi:21823 msgid "" "This is a list of @dfn{module packages} loaded by the Xorg server---e.g., " "@code{xf86-video-vesa}, @code{xf86-input-keyboard}, and so on." msgstr "" #. type: item #: doc/guix.texi:21824 #, no-wrap msgid "@code{fonts} (default: @code{%default-xorg-fonts})" msgstr "" #. type: table #: doc/guix.texi:21826 msgid "" "This is a list of font directories to add to the server's @dfn{font path}." msgstr "" #. type: item #: doc/guix.texi:21827 #, no-wrap msgid "@code{drivers} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:21831 msgid "" "This must be either the empty list, in which case Xorg chooses a graphics " "driver automatically, or a list of driver names that will be tried in this " "order---e.g., @code{(\"modesetting\" \"vesa\")}." msgstr "" #. type: item #: doc/guix.texi:21832 #, no-wrap msgid "@code{resolutions} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:21836 msgid "" "When @code{resolutions} is the empty list, Xorg chooses an appropriate " "screen resolution. Otherwise, it must be a list of resolutions---e.g., " "@code{((1024 768) (640 480))}." msgstr "" #. type: cindex #: doc/guix.texi:21837 #, no-wrap msgid "keyboard layout, for Xorg" msgstr "" #. type: cindex #: doc/guix.texi:21838 #, no-wrap msgid "keymap, for Xorg" msgstr "" #. type: table #: doc/guix.texi:21842 msgid "" "If this is @code{#f}, Xorg uses the default keyboard layout---usually US " "English (``qwerty'') for a 105-key PC keyboard." msgstr "" #. type: table #: doc/guix.texi:21846 msgid "" "Otherwise this must be a @code{keyboard-layout} object specifying the " "keyboard layout in use when Xorg is running. @xref{Keyboard Layout}, for " "more information on how to specify the keyboard layout." msgstr "" #. type: item #: doc/guix.texi:21847 doc/guix.texi:24108 doc/guix.texi:37209 #, no-wrap msgid "@code{extra-config} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:21850 doc/guix.texi:37213 msgid "" "This is a list of strings or objects appended to the configuration file. It " "is used to pass extra text to be added verbatim to the configuration file." msgstr "" #. type: item #: doc/guix.texi:21851 #, no-wrap msgid "@code{server} (default: @code{xorg-server})" msgstr "" #. type: table #: doc/guix.texi:21853 msgid "This is the package providing the Xorg server." msgstr "" #. type: item #: doc/guix.texi:21854 #, no-wrap msgid "@code{server-arguments} (default: @code{%default-xorg-server-arguments})" msgstr "" #. type: table #: doc/guix.texi:21857 msgid "" "This is the list of command-line arguments to pass to the X server. The " "default is @code{-nolisten tcp}." msgstr "" #. type: deffn #: doc/guix.texi:21860 #, no-wrap msgid "{Scheme Procedure} set-xorg-configuration @var{config} @" msgstr "" #. type: deffn #: doc/guix.texi:21864 msgid "" "[@var{login-manager-service-type}] Tell the log-in manager (of type " "@var{login-manager-service-type}) to use @var{config}, an @code{} record." msgstr "" #. type: deffn #: doc/guix.texi:21868 msgid "" "Since the Xorg configuration is embedded in the log-in manager's " "configuration---e.g., @code{gdm-configuration}---this procedure provides a " "shorthand to set the Xorg configuration." msgstr "" #. type: deffn #: doc/guix.texi:21870 #, no-wrap msgid "{Scheme Procedure} xorg-start-command [@var{config}]" msgstr "" #. type: deffn #: doc/guix.texi:21874 msgid "" "Return a @code{startx} script in which the modules, fonts, etc. specified in " "@var{config}, are available. The result should be used in place of " "@code{startx}." msgstr "" #. type: deffn #: doc/guix.texi:21876 msgid "Usually the X server is started by a login manager." msgstr "" #. type: deffn #: doc/guix.texi:21879 #, no-wrap msgid "{Scheme Procedure} screen-locker-service @var{package} [@var{program}]" msgstr "" #. type: deffn #: doc/guix.texi:21883 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:21886 #, no-wrap msgid "(screen-locker-service xlockmore \"xlock\")\n" msgstr "" #. type: deffn #: doc/guix.texi:21889 msgid "makes the good ol' XlockMore usable." msgstr "" #. type: cindex #: doc/guix.texi:21895 #, no-wrap msgid "printer support with CUPS" msgstr "" #. type: Plain text #: doc/guix.texi:21899 msgid "" "The @code{(gnu services cups)} module provides a Guix service definition for " "the CUPS printing service. To add printer support to a Guix system, add a " "@code{cups-service} to the operating system definition:" msgstr "" #. type: deffn #: doc/guix.texi:21900 #, no-wrap msgid "{Scheme Variable} cups-service-type" msgstr "" #. type: deffn #: doc/guix.texi:21904 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: lisp #: doc/guix.texi:21906 #, no-wrap msgid "(service cups-service-type)\n" msgstr "" #. type: Plain text #: doc/guix.texi:21916 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:21922 msgid "" "Suppose you want to enable the Web interface of CUPS and also add support " "for Epson printers @i{via} the @code{epson-inkjet-printer-escpr} package and " "for HP printers @i{via} the @code{hplip-minimal} package. You can do that " "directly, like this (you need to use the @code{(gnu packages cups)} module):" msgstr "" #. type: lisp #: doc/guix.texi:21929 #, no-wrap msgid "" "(service cups-service-type\n" " (cups-configuration\n" " (web-interface? #t)\n" " (extensions\n" " (list cups-filters epson-inkjet-printer-escpr hplip-minimal))))\n" msgstr "" #. type: quotation #: doc/guix.texi:21935 msgid "" "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." msgstr "" #. type: Plain text #: doc/guix.texi:21943 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:21954 msgid "Available @code{cups-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:21955 #, no-wrap msgid "{@code{cups-configuration} parameter} package cups" msgstr "" #. type: deftypevr #: doc/guix.texi:21957 doc/guix.texi:22725 msgid "The CUPS package." msgstr "" #. type: deftypevr #: doc/guix.texi:21959 #, no-wrap msgid "{@code{cups-configuration} parameter} package-list extensions (default: @code{(list brlaser cups-filters epson-inkjet-printer-escpr foomatic-filters hplip-minimal splix)})" msgstr "" #. type: deftypevr #: doc/guix.texi:21961 msgid "Drivers and other extensions to the CUPS package." msgstr "" #. type: deftypevr #: doc/guix.texi:21963 #, no-wrap msgid "{@code{cups-configuration} parameter} files-configuration files-configuration" msgstr "" #. type: deftypevr #: doc/guix.texi:21966 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:21968 msgid "Available @code{files-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:21969 #, no-wrap msgid "{@code{files-configuration} parameter} log-location access-log" msgstr "" #. type: deftypevr #: doc/guix.texi:21977 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:21979 msgid "Defaults to @samp{\"/var/log/cups/access_log\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:21981 #, no-wrap msgid "{@code{files-configuration} parameter} file-name cache-dir" msgstr "" #. type: deftypevr #: doc/guix.texi:21983 msgid "Where CUPS should cache data." msgstr "" #. type: deftypevr #: doc/guix.texi:21985 msgid "Defaults to @samp{\"/var/cache/cups\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:21987 #, no-wrap msgid "{@code{files-configuration} parameter} string config-file-perm" msgstr "" #. type: deftypevr #: doc/guix.texi:21990 msgid "" "Specifies the permissions for all configuration files that the scheduler " "writes." msgstr "" #. type: deftypevr #: doc/guix.texi:21996 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:21998 msgid "Defaults to @samp{\"0640\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22000 #, no-wrap msgid "{@code{files-configuration} parameter} log-location error-log" msgstr "" #. type: deftypevr #: doc/guix.texi:22008 msgid "" "Defines the error log filename. Specifying a blank filename disables error " "log generation. The value @code{stderr} causes log entries to be sent to " "the standard error file when the scheduler is running in the foreground, or " "to the system log daemon when run in the background. The value " "@code{syslog} causes log entries to be sent to the system log daemon. The " "server name may be included in filenames using the string @code{%s}, as in " "@code{/var/log/cups/%s-error_log}." msgstr "" #. type: deftypevr #: doc/guix.texi:22010 msgid "Defaults to @samp{\"/var/log/cups/error_log\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22012 #, no-wrap msgid "{@code{files-configuration} parameter} string fatal-errors" msgstr "" #. type: deftypevr #: doc/guix.texi:22015 msgid "" "Specifies which errors are fatal, causing the scheduler to exit. The kind " "strings are:" msgstr "" #. type: table #: doc/guix.texi:22019 msgid "No errors are fatal." msgstr "" #. type: table #: doc/guix.texi:22022 msgid "All of the errors below are fatal." msgstr "" #. type: item #: doc/guix.texi:22023 #, no-wrap msgid "browse" msgstr "" #. type: table #: doc/guix.texi:22026 msgid "" "Browsing initialization errors are fatal, for example failed connections to " "the DNS-SD daemon." msgstr "" #. type: item #: doc/guix.texi:22027 #, no-wrap msgid "config" msgstr "" #. type: table #: doc/guix.texi:22029 msgid "Configuration file syntax errors are fatal." msgstr "" #. type: item #: doc/guix.texi:22030 #, no-wrap msgid "listen" msgstr "" #. type: table #: doc/guix.texi:22033 msgid "" "Listen or Port errors are fatal, except for IPv6 failures on the loopback or " "@code{any} addresses." msgstr "" #. type: item #: doc/guix.texi:22034 #, no-wrap msgid "log" msgstr "" #. type: table #: doc/guix.texi:22036 msgid "Log file creation or write errors are fatal." msgstr "" #. type: item #: doc/guix.texi:22037 #, no-wrap msgid "permissions" msgstr "" #. type: table #: doc/guix.texi:22040 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:22043 msgid "Defaults to @samp{\"all -browse\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22045 #, no-wrap msgid "{@code{files-configuration} parameter} boolean file-device?" msgstr "" #. type: deftypevr #: doc/guix.texi:22048 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:22050 doc/guix.texi:22126 doc/guix.texi:22168 #: doc/guix.texi:22188 doc/guix.texi:22194 doc/guix.texi:22210 #: doc/guix.texi:22298 doc/guix.texi:22386 doc/guix.texi:22699 #: doc/guix.texi:22712 doc/guix.texi:24377 doc/guix.texi:25860 #: doc/guix.texi:25966 doc/guix.texi:26031 doc/guix.texi:26040 #: doc/guix.texi:27286 doc/guix.texi:27330 doc/guix.texi:27347 #: doc/guix.texi:27355 doc/guix.texi:27370 doc/guix.texi:27388 #: doc/guix.texi:27412 doc/guix.texi:27465 doc/guix.texi:27598 #: doc/guix.texi:27632 doc/guix.texi:27668 doc/guix.texi:27684 #: doc/guix.texi:27712 doc/guix.texi:27773 doc/guix.texi:27856 #: doc/guix.texi:32408 doc/guix.texi:32422 doc/guix.texi:32622 #: doc/guix.texi:32667 doc/guix.texi:32754 doc/guix.texi:32960 #: doc/guix.texi:32993 doc/guix.texi:33133 doc/guix.texi:33144 #: doc/guix.texi:33395 doc/guix.texi:34936 doc/guix.texi:34945 #: doc/guix.texi:34953 doc/guix.texi:34961 doc/guix.texi:34977 #: doc/guix.texi:34993 doc/guix.texi:35001 doc/guix.texi:35009 #: doc/guix.texi:35018 doc/guix.texi:35027 doc/guix.texi:35043 #: doc/guix.texi:35107 doc/guix.texi:35213 doc/guix.texi:35221 #: doc/guix.texi:35229 doc/guix.texi:35254 doc/guix.texi:35308 #: doc/guix.texi:35356 doc/guix.texi:35557 doc/guix.texi:35564 msgid "Defaults to @samp{#f}." msgstr "" #. type: deftypevr #: doc/guix.texi:22052 #, no-wrap msgid "{@code{files-configuration} parameter} string group" msgstr "" #. type: deftypevr #: doc/guix.texi:22055 msgid "" "Specifies the group name or ID that will be used when executing external " "programs." msgstr "" #. type: deftypevr #: doc/guix.texi:22057 doc/guix.texi:22143 msgid "Defaults to @samp{\"lp\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22059 #, no-wrap msgid "{@code{files-configuration} parameter} string log-file-group" msgstr "" #. type: deftypevr #: doc/guix.texi:22061 msgid "Specifies the group name or ID that will be used for log files." msgstr "" #. type: deftypevr #: doc/guix.texi:22063 msgid "Defaults to @samp{\"lpadmin\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22065 #, no-wrap msgid "{@code{files-configuration} parameter} string log-file-perm" msgstr "" #. type: deftypevr #: doc/guix.texi:22067 msgid "Specifies the permissions for all log files that the scheduler writes." msgstr "" #. type: deftypevr #: doc/guix.texi:22069 msgid "Defaults to @samp{\"0644\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22071 #, no-wrap msgid "{@code{files-configuration} parameter} log-location page-log" msgstr "" #. type: deftypevr #: doc/guix.texi:22079 msgid "" "Defines the page log filename. Specifying a blank filename disables page " "log generation. The value @code{stderr} causes log entries to be sent to " "the standard error file when the scheduler is running in the foreground, or " "to the system log daemon when run in the background. The value " "@code{syslog} causes log entries to be sent to the system log daemon. The " "server name may be included in filenames using the string @code{%s}, as in " "@code{/var/log/cups/%s-page_log}." msgstr "" #. type: deftypevr #: doc/guix.texi:22081 msgid "Defaults to @samp{\"/var/log/cups/page_log\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22083 #, no-wrap msgid "{@code{files-configuration} parameter} string remote-root" msgstr "" #. type: deftypevr #: doc/guix.texi:22086 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:22088 msgid "Defaults to @samp{\"remroot\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22090 #, no-wrap msgid "{@code{files-configuration} parameter} file-name request-root" msgstr "" #. type: deftypevr #: doc/guix.texi:22093 msgid "" "Specifies the directory that contains print jobs and other HTTP request data." msgstr "" #. type: deftypevr #: doc/guix.texi:22095 msgid "Defaults to @samp{\"/var/spool/cups\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22097 #, no-wrap msgid "{@code{files-configuration} parameter} sandboxing sandboxing" msgstr "" #. type: deftypevr #: doc/guix.texi:22102 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:22104 msgid "Defaults to @samp{strict}." msgstr "" #. type: deftypevr #: doc/guix.texi:22106 #, no-wrap msgid "{@code{files-configuration} parameter} file-name server-keychain" msgstr "" #. type: deftypevr #: doc/guix.texi:22111 msgid "" "Specifies the location of TLS certificates and private keys. CUPS will look " "for public and private keys in this directory: @file{.crt} files for PEM-" "encoded certificates and corresponding @file{.key} files for PEM-encoded " "private keys." msgstr "" #. type: deftypevr #: doc/guix.texi:22113 msgid "Defaults to @samp{\"/etc/cups/ssl\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22115 #, no-wrap msgid "{@code{files-configuration} parameter} file-name server-root" msgstr "" #. type: deftypevr #: doc/guix.texi:22117 msgid "Specifies the directory containing the server configuration files." msgstr "" #. type: deftypevr #: doc/guix.texi:22119 msgid "Defaults to @samp{\"/etc/cups\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22121 #, no-wrap msgid "{@code{files-configuration} parameter} boolean sync-on-close?" msgstr "" #. type: deftypevr #: doc/guix.texi:22124 msgid "" "Specifies whether the scheduler calls fsync(2) after writing configuration " "or state files." msgstr "" #. type: deftypevr #: doc/guix.texi:22128 #, no-wrap msgid "{@code{files-configuration} parameter} space-separated-string-list system-group" msgstr "" #. type: deftypevr #: doc/guix.texi:22130 msgid "Specifies the group(s) to use for @code{@@SYSTEM} group authentication." msgstr "" #. type: deftypevr #: doc/guix.texi:22132 #, no-wrap msgid "{@code{files-configuration} parameter} file-name temp-dir" msgstr "" #. type: deftypevr #: doc/guix.texi:22134 msgid "Specifies the directory where temporary files are stored." msgstr "" #. type: deftypevr #: doc/guix.texi:22136 msgid "Defaults to @samp{\"/var/spool/cups/tmp\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22138 #, no-wrap msgid "{@code{files-configuration} parameter} string user" msgstr "" #. type: deftypevr #: doc/guix.texi:22141 msgid "" "Specifies the user name or ID that is used when running external programs." msgstr "" #. type: deftypevr #: doc/guix.texi:22145 #, no-wrap msgid "{@code{files-configuration} parameter} string set-env" msgstr "" #. type: deftypevr #: doc/guix.texi:22147 msgid "Set the specified environment variable to be passed to child processes." msgstr "" #. type: deftypevr #: doc/guix.texi:22149 msgid "Defaults to @samp{\"variable value\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22152 #, no-wrap msgid "{@code{cups-configuration} parameter} access-log-level access-log-level" msgstr "" #. type: deftypevr #: doc/guix.texi:22159 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:22161 msgid "Defaults to @samp{actions}." msgstr "" #. type: deftypevr #: doc/guix.texi:22163 #, no-wrap msgid "{@code{cups-configuration} parameter} boolean auto-purge-jobs?" msgstr "" #. type: deftypevr #: doc/guix.texi:22166 msgid "" "Specifies whether to purge job history data automatically when it is no " "longer required for quotas." msgstr "" #. type: deftypevr #: doc/guix.texi:22170 #, no-wrap msgid "{@code{cups-configuration} parameter} comma-separated-string-list browse-dns-sd-sub-types" msgstr "" #. type: deftypevr #: doc/guix.texi:22174 msgid "" "Specifies a list of DNS-SD sub-types to advertise for each shared printer. " "For example, @samp{\"_cups\" \"_print\"} will tell network clients that both " "CUPS sharing and IPP Everywhere are supported." msgstr "" #. type: deftypevr #: doc/guix.texi:22176 msgid "Defaults to @samp{\"_cups\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22178 #, no-wrap msgid "{@code{cups-configuration} parameter} browse-local-protocols browse-local-protocols" msgstr "" #. type: deftypevr #: doc/guix.texi:22180 msgid "Specifies which protocols to use for local printer sharing." msgstr "" #. type: deftypevr #: doc/guix.texi:22182 msgid "Defaults to @samp{dnssd}." msgstr "" #. type: deftypevr #: doc/guix.texi:22184 #, no-wrap msgid "{@code{cups-configuration} parameter} boolean browse-web-if?" msgstr "" #. type: deftypevr #: doc/guix.texi:22186 msgid "Specifies whether the CUPS web interface is advertised." msgstr "" #. type: deftypevr #: doc/guix.texi:22190 #, no-wrap msgid "{@code{cups-configuration} parameter} boolean browsing?" msgstr "" #. type: deftypevr #: doc/guix.texi:22192 msgid "Specifies whether shared printers are advertised." msgstr "" #. type: deftypevr #: doc/guix.texi:22196 #, no-wrap msgid "{@code{cups-configuration} parameter} string classification" msgstr "" #. type: deftypevr #: doc/guix.texi:22201 msgid "" "Specifies the security classification of the server. Any valid banner name " "can be used, including @samp{\"classified\"}, @samp{\"confidential\"}, " "@samp{\"secret\"}, @samp{\"topsecret\"}, and @samp{\"unclassified\"}, or the " "banner can be omitted to disable secure printing functions." msgstr "" #. type: deftypevr #: doc/guix.texi:22203 doc/guix.texi:22534 doc/guix.texi:25065 #: doc/guix.texi:25077 doc/guix.texi:25105 doc/guix.texi:25867 #: doc/guix.texi:25881 doc/guix.texi:25888 doc/guix.texi:25895 #: doc/guix.texi:25925 doc/guix.texi:26023 doc/guix.texi:33099 #: doc/guix.texi:33107 doc/guix.texi:33115 doc/guix.texi:33123 #: doc/guix.texi:33402 doc/guix.texi:34779 doc/guix.texi:34787 #: doc/guix.texi:34795 doc/guix.texi:34903 doc/guix.texi:34928 #: doc/guix.texi:35059 doc/guix.texi:35067 doc/guix.texi:35075 #: doc/guix.texi:35083 doc/guix.texi:35091 doc/guix.texi:35099 #: doc/guix.texi:35122 doc/guix.texi:35130 doc/guix.texi:35182 #: doc/guix.texi:35198 doc/guix.texi:35206 doc/guix.texi:35245 #: doc/guix.texi:35268 doc/guix.texi:35290 doc/guix.texi:35297 #: doc/guix.texi:35332 doc/guix.texi:35340 doc/guix.texi:35364 #: doc/guix.texi:35396 doc/guix.texi:35425 doc/guix.texi:35432 #: doc/guix.texi:35439 doc/guix.texi:35447 doc/guix.texi:35461 #: doc/guix.texi:35470 doc/guix.texi:35480 doc/guix.texi:35487 #: doc/guix.texi:35494 doc/guix.texi:35501 doc/guix.texi:35572 #: doc/guix.texi:35579 doc/guix.texi:35586 doc/guix.texi:35595 #: doc/guix.texi:35611 doc/guix.texi:35618 doc/guix.texi:35625 #: doc/guix.texi:35632 doc/guix.texi:35640 doc/guix.texi:35648 msgid "Defaults to @samp{\"\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22205 #, no-wrap msgid "{@code{cups-configuration} parameter} boolean classify-override?" msgstr "" #. type: deftypevr #: doc/guix.texi:22208 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:22212 #, no-wrap msgid "{@code{cups-configuration} parameter} default-auth-type default-auth-type" msgstr "" #. type: deftypevr #: doc/guix.texi:22214 msgid "Specifies the default type of authentication to use." msgstr "" #. type: deftypevr #: doc/guix.texi:22216 msgid "Defaults to @samp{Basic}." msgstr "" #. type: deftypevr #: doc/guix.texi:22218 #, no-wrap msgid "{@code{cups-configuration} parameter} default-encryption default-encryption" msgstr "" #. type: deftypevr #: doc/guix.texi:22220 msgid "Specifies whether encryption will be used for authenticated requests." msgstr "" #. type: deftypevr #: doc/guix.texi:22222 msgid "Defaults to @samp{Required}." msgstr "" #. type: deftypevr #: doc/guix.texi:22224 #, no-wrap msgid "{@code{cups-configuration} parameter} string default-language" msgstr "" #. type: deftypevr #: doc/guix.texi:22226 msgid "Specifies the default language to use for text and web content." msgstr "" #. type: deftypevr #: doc/guix.texi:22228 msgid "Defaults to @samp{\"en\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22230 #, no-wrap msgid "{@code{cups-configuration} parameter} string default-paper-size" msgstr "" #. type: deftypevr #: doc/guix.texi:22235 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:22237 msgid "Defaults to @samp{\"Auto\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22239 #, no-wrap msgid "{@code{cups-configuration} parameter} string default-policy" msgstr "" #. type: deftypevr #: doc/guix.texi:22241 msgid "Specifies the default access policy to use." msgstr "" #. type: deftypevr #: doc/guix.texi:22243 msgid "Defaults to @samp{\"default\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22245 #, no-wrap msgid "{@code{cups-configuration} parameter} boolean default-shared?" msgstr "" #. type: deftypevr #: doc/guix.texi:22247 msgid "Specifies whether local printers are shared by default." msgstr "" #. type: deftypevr #: doc/guix.texi:22249 doc/guix.texi:22329 doc/guix.texi:22619 #: doc/guix.texi:25957 doc/guix.texi:26008 doc/guix.texi:26015 #: doc/guix.texi:27310 doc/guix.texi:27498 doc/guix.texi:27615 #: doc/guix.texi:27651 doc/guix.texi:27702 doc/guix.texi:27721 #: doc/guix.texi:27731 doc/guix.texi:27741 doc/guix.texi:27800 #: doc/guix.texi:27822 doc/guix.texi:27847 doc/guix.texi:27873 #: doc/guix.texi:27891 doc/guix.texi:31019 doc/guix.texi:31047 #: doc/guix.texi:32275 doc/guix.texi:32415 doc/guix.texi:32629 #: doc/guix.texi:32636 doc/guix.texi:32658 doc/guix.texi:32697 #: doc/guix.texi:32717 doc/guix.texi:32731 doc/guix.texi:32948 #: doc/guix.texi:34881 doc/guix.texi:34969 doc/guix.texi:34985 #: doc/guix.texi:35035 msgid "Defaults to @samp{#t}." msgstr "" #. type: deftypevr #: doc/guix.texi:22251 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer dirty-clean-interval" msgstr "" #. type: deftypevr #: doc/guix.texi:22255 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:22257 doc/guix.texi:22305 doc/guix.texi:22314 #: doc/guix.texi:22626 doc/guix.texi:27660 doc/guix.texi:27693 msgid "Defaults to @samp{30}." msgstr "" #. type: deftypevr #: doc/guix.texi:22259 #, no-wrap msgid "{@code{cups-configuration} parameter} error-policy error-policy" msgstr "" #. type: deftypevr #: doc/guix.texi:22265 msgid "" "Specifies what to do when an error occurs. Possible values are @code{abort-" "job}, which will discard the failed print job; @code{retry-job}, which will " "retry the job at a later time; @code{retry-current-job}, which retries the " "failed job immediately; and @code{stop-printer}, which stops the printer." msgstr "" #. type: deftypevr #: doc/guix.texi:22267 msgid "Defaults to @samp{stop-printer}." msgstr "" #. type: deftypevr #: doc/guix.texi:22269 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer filter-limit" msgstr "" #. type: deftypevr #: doc/guix.texi:22277 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:22279 doc/guix.texi:22287 doc/guix.texi:22336 #: doc/guix.texi:22452 doc/guix.texi:22466 doc/guix.texi:22473 #: doc/guix.texi:24507 doc/guix.texi:24523 doc/guix.texi:25180 #: doc/guix.texi:25192 doc/guix.texi:25976 doc/guix.texi:25985 #: doc/guix.texi:25993 doc/guix.texi:26001 doc/guix.texi:32291 #: doc/guix.texi:32644 doc/guix.texi:34874 doc/guix.texi:35174 #: doc/guix.texi:35348 msgid "Defaults to @samp{0}." msgstr "" #. type: deftypevr #: doc/guix.texi:22281 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer filter-nice" msgstr "" #. type: deftypevr #: doc/guix.texi:22285 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:22289 #, no-wrap msgid "{@code{cups-configuration} parameter} host-name-lookups host-name-lookups" msgstr "" #. type: deftypevr #: doc/guix.texi:22296 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:22300 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer job-kill-delay" msgstr "" #. type: deftypevr #: doc/guix.texi:22303 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:22307 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer job-retry-interval" msgstr "" #. type: deftypevr #: doc/guix.texi:22312 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:22316 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer job-retry-limit" msgstr "" #. type: deftypevr #: doc/guix.texi:22321 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:22323 doc/guix.texi:27624 doc/guix.texi:33200 #: doc/guix.texi:33220 doc/guix.texi:33236 doc/guix.texi:33250 #: doc/guix.texi:33257 doc/guix.texi:33264 doc/guix.texi:33271 #: doc/guix.texi:33431 doc/guix.texi:33447 doc/guix.texi:33454 #: doc/guix.texi:33461 doc/guix.texi:33472 doc/guix.texi:34826 #: doc/guix.texi:34834 doc/guix.texi:34842 doc/guix.texi:34866 msgid "Defaults to @samp{5}." msgstr "" #. type: deftypevr #: doc/guix.texi:22325 #, no-wrap msgid "{@code{cups-configuration} parameter} boolean keep-alive?" msgstr "" #. type: deftypevr #: doc/guix.texi:22327 msgid "Specifies whether to support HTTP keep-alive connections." msgstr "" #. type: deftypevr #: doc/guix.texi:22331 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer limit-request-body" msgstr "" #. type: deftypevr #: doc/guix.texi:22334 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:22338 #, no-wrap msgid "{@code{cups-configuration} parameter} multiline-string-list listen" msgstr "" #. type: deftypevr #: doc/guix.texi:22345 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:22347 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer listen-back-log" msgstr "" #. type: deftypevr #: doc/guix.texi:22354 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:22356 msgid "Defaults to @samp{128}." msgstr "" #. type: deftypevr #: doc/guix.texi:22358 #, no-wrap msgid "{@code{cups-configuration} parameter} location-access-control-list location-access-controls" msgstr "" #. type: deftypevr #: doc/guix.texi:22360 msgid "Specifies a set of additional access controls." msgstr "" #. type: deftypevr #: doc/guix.texi:22362 msgid "Available @code{location-access-controls} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:22363 #, no-wrap msgid "{@code{location-access-controls} parameter} file-name path" msgstr "" #. type: deftypevr #: doc/guix.texi:22365 msgid "Specifies the URI path to which the access control applies." msgstr "" #. type: deftypevr #: doc/guix.texi:22367 #, no-wrap msgid "{@code{location-access-controls} parameter} access-control-list access-controls" msgstr "" #. type: deftypevr #: doc/guix.texi:22370 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:22372 doc/guix.texi:22378 doc/guix.texi:22392 #: doc/guix.texi:22399 doc/guix.texi:22541 doc/guix.texi:22600 #: doc/guix.texi:22678 doc/guix.texi:22692 doc/guix.texi:24387 #: doc/guix.texi:24396 doc/guix.texi:25666 doc/guix.texi:25874 #: doc/guix.texi:25902 doc/guix.texi:25932 doc/guix.texi:26047 #: doc/guix.texi:26060 doc/guix.texi:26067 doc/guix.texi:27830 #: doc/guix.texi:28666 doc/guix.texi:28674 doc/guix.texi:28919 #: doc/guix.texi:31078 doc/guix.texi:33091 doc/guix.texi:33151 #: doc/guix.texi:33159 doc/guix.texi:34889 doc/guix.texi:34896 #: doc/guix.texi:35238 doc/guix.texi:35316 doc/guix.texi:35410 #: doc/guix.texi:35418 doc/guix.texi:35454 doc/guix.texi:35604 #: doc/guix.texi:35655 doc/guix.texi:35664 msgid "Defaults to @samp{()}." msgstr "" #. type: deftypevr #: doc/guix.texi:22374 #, no-wrap msgid "{@code{location-access-controls} parameter} method-access-control-list method-access-controls" msgstr "" #. type: deftypevr #: doc/guix.texi:22376 msgid "Access controls for method-specific access to this path." msgstr "" #. type: deftypevr #: doc/guix.texi:22380 msgid "Available @code{method-access-controls} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:22381 #, no-wrap msgid "{@code{method-access-controls} parameter} boolean reverse?" msgstr "" #. type: deftypevr #: doc/guix.texi:22384 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:22388 #, no-wrap msgid "{@code{method-access-controls} parameter} method-list methods" msgstr "" #. type: deftypevr #: doc/guix.texi:22390 msgid "Methods to which this access control applies." msgstr "" #. type: deftypevr #: doc/guix.texi:22394 #, no-wrap msgid "{@code{method-access-controls} parameter} access-control-list access-controls" msgstr "" #. type: deftypevr #: doc/guix.texi:22397 msgid "" "Access control directives, as a list of strings. Each string should be one " "directive, such as @samp{\"Order allow,deny\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22403 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer log-debug-history" msgstr "" #. type: deftypevr #: doc/guix.texi:22407 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:22409 doc/guix.texi:22430 doc/guix.texi:22437 #: doc/guix.texi:25426 doc/guix.texi:27362 doc/guix.texi:27377 msgid "Defaults to @samp{100}." msgstr "" #. type: deftypevr #: doc/guix.texi:22411 #, no-wrap msgid "{@code{cups-configuration} parameter} log-level log-level" msgstr "" #. type: deftypevr #: doc/guix.texi:22414 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:22416 doc/guix.texi:27839 msgid "Defaults to @samp{info}." msgstr "" #. type: deftypevr #: doc/guix.texi:22418 #, no-wrap msgid "{@code{cups-configuration} parameter} log-time-format log-time-format" msgstr "" #. type: deftypevr #: doc/guix.texi:22421 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:22423 msgid "Defaults to @samp{standard}." msgstr "" #. type: deftypevr #: doc/guix.texi:22425 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer max-clients" msgstr "" #. type: deftypevr #: doc/guix.texi:22428 msgid "" "Specifies the maximum number of simultaneous clients that are allowed by the " "scheduler." msgstr "" #. type: deftypevr #: doc/guix.texi:22432 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer max-clients-per-host" msgstr "" #. type: deftypevr #: doc/guix.texi:22435 msgid "" "Specifies the maximum number of simultaneous clients that are allowed from a " "single address." msgstr "" #. type: deftypevr #: doc/guix.texi:22439 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer max-copies" msgstr "" #. type: deftypevr #: doc/guix.texi:22442 msgid "" "Specifies the maximum number of copies that a user can print of each job." msgstr "" #. type: deftypevr #: doc/guix.texi:22444 msgid "Defaults to @samp{9999}." msgstr "" #. type: deftypevr #: doc/guix.texi:22446 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer max-hold-time" msgstr "" #. type: deftypevr #: doc/guix.texi:22450 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:22454 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs" msgstr "" #. type: deftypevr #: doc/guix.texi:22457 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:22459 msgid "Defaults to @samp{500}." msgstr "" #. type: deftypevr #: doc/guix.texi:22461 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs-per-printer" msgstr "" #. type: deftypevr #: doc/guix.texi:22464 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:22468 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs-per-user" msgstr "" #. type: deftypevr #: doc/guix.texi:22471 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:22475 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer max-job-time" msgstr "" #. type: deftypevr #: doc/guix.texi:22478 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:22480 msgid "Defaults to @samp{10800}." msgstr "" #. type: deftypevr #: doc/guix.texi:22482 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer max-log-size" msgstr "" #. type: deftypevr #: doc/guix.texi:22485 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:22487 msgid "Defaults to @samp{1048576}." msgstr "" #. type: deftypevr #: doc/guix.texi:22489 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer multiple-operation-timeout" msgstr "" #. type: deftypevr #: doc/guix.texi:22492 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:22494 doc/guix.texi:22705 msgid "Defaults to @samp{900}." msgstr "" #. type: deftypevr #: doc/guix.texi:22496 #, no-wrap msgid "{@code{cups-configuration} parameter} string page-log-format" msgstr "" #. type: deftypevr #: doc/guix.texi:22501 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:22503 #, no-wrap msgid "%%" msgstr "" #. type: table #: doc/guix.texi:22505 msgid "insert a single percent character" msgstr "" #. type: item #: doc/guix.texi:22506 #, no-wrap msgid "%@{name@}" msgstr "" #. type: table #: doc/guix.texi:22508 msgid "insert the value of the specified IPP attribute" msgstr "" #. type: item #: doc/guix.texi:22509 #, no-wrap msgid "%C" msgstr "" #. type: table #: doc/guix.texi:22511 msgid "insert the number of copies for the current page" msgstr "" #. type: item #: doc/guix.texi:22512 #, no-wrap msgid "%P" msgstr "" #. type: table #: doc/guix.texi:22514 msgid "insert the current page number" msgstr "" #. type: item #: doc/guix.texi:22515 #, no-wrap msgid "%T" msgstr "" #. type: table #: doc/guix.texi:22517 msgid "insert the current date and time in common log format" msgstr "" #. type: item #: doc/guix.texi:22518 #, no-wrap msgid "%j" msgstr "" #. type: table #: doc/guix.texi:22520 msgid "insert the job ID" msgstr "" #. type: item #: doc/guix.texi:22521 doc/guix.texi:25025 #, no-wrap msgid "%p" msgstr "" #. type: table #: doc/guix.texi:22523 msgid "insert the printer name" msgstr "" #. type: item #: doc/guix.texi:22524 doc/guix.texi:25048 #, no-wrap msgid "%u" msgstr "" #. type: table #: doc/guix.texi:22526 msgid "insert the username" msgstr "" #. type: deftypevr #: doc/guix.texi:22532 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:22536 #, no-wrap msgid "{@code{cups-configuration} parameter} environment-variables environment-variables" msgstr "" #. type: deftypevr #: doc/guix.texi:22539 msgid "" "Passes the specified environment variable(s) to child processes; a list of " "strings." msgstr "" #. type: deftypevr #: doc/guix.texi:22543 #, no-wrap msgid "{@code{cups-configuration} parameter} policy-configuration-list policies" msgstr "" #. type: deftypevr #: doc/guix.texi:22545 msgid "Specifies named access control policies." msgstr "" #. type: deftypevr #: doc/guix.texi:22547 msgid "Available @code{policy-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:22548 #, no-wrap msgid "{@code{policy-configuration} parameter} string name" msgstr "" #. type: deftypevr #: doc/guix.texi:22550 msgid "Name of the policy." msgstr "" #. type: deftypevr #: doc/guix.texi:22552 #, no-wrap msgid "{@code{policy-configuration} parameter} string job-private-access" msgstr "" #. type: deftypevr #: doc/guix.texi:22562 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-" "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:22564 doc/guix.texi:22586 msgid "Defaults to @samp{\"@@OWNER @@SYSTEM\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22566 #, no-wrap msgid "{@code{policy-configuration} parameter} string job-private-values" msgstr "" #. type: deftypevr #: doc/guix.texi:22569 doc/guix.texi:22591 msgid "" "Specifies the list of job values to make private, or @code{all}, " "@code{default}, or @code{none}." msgstr "" #. type: deftypevr #: doc/guix.texi:22572 msgid "" "Defaults to @samp{\"job-name job-originating-host-name job-originating-user-" "name phone\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22574 #, no-wrap msgid "{@code{policy-configuration} parameter} string subscription-private-access" msgstr "" #. type: deftypevr #: doc/guix.texi:22584 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-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:22588 #, no-wrap msgid "{@code{policy-configuration} parameter} string subscription-private-values" msgstr "" #. type: deftypevr #: doc/guix.texi:22594 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:22596 #, no-wrap msgid "{@code{policy-configuration} parameter} operation-access-control-list access-controls" msgstr "" #. type: deftypevr #: doc/guix.texi:22598 msgid "Access control by IPP operation." msgstr "" #. type: deftypevr #: doc/guix.texi:22603 #, no-wrap msgid "{@code{cups-configuration} parameter} boolean-or-non-negative-integer preserve-job-files" msgstr "" #. type: deftypevr #: doc/guix.texi:22608 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:22610 msgid "Defaults to @samp{86400}." msgstr "" #. type: deftypevr #: doc/guix.texi:22612 #, no-wrap msgid "{@code{cups-configuration} parameter} boolean-or-non-negative-integer preserve-job-history" msgstr "" #. type: deftypevr #: doc/guix.texi:22617 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:22621 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer reload-timeout" msgstr "" #. type: deftypevr #: doc/guix.texi:22624 msgid "" "Specifies the amount of time to wait for job completion before restarting " "the scheduler." msgstr "" #. type: deftypevr #: doc/guix.texi:22628 #, no-wrap msgid "{@code{cups-configuration} parameter} string rip-cache" msgstr "" #. type: deftypevr #: doc/guix.texi:22631 msgid "" "Specifies the maximum amount of memory to use when converting documents into " "bitmaps for a printer." msgstr "" #. type: deftypevr #: doc/guix.texi:22633 msgid "Defaults to @samp{\"128m\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22635 #, no-wrap msgid "{@code{cups-configuration} parameter} string server-admin" msgstr "" #. type: deftypevr #: doc/guix.texi:22637 msgid "Specifies the email address of the server administrator." msgstr "" #. type: deftypevr #: doc/guix.texi:22639 msgid "Defaults to @samp{\"root@@localhost.localdomain\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22641 #, no-wrap msgid "{@code{cups-configuration} parameter} host-name-list-or-* server-alias" msgstr "" #. type: deftypevr #: doc/guix.texi:22649 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:22651 msgid "Defaults to @samp{*}." msgstr "" #. type: deftypevr #: doc/guix.texi:22653 #, no-wrap msgid "{@code{cups-configuration} parameter} string server-name" msgstr "" #. type: deftypevr #: doc/guix.texi:22655 msgid "Specifies the fully-qualified host name of the server." msgstr "" #. type: deftypevr #: doc/guix.texi:22657 msgid "Defaults to @samp{\"localhost\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:22659 #, no-wrap msgid "{@code{cups-configuration} parameter} server-tokens server-tokens" msgstr "" #. type: deftypevr #: doc/guix.texi:22667 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:22669 msgid "Defaults to @samp{Minimal}." msgstr "" #. type: deftypevr #: doc/guix.texi:22671 #, no-wrap msgid "{@code{cups-configuration} parameter} multiline-string-list ssl-listen" msgstr "" #. type: deftypevr #: doc/guix.texi:22676 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:22680 #, no-wrap msgid "{@code{cups-configuration} parameter} ssl-options ssl-options" msgstr "" #. type: deftypevr #: doc/guix.texi:22690 msgid "" "Sets encryption options. By default, CUPS only supports encryption using " "TLS v1.0 or higher using known secure cipher suites. Security is reduced " "when @code{Allow} options are used, and enhanced when @code{Deny} options " "are used. The @code{AllowRC4} option enables the 128-bit RC4 cipher suites, " "which are required for some older clients. The @code{AllowSSL3} option " "enables SSL v3.0, which is required for some older clients that do not " "support TLS v1.0. The @code{DenyCBC} option disables all CBC cipher " "suites. The @code{DenyTLS1.0} option disables TLS v1.0 support - this sets " "the minimum protocol version to TLS v1.1." msgstr "" #. type: deftypevr #: doc/guix.texi:22694 #, no-wrap msgid "{@code{cups-configuration} parameter} boolean strict-conformance?" msgstr "" #. type: deftypevr #: doc/guix.texi:22697 msgid "" "Specifies whether the scheduler requires clients to strictly adhere to the " "IPP specifications." msgstr "" #. type: deftypevr #: doc/guix.texi:22701 #, no-wrap msgid "{@code{cups-configuration} parameter} non-negative-integer timeout" msgstr "" #. type: deftypevr #: doc/guix.texi:22703 msgid "Specifies the HTTP request timeout, in seconds." msgstr "" #. type: deftypevr #: doc/guix.texi:22708 #, no-wrap msgid "{@code{cups-configuration} parameter} boolean web-interface?" msgstr "" #. type: deftypevr #: doc/guix.texi:22710 msgid "Specifies whether the web interface is enabled." msgstr "" #. type: Plain text #: doc/guix.texi:22720 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:22722 msgid "Available @code{opaque-cups-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:22723 #, no-wrap msgid "{@code{opaque-cups-configuration} parameter} package cups" msgstr "" #. type: deftypevr #: doc/guix.texi:22727 #, no-wrap msgid "{@code{opaque-cups-configuration} parameter} string cupsd.conf" msgstr "" #. type: deftypevr #: doc/guix.texi:22729 msgid "The contents of the @code{cupsd.conf}, as a string." msgstr "" #. type: deftypevr #: doc/guix.texi:22731 #, no-wrap msgid "{@code{opaque-cups-configuration} parameter} string cups-files.conf" msgstr "" #. type: deftypevr #: doc/guix.texi:22733 msgid "The contents of the @code{cups-files.conf} file, as a string." msgstr "" #. type: Plain text #: doc/guix.texi:22738 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: lisp #: doc/guix.texi:22744 #, 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:22755 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:22759 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:22760 #, no-wrap msgid "{Scheme Variable} %desktop-services" msgstr "" #. type: defvr #: doc/guix.texi:22763 msgid "" "This is a list of services that builds upon @code{%base-services} and adds " "or adjusts services for a typical ``desktop'' setup." msgstr "" #. type: defvr #: doc/guix.texi:22774 msgid "" "In particular, it adds a graphical login manager (@pxref{X Window, @code{gdm-" "service-type}}), screen lockers, a network management tool " "(@pxref{Networking Services, @code{network-manager-service-type}}) with " "modem support (@pxref{Networking Services, @code{modem-manager-service-" "type}}), energy and color management services, the @code{elogind} login and " "seat manager, the Polkit privilege service, the GeoClue location service, " "the AccountsService daemon that allows authorized users change system " "passwords, an NTP client (@pxref{Networking Services}), the Avahi daemon, " "and has the name service switch service configured to be able to use " "@code{nss-mdns} (@pxref{Name Service Switch, mDNS})." msgstr "" #. type: Plain text #: doc/guix.texi:22779 msgid "" "The @code{%desktop-services} variable can be used as the @code{services} " "field of an @code{operating-system} declaration (@pxref{operating-system " "Reference, @code{services}})." msgstr "" #. type: Plain text #: doc/guix.texi:22802 msgid "" "Additionally, the @code{gnome-desktop-service-type}, @code{xfce-desktop-" "service}, @code{mate-desktop-service-type}, @code{lxqt-desktop-service-type} " "and @code{enlightenment-desktop-service-type} procedures can add GNOME, " "Xfce, MATE and/or Enlightenment to a system. To ``add GNOME'' means that " "system-level services like the backlight adjustment helpers and the power " "management utilities are added to the system, extending @code{polkit} and " "@code{dbus} appropriately, allowing GNOME to operate with elevated " "privileges on a limited number of special-purpose system interfaces. " "Additionally, adding a service made by @code{gnome-desktop-service-type} " "adds the GNOME metapackage to the system profile. Likewise, adding the Xfce " "service not only adds the @code{xfce} metapackage to the system profile, but " "it also gives the Thunar file manager the ability to open a ``root-mode'' " "file management window, if the user authenticates using the administrator's " "password via the standard polkit graphical interface. To ``add MATE'' means " "that @code{polkit} and @code{dbus} are extended appropriately, allowing MATE " "to operate with elevated privileges on a limited number of special-purpose " "system interfaces. Additionally, adding a service of type @code{mate-" "desktop-service-type} adds the MATE metapackage to the system profile. " "``Adding Enlightenment'' means that @code{dbus} is extended appropriately, " "and several of Enlightenment's binaries are set as setuid, allowing " "Enlightenment's screen locker and other functionality to work as expected." msgstr "" #. type: Plain text #: doc/guix.texi:22812 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 enable Wayland support in GDM (@pxref{wayland-gdm}). Another solution is " "to use the @code{sddm-service} instead of GDM as the graphical login " "manager. You should then select the ``GNOME (Wayland)'' session in SDDM@. " "Alternatively you can also try starting GNOME on Wayland manually from a TTY " "with the command ``XDG_SESSION_TYPE=wayland exec dbus-run-session gnome-" "session``. Currently only GNOME has support for Wayland." msgstr "" #. type: defvr #: doc/guix.texi:22813 #, no-wrap msgid "{Scheme Variable} gnome-desktop-service-type" msgstr "" #. type: defvr #: doc/guix.texi:22817 msgid "" "This is the type of the service that adds the @uref{https://www.gnome.org, " "GNOME} desktop environment. Its value is a @code{gnome-desktop-" "configuration} object (see below)." msgstr "" #. type: defvr #: doc/guix.texi:22820 msgid "" "This service adds the @code{gnome} package to the system profile, and " "extends polkit with the actions from @code{gnome-settings-daemon}." msgstr "" #. type: deftp #: doc/guix.texi:22822 #, no-wrap msgid "{Data Type} gnome-desktop-configuration" msgstr "" #. type: deftp #: doc/guix.texi:22824 msgid "Configuration record for the GNOME desktop environment." msgstr "" #. type: item #: doc/guix.texi:22826 #, no-wrap msgid "@code{gnome} (default: @code{gnome})" msgstr "" #. type: table #: doc/guix.texi:22828 msgid "The GNOME package to use." msgstr "" #. type: defvr #: doc/guix.texi:22831 #, no-wrap msgid "{Scheme Variable} xfce-desktop-service-type" msgstr "" #. type: defvr #: doc/guix.texi:22835 msgid "" "This is the type of a service to run the @uref{Xfce, https://xfce.org/} " "desktop environment. Its value is an @code{xfce-desktop-configuration} " "object (see below)." msgstr "" #. type: defvr #: doc/guix.texi:22840 msgid "" "This service adds the @code{xfce} package to the system profile, and extends " "polkit with the ability for @code{thunar} to manipulate the file system as " "root from within a user session, after the user has authenticated with the " "administrator's password." msgstr "" #. type: defvr #: doc/guix.texi:22846 msgid "" "Note that @code{xfce4-panel} and its plugin packages should be installed in " "the same profile to ensure compatibility. When using this service, you " "should add extra plugins (@code{xfce4-whiskermenu-plugin}, @code{xfce4-" "weather-plugin}, etc.) to the @code{packages} field of your @code{operating-" "system}." msgstr "" #. type: deftp #: doc/guix.texi:22848 #, no-wrap msgid "{Data Type} xfce-desktop-configuration" msgstr "" #. type: deftp #: doc/guix.texi:22850 msgid "Configuration record for the Xfce desktop environment." msgstr "" #. type: item #: doc/guix.texi:22852 #, no-wrap msgid "@code{xfce} (default: @code{xfce})" msgstr "" #. type: table #: doc/guix.texi:22854 msgid "The Xfce package to use." msgstr "" #. type: deffn #: doc/guix.texi:22857 #, no-wrap msgid "{Scheme Variable} mate-desktop-service-type" msgstr "" #. type: deffn #: doc/guix.texi:22861 msgid "" "This is the type of the service that runs the @uref{https://mate-desktop." "org/, MATE desktop environment}. Its value is a @code{mate-desktop-" "configuration} object (see below)." msgstr "" #. type: deffn #: doc/guix.texi:22865 msgid "" "This service adds the @code{mate} package to the system profile, and extends " "polkit with the actions from @code{mate-settings-daemon}." msgstr "" #. type: deftp #: doc/guix.texi:22867 #, no-wrap msgid "{Data Type} mate-desktop-configuration" msgstr "" #. type: deftp #: doc/guix.texi:22869 msgid "Configuration record for the MATE desktop environment." msgstr "" #. type: item #: doc/guix.texi:22871 #, no-wrap msgid "@code{mate} (default: @code{mate})" msgstr "" #. type: table #: doc/guix.texi:22873 msgid "The MATE package to use." msgstr "" #. type: deffn #: doc/guix.texi:22876 #, no-wrap msgid "{Scheme Variable} lxqt-desktop-service-type" msgstr "" #. type: deffn #: doc/guix.texi:22880 msgid "" "This is the type of the service that runs the @uref{https://lxqt-project." "org, LXQt desktop environment}. Its value is a @code{lxqt-desktop-" "configuration} object (see below)." msgstr "" #. type: deffn #: doc/guix.texi:22883 msgid "This service adds the @code{lxqt} package to the system profile." msgstr "" #. type: deftp #: doc/guix.texi:22885 #, no-wrap msgid "{Data Type} lxqt-desktop-configuration" msgstr "" #. type: deftp #: doc/guix.texi:22887 msgid "Configuration record for the LXQt desktop environment." msgstr "" #. type: item #: doc/guix.texi:22889 #, no-wrap msgid "@code{lxqt} (default: @code{lxqt})" msgstr "" #. type: table #: doc/guix.texi:22891 msgid "The LXQT package to use." msgstr "" #. type: deffn #: doc/guix.texi:22894 #, no-wrap msgid "{Scheme Variable} enlightenment-desktop-service-type" msgstr "" #. type: deffn #: doc/guix.texi:22897 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:22899 #, no-wrap msgid "{Data Type} enlightenment-desktop-service-configuration" msgstr "" #. type: item #: doc/guix.texi:22901 #, no-wrap msgid "@code{enlightenment} (default: @code{enlightenment})" msgstr "" #. type: table #: doc/guix.texi:22903 msgid "The enlightenment package to use." msgstr "" #. type: Plain text #: doc/guix.texi:22911 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: lisp #: doc/guix.texi:22922 #, 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* (service gnome-desktop-service-type)\n" " (service xfce-desktop-service)\n" " %desktop-services))\n" " ...)\n" msgstr "" #. type: Plain text #: doc/guix.texi:22926 msgid "" "These desktop environments will then be available as options in the " "graphical login window." msgstr "" #. type: Plain text #: doc/guix.texi:22930 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:22931 #, no-wrap msgid "{Scheme Procedure} dbus-service [#:dbus @var{dbus}] [#:services '()] @" msgstr "" #. type: deffn #: doc/guix.texi:22939 msgid "" "[#:verbose?] Return a service that runs the ``system bus'', using " "@var{dbus}, with support for @var{services}. When @var{verbose?} is true, " "it causes the @samp{DBUS_VERBOSE} environment variable to be set to " "@samp{1}; a verbose-enabled D-Bus package such as @code{dbus-verbose} should " "be provided as @var{dbus} in this scenario. The verbose output is logged to " "@file{/var/log/dbus-daemon.log}." msgstr "" #. type: deffn #: doc/guix.texi:22943 msgid "" "@uref{https://dbus.freedesktop.org/, D-Bus} is an inter-process " "communication facility. Its system bus is used to allow system services to " "communicate and to be notified of system-wide events." msgstr "" #. type: deffn #: doc/guix.texi:22948 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:22950 #, no-wrap msgid "{Scheme Procedure} elogind-service [#:config @var{config}]" msgstr "" #. type: deffn #: doc/guix.texi:22956 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:22960 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:22965 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:22967 #, no-wrap msgid "kill-user-processes?" msgstr "" #. type: code{#1} #: doc/guix.texi:22969 doc/guix.texi:22989 doc/guix.texi:22991 #: doc/guix.texi:22993 doc/guix.texi:23005 doc/guix.texi:23422 msgid "#f" msgstr "" #. type: item #: doc/guix.texi:22969 #, no-wrap msgid "kill-only-users" msgstr "" #. type: code{#1} #: doc/guix.texi:22971 doc/guix.texi:23011 msgid "()" msgstr "" #. type: item #: doc/guix.texi:22971 #, no-wrap msgid "kill-exclude-users" msgstr "" #. type: code{#1} #: doc/guix.texi:22973 msgid "(\"root\")" msgstr "" #. type: item #: doc/guix.texi:22973 #, no-wrap msgid "inhibit-delay-max-seconds" msgstr "" #. type: code{#1} #: doc/guix.texi:22975 msgid "5" msgstr "" #. type: item #: doc/guix.texi:22975 #, no-wrap msgid "handle-power-key" msgstr "" #. type: code{#1} #: doc/guix.texi:22977 msgid "poweroff" msgstr "" #. type: item #: doc/guix.texi:22977 #, no-wrap msgid "handle-suspend-key" msgstr "" #. type: code{#1} #: doc/guix.texi:22979 doc/guix.texi:22983 msgid "suspend" msgstr "" #. type: item #: doc/guix.texi:22979 #, no-wrap msgid "handle-hibernate-key" msgstr "" #. type: code{#1} #: doc/guix.texi:22981 msgid "hibernate" msgstr "" #. type: item #: doc/guix.texi:22981 #, no-wrap msgid "handle-lid-switch" msgstr "" #. type: item #: doc/guix.texi:22983 #, no-wrap msgid "handle-lid-switch-docked" msgstr "" #. type: code{#1} #: doc/guix.texi:22985 doc/guix.texi:22999 msgid "ignore" msgstr "" #. type: item #: doc/guix.texi:22985 #, no-wrap msgid "handle-lid-switch-external-power" msgstr "" #. type: code{#1} #: doc/guix.texi:22987 msgid "*unspecified*" msgstr "" #. type: item #: doc/guix.texi:22987 #, no-wrap msgid "power-key-ignore-inhibited?" msgstr "" #. type: item #: doc/guix.texi:22989 #, no-wrap msgid "suspend-key-ignore-inhibited?" msgstr "" #. type: item #: doc/guix.texi:22991 #, no-wrap msgid "hibernate-key-ignore-inhibited?" msgstr "" #. type: item #: doc/guix.texi:22993 #, no-wrap msgid "lid-switch-ignore-inhibited?" msgstr "" #. type: code{#1} #: doc/guix.texi:22995 doc/guix.texi:23007 doc/guix.texi:23419 msgid "#t" msgstr "" #. type: item #: doc/guix.texi:22995 #, no-wrap msgid "holdoff-timeout-seconds" msgstr "" #. type: code{#1} #: doc/guix.texi:22997 msgid "30" msgstr "" #. type: item #: doc/guix.texi:22997 #, no-wrap msgid "idle-action" msgstr "" #. type: item #: doc/guix.texi:22999 #, no-wrap msgid "idle-action-seconds" msgstr "" #. type: code{#1} #: doc/guix.texi:23001 msgid "(* 30 60)" msgstr "" #. type: item #: doc/guix.texi:23001 #, no-wrap msgid "runtime-directory-size-percent" msgstr "" #. type: code{#1} #: doc/guix.texi:23003 msgid "10" msgstr "" #. type: item #: doc/guix.texi:23003 #, no-wrap msgid "runtime-directory-size" msgstr "" #. type: item #: doc/guix.texi:23005 #, no-wrap msgid "remove-ipc?" msgstr "" #. type: item #: doc/guix.texi:23007 #, no-wrap msgid "suspend-state" msgstr "" #. type: code{#1} #: doc/guix.texi:23009 msgid "(\"mem\" \"standby\" \"freeze\")" msgstr "" #. type: item #: doc/guix.texi:23009 #, no-wrap msgid "suspend-mode" msgstr "" #. type: item #: doc/guix.texi:23011 #, no-wrap msgid "hibernate-state" msgstr "" #. type: code{#1} #: doc/guix.texi:23013 doc/guix.texi:23017 msgid "(\"disk\")" msgstr "" #. type: item #: doc/guix.texi:23013 #, no-wrap msgid "hibernate-mode" msgstr "" #. type: code{#1} #: doc/guix.texi:23015 msgid "(\"platform\" \"shutdown\")" msgstr "" #. type: item #: doc/guix.texi:23015 #, no-wrap msgid "hybrid-sleep-state" msgstr "" #. type: item #: doc/guix.texi:23017 #, no-wrap msgid "hybrid-sleep-mode" msgstr "" #. type: code{#1} #: doc/guix.texi:23019 msgid "(\"suspend\" \"platform\" \"shutdown\")" msgstr "" #. type: deffn #: doc/guix.texi:23022 #, no-wrap msgid "{Scheme Procedure} accountsservice-service @" msgstr "" #. type: deffn #: doc/guix.texi:23030 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:23033 msgid "" "The @var{accountsservice} keyword argument is the @code{accountsservice} " "package to expose as a service." msgstr "" #. type: deffn #: doc/guix.texi:23035 #, no-wrap msgid "{Scheme Procedure} polkit-service @" msgstr "" #. type: deffn #: doc/guix.texi:23044 msgid "" "[#:polkit @var{polkit}] Return a service that runs the @uref{https://www." "freedesktop.org/wiki/Software/polkit/, Polkit privilege management service}, " "which allows system administrators to grant access to privileged operations " "in a structured way. By querying the Polkit service, a privileged system " "component can know when it should grant additional capabilities to ordinary " "users. For example, an ordinary user can be granted the capability to " "suspend the system if the user is logged in locally." msgstr "" #. type: defvr #: doc/guix.texi:23046 #, no-wrap msgid "{Scheme Variable} polkit-wheel-service" msgstr "" #. type: defvr #: doc/guix.texi:23051 msgid "" "Service that adds the @code{wheel} group as admins to the Polkit service. " "This makes it so that users in the @code{wheel} group are queried for their " "own passwords when performing administrative actions instead of " "@code{root}'s, similar to the behaviour used by @code{sudo}." msgstr "" #. type: defvr #: doc/guix.texi:23053 #, no-wrap msgid "{Scheme Variable} upower-service-type" msgstr "" #. type: defvr #: doc/guix.texi:23057 msgid "" "Service that runs @uref{https://upower.freedesktop.org/, @command{upowerd}}, " "a system-wide monitor for power consumption and battery levels, with the " "given configuration settings." msgstr "" #. type: defvr #: doc/guix.texi:23060 msgid "" "It implements the @code{org.freedesktop.UPower} D-Bus interface, and is " "notably used by GNOME." msgstr "" #. type: deftp #: doc/guix.texi:23062 #, no-wrap msgid "{Data Type} upower-configuration" msgstr "" #. type: deftp #: doc/guix.texi:23064 msgid "Data type representation the configuration for UPower." msgstr "" #. type: item #: doc/guix.texi:23067 #, no-wrap msgid "@code{upower} (default: @var{upower})" msgstr "" #. type: table #: doc/guix.texi:23069 msgid "Package to use for @code{upower}." msgstr "" #. type: item #: doc/guix.texi:23070 #, no-wrap msgid "@code{watts-up-pro?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23072 msgid "Enable the Watts Up Pro device." msgstr "" #. type: item #: doc/guix.texi:23073 #, no-wrap msgid "@code{poll-batteries?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:23075 msgid "Enable polling the kernel for battery level changes." msgstr "" #. type: item #: doc/guix.texi:23076 #, no-wrap msgid "@code{ignore-lid?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23078 msgid "Ignore the lid state, this can be useful if it's incorrect on a device." msgstr "" #. type: item #: doc/guix.texi:23079 #, no-wrap msgid "@code{use-percentage-for-policy?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:23083 msgid "" "Whether to use a policy based on battery percentage rather than on estimated " "time left. A policy based on battery percentage is usually more reliable." msgstr "" #. type: item #: doc/guix.texi:23084 #, no-wrap msgid "@code{percentage-low} (default: @code{20})" msgstr "" #. type: table #: doc/guix.texi:23087 msgid "" "When @code{use-percentage-for-policy?} is @code{#t}, this sets the " "percentage at which the battery is considered low." msgstr "" #. type: item #: doc/guix.texi:23088 #, no-wrap msgid "@code{percentage-critical} (default: @code{5})" msgstr "" #. type: table #: doc/guix.texi:23091 msgid "" "When @code{use-percentage-for-policy?} is @code{#t}, this sets the " "percentage at which the battery is considered critical." msgstr "" #. type: item #: doc/guix.texi:23092 #, no-wrap msgid "@code{percentage-action} (default: @code{2})" msgstr "" #. type: table #: doc/guix.texi:23095 msgid "" "When @code{use-percentage-for-policy?} is @code{#t}, this sets the " "percentage at which action will be taken." msgstr "" #. type: item #: doc/guix.texi:23096 #, no-wrap msgid "@code{time-low} (default: @code{1200})" msgstr "" #. type: table #: doc/guix.texi:23099 msgid "" "When @code{use-time-for-policy?} is @code{#f}, this sets the time remaining " "in seconds at which the battery is considered low." msgstr "" #. type: item #: doc/guix.texi:23100 #, no-wrap msgid "@code{time-critical} (default: @code{300})" msgstr "" #. type: table #: doc/guix.texi:23103 msgid "" "When @code{use-time-for-policy?} is @code{#f}, this sets the time remaining " "in seconds at which the battery is considered critical." msgstr "" #. type: item #: doc/guix.texi:23104 #, no-wrap msgid "@code{time-action} (default: @code{120})" msgstr "" #. type: table #: doc/guix.texi:23107 msgid "" "When @code{use-time-for-policy?} is @code{#f}, this sets the time remaining " "in seconds at which action will be taken." msgstr "" #. type: item #: doc/guix.texi:23108 #, no-wrap msgid "@code{critical-power-action} (default: @code{'hybrid-sleep})" msgstr "" #. type: table #: doc/guix.texi:23111 msgid "" "The action taken when @code{percentage-action} or @code{time-action} is " "reached (depending on the configuration of @code{use-percentage-for-" "policy?})." msgstr "" #. type: table #: doc/guix.texi:23113 doc/guix.texi:23280 doc/guix.texi:23312 #: doc/guix.texi:23332 doc/guix.texi:23553 doc/guix.texi:23571 #: doc/guix.texi:23602 doc/guix.texi:23615 doc/guix.texi:23665 msgid "Possible values are:" msgstr "" #. type: code{#1} #: doc/guix.texi:23117 msgid "'power-off" msgstr "" #. type: code{#1} #: doc/guix.texi:23120 msgid "'hibernate" msgstr "" #. type: itemize #: doc/guix.texi:23123 msgid "@code{'hybrid-sleep}." msgstr "" #. type: deffn #: doc/guix.texi:23128 #, no-wrap msgid "{Scheme Procedure} udisks-service [#:udisks @var{udisks}]" msgstr "" #. type: deffn #: doc/guix.texi:23138 msgid "" "Return a service for @uref{https://udisks.freedesktop.org/docs/latest/, " "UDisks}, a @dfn{disk management} daemon that provides user interfaces with " "notifications and ways to mount/unmount disks. Programs that talk to UDisks " "include the @command{udisksctl} command, part of UDisks, and GNOME Disks. " "Note that Udisks relies on the @command{mount} command, so it will only be " "able to use the file-system utilities installed in the system profile. For " "example if you want to be able to mount NTFS file-systems in read and write " "fashion, you'll need to have @code{ntfs-3g} installed system-wide." msgstr "" #. type: deffn #: doc/guix.texi:23140 #, no-wrap msgid "{Scheme Variable} colord-service-type" msgstr "" #. type: deffn #: doc/guix.texi:23147 msgid "" "This is the type of the service that runs @command{colord}, a system service " "with a D-Bus interface to manage the color profiles of input and output " "devices such as screens and scanners. It is notably used by the GNOME Color " "Manager graphical tool. See @uref{https://www.freedesktop.org/software/" "colord/, the colord web site} for more information." msgstr "" #. type: cindex #: doc/guix.texi:23149 #, no-wrap msgid "scanner access" msgstr "" #. type: defvr #: doc/guix.texi:23150 #, no-wrap msgid "{Scheme Variable} sane-service-type" msgstr "" #. type: defvr #: doc/guix.texi:23156 msgid "" "This service provides access to scanners @i{via} @uref{http://www.sane-" "project.org, SANE} by installing the necessary udev rules. It is included " "in @code{%desktop-services} (@pxref{Desktop Services}) and relies by default " "on @code{sane-backends-minimal} package (see below) for hardware support." msgstr "" #. type: defvr #: doc/guix.texi:23158 #, no-wrap msgid "{Scheme Variable} sane-backends-minimal" msgstr "" #. type: defvr #: doc/guix.texi:23161 msgid "" "The default package which the @code{sane-service-type} installs. It " "supports many recent scanners." msgstr "" #. type: defvr #: doc/guix.texi:23163 #, no-wrap msgid "{Scheme Variable} sane-backends" msgstr "" #. type: defvr #: doc/guix.texi:23170 msgid "" "This package includes support for all scanners that @code{sane-backends-" "minimal} supports, plus older Hewlett-Packard scanners supported by " "@code{hplip} package. In order to use this on a system which relies on " "@code{%desktop-services}, you may use @code{modify-services} (@pxref{Service " "Reference, @code{modify-services}}) as illustrated below:" msgstr "" #. type: lisp #: doc/guix.texi:23179 #, no-wrap msgid "" "(use-modules (gnu))\n" "(use-service-modules\n" " @dots{}\n" " desktop)\n" "(use-package-modules\n" " @dots{}\n" " scanner)\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:23184 #, no-wrap msgid "" "(define %my-desktop-services\n" " ;; List of desktop services that supports a broader range of scanners.\n" " (modify-services %desktop-services\n" " (sane-service-type _ => sane-backends)))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:23188 #, no-wrap msgid "" "(operating-system\n" " @dots{}\n" " (services %my-desktop-services))\n" msgstr "" #. type: deffn #: doc/guix.texi:23191 #, no-wrap msgid "{Scheme Procedure} geoclue-application name [#:allowed? #t] [#:system? #f] [#:users '()]" msgstr "" #. type: deffn #: doc/guix.texi:23200 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:23202 #, no-wrap msgid "{Scheme Variable} %standard-geoclue-applications" msgstr "" #. type: defvr #: doc/guix.texi:23209 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:23211 #, no-wrap msgid "{Scheme Procedure} geoclue-service [#:colord @var{colord}] @" msgstr "" #. type: deffn #: doc/guix.texi:23224 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:23226 #, no-wrap msgid "{Scheme Procedure} bluetooth-service [#:bluez @var{bluez}] @" msgstr "" #. type: deffn #: doc/guix.texi:23233 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:23235 msgid "Users need to be in the @code{lp} group to access the D-Bus service." msgstr "" #. type: deffn #: doc/guix.texi:23237 #, no-wrap msgid "{Scheme Variable} bluetooth-service-type" msgstr "" #. type: deffn #: doc/guix.texi:23242 msgid "" "This is the type for the @uref{https://bluez.org/, Linux Bluetooth Protocol " "Stack} (BlueZ) system, which generates the @file{/etc/bluetooth/main.conf} " "configuration file. The value for this type is a @command{bluetooth-" "configuration} record as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:23245 #, no-wrap msgid "(service bluetooth-service-type)\n" msgstr "" #. type: deffn #: doc/guix.texi:23248 msgid "See below for details about @code{bluetooth-configuration}." msgstr "" #. type: deftp #: doc/guix.texi:23250 #, no-wrap msgid "{Data Type} bluetooth-configuration" msgstr "" #. type: deftp #: doc/guix.texi:23252 msgid "Data type representing the configuration for @code{bluetooth-service}." msgstr "" #. type: item #: doc/guix.texi:23254 #, no-wrap msgid "@code{bluez} (default: @code{bluez})" msgstr "" #. type: table #: doc/guix.texi:23256 msgid "@code{bluez} package to use." msgstr "" #. type: item #: doc/guix.texi:23257 #, no-wrap msgid "@code{name} (default: @code{\"BlueZ\"})" msgstr "" #. type: table #: doc/guix.texi:23259 msgid "Default adapter name." msgstr "" #. type: item #: doc/guix.texi:23260 #, no-wrap msgid "@code{class} (default: @code{#x000000})" msgstr "" #. type: table #: doc/guix.texi:23262 msgid "" "Default device class. Only the major and minor device class bits are " "considered." msgstr "" #. type: item #: doc/guix.texi:23263 #, no-wrap msgid "@code{discoverable-timeout} (default: @code{180})" msgstr "" #. type: table #: doc/guix.texi:23266 msgid "" "How long to stay in discoverable mode before going back to non-discoverable. " "The value is in seconds." msgstr "" #. type: item #: doc/guix.texi:23267 #, no-wrap msgid "@code{always-pairable?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23269 msgid "Always allow pairing even if there are no agents registered." msgstr "" #. type: item #: doc/guix.texi:23270 #, no-wrap msgid "@code{pairable-timeout} (default: @code{0})" msgstr "" #. type: table #: doc/guix.texi:23273 msgid "" "How long to stay in pairable mode before going back to non-discoverable. The " "value is in seconds." msgstr "" #. type: item #: doc/guix.texi:23274 #, no-wrap msgid "@code{device-id} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23278 msgid "" "Use vendor id source (assigner), vendor, product and version information for " "DID profile support. The values are separated by \":\" and @var{assigner}, " "@var{VID}, @var{PID} and @var{version}." msgstr "" #. type: itemize #: doc/guix.texi:23284 msgid "@code{#f} to disable it," msgstr "" #. type: itemize #: doc/guix.texi:23288 msgid "" "@code{\"assigner:1234:5678:abcd\"}, where @var{assigner} is either " "@code{usb} (default) or @code{bluetooth}." msgstr "" #. type: item #: doc/guix.texi:23291 #, no-wrap msgid "@code{reverse-service-discovery?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:23297 msgid "" "Do reverse service discovery for previously unknown devices that connect to " "us. For BR/EDR this option is really only needed for qualification since the " "BITE tester doesn't like us doing reverse SDP for some test cases, for LE " "this disables the GATT client functionally so it can be used in system which " "can only operate as peripheral." msgstr "" #. type: item #: doc/guix.texi:23298 #, no-wrap msgid "@code{name-resolving?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:23301 msgid "" "Enable name resolving after inquiry. Set it to @code{#f} if you don't need " "remote devices name and want shorter discovery cycle." msgstr "" #. type: item #: doc/guix.texi:23302 #, no-wrap msgid "@code{debug-keys?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23306 msgid "" "Enable runtime persistency of debug link keys. Default is false which makes " "debug link keys valid only for the duration of the connection that they were " "created for." msgstr "" #. type: item #: doc/guix.texi:23307 #, no-wrap msgid "@code{controller-mode} (default: @code{'dual})" msgstr "" #. type: table #: doc/guix.texi:23310 msgid "" "Restricts all controllers to the specified transport. @code{'dual} means " "both BR/EDR and LE are enabled (if supported by the hardware)." msgstr "" #. type: code{#1} #: doc/guix.texi:23316 msgid "'dual" msgstr "" #. type: code{#1} #: doc/guix.texi:23319 msgid "'bredr" msgstr "" #. type: code{#1} #: doc/guix.texi:23322 msgid "'le" msgstr "" #. type: item #: doc/guix.texi:23325 #, no-wrap msgid "@code{multi-profile} (default: @code{'off})" msgstr "" #. type: table #: doc/guix.texi:23330 msgid "" "Enables Multi Profile Specification support. This allows to specify if " "system supports only Multiple Profiles Single Device (MPSD) configuration or " "both Multiple Profiles Single Device (MPSD) and Multiple Profiles Multiple " "Devices (MPMD) configurations." msgstr "" #. type: code{#1} #: doc/guix.texi:23336 msgid "'off" msgstr "" #. type: code{#1} #: doc/guix.texi:23339 msgid "'single" msgstr "" #. type: code{#1} #: doc/guix.texi:23342 msgid "'multiple" msgstr "" #. type: item #: doc/guix.texi:23345 #, no-wrap msgid "@code{fast-connectable?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23350 msgid "" "Permanently enables the Fast Connectable setting for adapters that support " "it. When enabled other devices can connect faster to us, however the " "tradeoff is increased power consumptions. This feature will fully work only " "on kernel version 4.1 and newer." msgstr "" #. type: item #: doc/guix.texi:23351 #, no-wrap msgid "@code{privacy} (default: @code{'off})" msgstr "" #. type: table #: doc/guix.texi:23353 msgid "Default privacy settings." msgstr "" #. type: itemize #: doc/guix.texi:23357 msgid "@code{'off}: Disable local privacy" msgstr "" #. type: itemize #: doc/guix.texi:23362 msgid "" "@code{'network/on}: A device will only accept advertising packets from peer " "devices that contain private addresses. It may not be compatible with some " "legacy devices since it requires the use of RPA(s) all the time" msgstr "" #. type: itemize #: doc/guix.texi:23368 msgid "" "@code{'device}: A device in device privacy mode is only concerned about the " "privacy of the device and will accept advertising packets from peer devices " "that contain their Identity Address as well as ones that contain a private " "address, even if the peer device has distributed its IRK in the past" msgstr "" #. type: table #: doc/guix.texi:23372 msgid "and additionally, if @var{controller-mode} is set to @code{'dual}:" msgstr "" #. type: itemize #: doc/guix.texi:23378 msgid "" "@code{'limited-network}: Apply Limited Discoverable Mode to advertising, " "which follows the same policy as to BR/EDR that publishes the identity " "address when discoverable, and Network Privacy Mode for scanning" msgstr "" #. type: itemize #: doc/guix.texi:23383 msgid "" "@code{'limited-device}: Apply Limited Discoverable Mode to advertising, " "which follows the same policy as to BR/EDR that publishes the identity " "address when discoverable, and Device Privacy Mode for scanning." msgstr "" #. type: item #: doc/guix.texi:23386 #, no-wrap msgid "@code{just-works-repairing} (default: @code{'never})" msgstr "" #. type: table #: doc/guix.texi:23388 msgid "Specify the policy to the JUST-WORKS repairing initiated by peer." msgstr "" #. type: table #: doc/guix.texi:23390 doc/guix.texi:23415 doc/guix.texi:23632 msgid "Possible values:" msgstr "" #. type: code{#1} #: doc/guix.texi:23393 msgid "'never" msgstr "" #. type: code{#1} #: doc/guix.texi:23396 msgid "'confirm" msgstr "" #. type: code{#1} #: doc/guix.texi:23399 msgid "'always" msgstr "" #. type: item #: doc/guix.texi:23402 #, no-wrap msgid "@code{temporary-timeout} (default: @code{30})" msgstr "" #. type: table #: doc/guix.texi:23405 msgid "" "How long to keep temporary devices around. The value is in seconds. @code{0} " "disables the timer completely." msgstr "" #. type: item #: doc/guix.texi:23406 #, no-wrap msgid "@code{refresh-discovery?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:23409 msgid "" "Enables the device to issue an SDP request to update known services when " "profile is connected." msgstr "" #. type: item #: doc/guix.texi:23410 #, no-wrap msgid "@code{experimental} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23413 msgid "" "Enables experimental features and interfaces, alternatively a list of UUIDs " "can be given." msgstr "" #. type: itemize #: doc/guix.texi:23425 doc/guix.texi:23639 msgid "@code{(list (uuid ) (uuid ) ...)}." msgstr "" #. type: table #: doc/guix.texi:23428 msgid "List of possible UUIDs:" msgstr "" #. type: itemize #: doc/guix.texi:23431 msgid "@code{d4992530-b9ec-469f-ab01-6c481c47da1c}: BlueZ Experimental Debug," msgstr "" #. type: itemize #: doc/guix.texi:23434 msgid "" "@code{671b10b5-42c0-4696-9227-eb28d1b049d6}: BlueZ Experimental Simultaneous " "Central and Peripheral," msgstr "" #. type: itemize #: doc/guix.texi:23437 msgid "" "@code{\"15c0a148-c273-11ea-b3de-0242ac130004}: BlueZ Experimental LL privacy," msgstr "" #. type: itemize #: doc/guix.texi:23440 msgid "" "@code{330859bc-7506-492d-9370-9a6f0614037f}: BlueZ Experimental Bluetooth " "Quality Report," msgstr "" #. type: itemize #: doc/guix.texi:23443 msgid "" "@code{a6695ace-ee7f-4fb9-881a-5fac66c629af}: BlueZ Experimental Offload " "Codecs." msgstr "" #. type: item #: doc/guix.texi:23445 #, no-wrap msgid "@code{remote-name-request-retry-delay} (default: @code{300})" msgstr "" #. type: table #: doc/guix.texi:23448 msgid "" "The duration to avoid retrying to resolve a peer's name, if the previous try " "failed." msgstr "" #. type: item #: doc/guix.texi:23449 #, no-wrap msgid "@code{page-scan-type} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23451 msgid "BR/EDR Page scan activity type." msgstr "" #. type: item #: doc/guix.texi:23452 #, no-wrap msgid "@code{page-scan-interval} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23454 msgid "BR/EDR Page scan activity interval." msgstr "" #. type: item #: doc/guix.texi:23455 #, no-wrap msgid "@code{page-scan-window} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23457 msgid "BR/EDR Page scan activity window." msgstr "" #. type: item #: doc/guix.texi:23458 #, no-wrap msgid "@code{inquiry-scan-type} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23460 msgid "BR/EDR Inquiry scan activity type." msgstr "" #. type: item #: doc/guix.texi:23461 #, no-wrap msgid "@code{inquiry-scan-interval} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23463 msgid "BR/EDR Inquiry scan activity interval." msgstr "" #. type: item #: doc/guix.texi:23464 #, no-wrap msgid "@code{inquiry-scan-window} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23466 msgid "BR/EDR Inquiry scan activity window." msgstr "" #. type: item #: doc/guix.texi:23467 #, no-wrap msgid "@code{link-supervision-timeout} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23469 msgid "BR/EDR Link supervision timeout." msgstr "" #. type: item #: doc/guix.texi:23470 #, no-wrap msgid "@code{page-timeout} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23472 msgid "BR/EDR Page timeout." msgstr "" #. type: item #: doc/guix.texi:23473 #, no-wrap msgid "@code{min-sniff-interval} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23475 msgid "BR/EDR minimum sniff interval." msgstr "" #. type: item #: doc/guix.texi:23476 #, no-wrap msgid "@code{max-sniff-interval} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23478 msgid "BR/EDR maximum sniff interval." msgstr "" #. type: item #: doc/guix.texi:23479 #, no-wrap msgid "@code{min-advertisement-interval} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23481 msgid "LE minimum advertisement interval (used for legacy advertisement only)." msgstr "" #. type: item #: doc/guix.texi:23482 #, no-wrap msgid "@code{max-advertisement-interval} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23484 msgid "LE maximum advertisement interval (used for legacy advertisement only)." msgstr "" #. type: item #: doc/guix.texi:23485 #, no-wrap msgid "@code{multi-advertisement-rotation-interval} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23487 msgid "LE multiple advertisement rotation interval." msgstr "" #. type: item #: doc/guix.texi:23488 #, no-wrap msgid "@code{scan-interval-auto-connect} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23490 msgid "LE scanning interval used for passive scanning supporting auto connect." msgstr "" #. type: item #: doc/guix.texi:23491 #, no-wrap msgid "@code{scan-window-auto-connect} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23493 msgid "LE scanning window used for passive scanning supporting auto connect." msgstr "" #. type: item #: doc/guix.texi:23494 #, no-wrap msgid "@code{scan-interval-suspend} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23496 msgid "" "LE scanning interval used for active scanning supporting wake from suspend." msgstr "" #. type: item #: doc/guix.texi:23497 #, no-wrap msgid "@code{scan-window-suspend} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23499 msgid "" "LE scanning window used for active scanning supporting wake from suspend." msgstr "" #. type: item #: doc/guix.texi:23500 #, no-wrap msgid "@code{scan-interval-discovery} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23502 msgid "LE scanning interval used for active scanning supporting discovery." msgstr "" #. type: item #: doc/guix.texi:23503 #, no-wrap msgid "@code{scan-window-discovery} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23505 msgid "LE scanning window used for active scanning supporting discovery." msgstr "" #. type: item #: doc/guix.texi:23506 #, no-wrap msgid "@code{scan-interval-adv-monitor} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23508 msgid "" "LE scanning interval used for passive scanning supporting the advertisement " "monitor APIs." msgstr "" #. type: item #: doc/guix.texi:23509 #, no-wrap msgid "@code{scan-window-adv-monitor} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23511 msgid "" "LE scanning window used for passive scanning supporting the advertisement " "monitor APIs." msgstr "" #. type: item #: doc/guix.texi:23512 #, no-wrap msgid "@code{scan-interval-connect} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23514 msgid "LE scanning interval used for connection establishment." msgstr "" #. type: item #: doc/guix.texi:23515 #, no-wrap msgid "@code{scan-window-connect} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23517 msgid "LE scanning window used for connection establishment." msgstr "" #. type: item #: doc/guix.texi:23518 #, no-wrap msgid "@code{min-connection-interval} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23521 msgid "" "LE default minimum connection interval. This value is superseded by any " "specific value provided via the Load Connection Parameters interface." msgstr "" #. type: item #: doc/guix.texi:23522 #, no-wrap msgid "@code{max-connection-interval} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23525 msgid "" "LE default maximum connection interval. This value is superseded by any " "specific value provided via the Load Connection Parameters interface." msgstr "" #. type: item #: doc/guix.texi:23526 #, no-wrap msgid "@code{connection-latency} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23529 msgid "" "LE default connection latency. This value is superseded by any specific " "value provided via the Load Connection Parameters interface." msgstr "" #. type: item #: doc/guix.texi:23530 #, no-wrap msgid "@code{connection-supervision-timeout} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23533 msgid "" "LE default connection supervision timeout. This value is superseded by any " "specific value provided via the Load Connection Parameters interface." msgstr "" #. type: item #: doc/guix.texi:23534 #, no-wrap msgid "@code{autoconnect-timeout} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23537 msgid "" "LE default autoconnect timeout. This value is superseded by any specific " "value provided via the Load Connection Parameters interface." msgstr "" #. type: item #: doc/guix.texi:23538 #, no-wrap msgid "@code{adv-mon-allowlist-scan-duration} (default: @code{300})" msgstr "" #. type: table #: doc/guix.texi:23541 msgid "" "Allowlist scan duration during interleaving scan. Only used when scanning " "for ADV monitors. The units are msec." msgstr "" #. type: item #: doc/guix.texi:23542 #, no-wrap msgid "@code{adv-mon-no-filter-scan-duration} (default: @code{500})" msgstr "" #. type: table #: doc/guix.texi:23545 msgid "" "No filter scan duration during interleaving scan. Only used when scanning " "for ADV monitors. The units are msec." msgstr "" #. type: item #: doc/guix.texi:23546 #, no-wrap msgid "@code{enable-adv-mon-interleave-scan?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:23548 msgid "Enable/Disable Advertisement Monitor interleave scan for power saving." msgstr "" #. type: item #: doc/guix.texi:23549 #, no-wrap msgid "@code{cache} (default: @code{'always})" msgstr "" #. type: table #: doc/guix.texi:23551 msgid "GATT attribute cache." msgstr "" #. type: itemize #: doc/guix.texi:23559 msgid "" "@code{'always}: Always cache attributes even for devices not paired, this is " "recommended as it is best for interoperability, with more consistent " "reconnection times and enables proper tracking of notifications for all " "devices" msgstr "" #. type: itemize #: doc/guix.texi:23562 msgid "@code{'yes}: Only cache attributes of paired devices" msgstr "" #. type: itemize #: doc/guix.texi:23565 msgid "@code{'no}: Never cache attributes." msgstr "" #. type: item #: doc/guix.texi:23567 #, no-wrap msgid "@code{key-size} (default: @code{0})" msgstr "" #. type: table #: doc/guix.texi:23569 msgid "" "Minimum required Encryption Key Size for accessing secured characteristics." msgstr "" #. type: itemize #: doc/guix.texi:23574 msgid "@code{0}: Don't care" msgstr "" #. type: code{#1} #: doc/guix.texi:23577 msgid "7 <= N <= 16" msgstr "" #. type: item #: doc/guix.texi:23579 #, no-wrap msgid "@code{exchange-mtu} (default: @code{517})" msgstr "" #. type: table #: doc/guix.texi:23581 msgid "Exchange MTU size. Possible values are:" msgstr "" #. type: code{#1} #: doc/guix.texi:23585 msgid "23 <= N <= 517" msgstr "" #. type: item #: doc/guix.texi:23587 #, no-wrap msgid "@code{att-channels} (default: @code{3})" msgstr "" #. type: table #: doc/guix.texi:23589 msgid "Number of ATT channels. Possible values are:" msgstr "" #. type: itemize #: doc/guix.texi:23593 msgid "@code{1}: Disables EATT" msgstr "" #. type: code{#1} #: doc/guix.texi:23596 msgid "2 <= N <= 5" msgstr "" #. type: item #: doc/guix.texi:23598 #, no-wrap msgid "@code{session-mode} (default: @code{'basic})" msgstr "" #. type: table #: doc/guix.texi:23600 msgid "AVDTP L2CAP signalling channel mode." msgstr "" #. type: itemize #: doc/guix.texi:23606 doc/guix.texi:23619 msgid "@code{'basic}: Use L2CAP basic mode" msgstr "" #. type: itemize #: doc/guix.texi:23609 msgid "@code{'ertm}: Use L2CAP enhanced retransmission mode." msgstr "" #. type: item #: doc/guix.texi:23611 #, no-wrap msgid "@code{stream-mode} (default: @code{'basic})" msgstr "" #. type: table #: doc/guix.texi:23613 msgid "AVDTP L2CAP transport channel mode." msgstr "" #. type: itemize #: doc/guix.texi:23622 msgid "@code{'streaming}: Use L2CAP streaming mode." msgstr "" #. type: item #: doc/guix.texi:23624 #, no-wrap msgid "@code{reconnect-uuids} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:23630 msgid "" "The ReconnectUUIDs defines the set of remote services that should try to be " "reconnected to in case of a link loss (link supervision timeout). The policy " "plugin should contain a sane set of values by default, but this list can be " "overridden here. By setting the list to empty the reconnection feature gets " "disabled." msgstr "" #. type: code{#1} #: doc/guix.texi:23636 msgid "'()" msgstr "" #. type: item #: doc/guix.texi:23641 #, no-wrap msgid "@code{reconnect-attempts} (default: @code{7})" msgstr "" #. type: table #: doc/guix.texi:23644 msgid "" "Defines the number of attempts to reconnect after a link lost. Setting the " "value to 0 disables reconnecting feature." msgstr "" #. type: item #: doc/guix.texi:23645 #, no-wrap msgid "@code{reconnect-intervals} (default: @code{'(1 2 4 8 16 32 64)})" msgstr "" #. type: table #: doc/guix.texi:23649 msgid "" "Defines a list of intervals in seconds to use in between attempts. If the " "number of attempts defined in @var{reconnect-attempts} is bigger than the " "list of intervals the last interval is repeated until the last attempt." msgstr "" #. type: item #: doc/guix.texi:23650 #, no-wrap msgid "@code{auto-enable?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:23653 msgid "" "Defines option to enable all controllers when they are found. This includes " "adapters present on start as well as adapters that are plugged in later on." msgstr "" #. type: item #: doc/guix.texi:23654 #, no-wrap msgid "@code{resume-delay} (default: @code{2})" msgstr "" #. type: table #: doc/guix.texi:23659 msgid "" "Audio devices that were disconnected due to suspend will be reconnected on " "resume. @var{resume-delay} determines the delay between when the controller " "resumes from suspend and a connection attempt is made. A longer delay is " "better for better co-existence with Wi-Fi. The value is in seconds." msgstr "" #. type: item #: doc/guix.texi:23660 #, no-wrap msgid "@code{rssi-sampling-period} (default: @code{#xFF})" msgstr "" #. type: table #: doc/guix.texi:23663 msgid "" "Default RSSI Sampling Period. This is used when a client registers an " "advertisement monitor and leaves the RSSISamplingPeriod unset." msgstr "" #. type: itemize #: doc/guix.texi:23668 msgid "@code{#x0}: Report all advertisements" msgstr "" #. type: itemize #: doc/guix.texi:23671 msgid "" "@code{N = #xXX}: Report advertisements every N x 100 msec (range: #x01 to " "#xFE)" msgstr "" #. type: itemize #: doc/guix.texi:23674 msgid "" "@code{#xFF}: Report only one advertisement per device during monitoring " "period." msgstr "" #. type: defvr #: doc/guix.texi:23679 #, no-wrap msgid "{Scheme Variable} gnome-keyring-service-type" msgstr "" #. type: defvr #: doc/guix.texi:23683 msgid "" "This is the type of the service that adds the @uref{https://wiki.gnome.org/" "Projects/GnomeKeyring, GNOME Keyring}. Its value is a @code{gnome-keyring-" "configuration} object (see below)." msgstr "" #. type: defvr #: doc/guix.texi:23687 msgid "" "This service adds the @code{gnome-keyring} package to the system profile and " "extends PAM with entries using @code{pam_gnome_keyring.so}, unlocking a " "user's login keyring when they log in or setting its password with passwd." msgstr "" #. type: deftp #: doc/guix.texi:23689 #, no-wrap msgid "{Data Type} gnome-keyring-configuration" msgstr "" #. type: deftp #: doc/guix.texi:23691 msgid "Configuration record for the GNOME Keyring service." msgstr "" #. type: item #: doc/guix.texi:23693 #, no-wrap msgid "@code{keyring} (default: @code{gnome-keyring})" msgstr "" #. type: table #: doc/guix.texi:23695 msgid "The GNOME keyring package to use." msgstr "" #. type: code{#1} #: doc/guix.texi:23696 #, no-wrap msgid "pam-services" msgstr "" #. type: table #: doc/guix.texi:23701 msgid "" "A list of @code{(@var{service} . @var{kind})} pairs denoting PAM services to " "extend, where @var{service} is the name of an existing service to extend and " "@var{kind} is one of @code{login} or @code{passwd}." msgstr "" #. type: table #: doc/guix.texi:23707 msgid "" "If @code{login} is given, it adds an optional @code{pam_gnome_keyring.so} to " "the auth block without arguments and to the session block with " "@code{auto_start}. If @code{passwd} is given, it adds an optional " "@code{pam_gnome_keyring.so} to the password block without arguments." msgstr "" #. type: table #: doc/guix.texi:23710 msgid "" "By default, this field contains ``gdm-password'' with the value @code{login} " "and ``passwd'' is with the value @code{passwd}." msgstr "" #. type: defvr #: doc/guix.texi:23713 #, no-wrap msgid "{Scheme Variable} seatd-service-type" msgstr "" #. type: defvr #: doc/guix.texi:23716 msgid "" "@uref{https://sr.ht/~kennylevinsen/seatd/, seatd} is a minimal seat " "management daemon." msgstr "" #. type: defvr #: doc/guix.texi:23719 msgid "" "Seat management takes care of mediating access to shared devices (graphics, " "input), without requiring the applications needing access to be root." msgstr "" #. type: lisp #: doc/guix.texi:23725 #, no-wrap msgid "" "(append\n" " (list\n" " ;; make sure seatd is running\n" " (service seatd-service-type))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:23728 #, no-wrap msgid "" " ;; normally one would want %base-services\n" " %base-services)\n" "\n" msgstr "" #. type: defvr #: doc/guix.texi:23737 msgid "" "@code{seatd} operates over a UNIX domain socket, with @code{libseat} " "providing the client side of the protocol. Applications that acquire access " "to the shared resources via @code{seatd} (e.g. @code{sway}) need to be able " "to talk to this socket. This can be achieved by adding the user they run " "under to the group owning @code{seatd}'s socket (usually ``seat''), like so:" msgstr "" #. type: lisp #: doc/guix.texi:23748 #, no-wrap msgid "" "(user-account\n" " (name \"alice\")\n" " (group \"users\")\n" " (supplementary-groups '(\"wheel\" ; allow use of sudo, etc.\n" " \"seat\" ; seat management\n" " \"audio\" ; sound card\n" " \"video\" ; video devices such as webcams\n" " \"cdrom\")) ; the good ol' CD-ROM\n" " (comment \"Bob's sister\"))\n" msgstr "" #. type: defvr #: doc/guix.texi:23753 msgid "" "Depending on your setup, you will have to not only add regular users, but " "also system users to this group. For instance, some greetd greeters require " "graphics and therefore also need to negotiate with seatd." msgstr "" #. type: deftp #: doc/guix.texi:23756 #, no-wrap msgid "{Data Type} seatd-configuration" msgstr "" #. type: deftp #: doc/guix.texi:23758 msgid "Configuration record for the seatd daemon service." msgstr "" #. type: item #: doc/guix.texi:23760 #, no-wrap msgid "@code{seatd} (default: @code{seatd})" msgstr "" #. type: table #: doc/guix.texi:23762 msgid "The seatd package to use." msgstr "" #. type: item #: doc/guix.texi:23763 #, no-wrap msgid "@code{group} (default: @samp{\"seat\"})" msgstr "" #. type: table #: doc/guix.texi:23765 msgid "Group to own the seatd socket." msgstr "" #. type: item #: doc/guix.texi:23766 #, no-wrap msgid "@code{socket} (default: @samp{\"/run/seatd.sock\"})" msgstr "" #. type: table #: doc/guix.texi:23768 msgid "Where to create the seatd socket." msgstr "" #. type: item #: doc/guix.texi:23769 #, no-wrap msgid "@code{logfile} (default: @samp{\"/var/log/seatd.log\"})" msgstr "" #. type: table #: doc/guix.texi:23771 msgid "Log file to write to." msgstr "" #. type: item #: doc/guix.texi:23772 #, no-wrap msgid "@code{loglevel} (default: @samp{\"error\"})" msgstr "" #. type: table #: doc/guix.texi:23775 msgid "" "Log level to output logs. Possible values: @samp{\"silent\"}, @samp{\"error" "\"}, @samp{\"info\"} and @samp{\"debug\"}." msgstr "" #. type: cindex #: doc/guix.texi:23783 #, no-wrap msgid "sound support" msgstr "" #. type: cindex #: doc/guix.texi:23784 #, no-wrap msgid "ALSA" msgstr "" #. type: cindex #: doc/guix.texi:23785 #, no-wrap msgid "PulseAudio, sound support" msgstr "" #. type: Plain text #: doc/guix.texi:23790 msgid "" "The @code{(gnu services sound)} module provides a service to configure the " "Advanced Linux Sound Architecture (ALSA) system, which makes PulseAudio the " "preferred ALSA output driver." msgstr "" #. type: deffn #: doc/guix.texi:23791 #, no-wrap msgid "{Scheme Variable} alsa-service-type" msgstr "" #. type: deffn #: doc/guix.texi:23796 msgid "" "This is the type for the @uref{https://alsa-project.org/, Advanced Linux " "Sound Architecture} (ALSA) system, which generates the @file{/etc/asound." "conf} configuration file. The value for this type is a @command{alsa-" "configuration} record as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:23799 #, no-wrap msgid "(service alsa-service-type)\n" msgstr "" #. type: deffn #: doc/guix.texi:23802 msgid "See below for details about @code{alsa-configuration}." msgstr "" #. type: deftp #: doc/guix.texi:23804 #, no-wrap msgid "{Data Type} alsa-configuration" msgstr "" #. type: deftp #: doc/guix.texi:23806 msgid "Data type representing the configuration for @code{alsa-service}." msgstr "" #. type: item #: doc/guix.texi:23808 #, no-wrap msgid "@code{alsa-plugins} (default: @var{alsa-plugins})" msgstr "" #. type: table #: doc/guix.texi:23810 msgid "@code{alsa-plugins} package to use." msgstr "" #. type: item #: doc/guix.texi:23811 #, no-wrap msgid "@code{pulseaudio?} (default: @var{#t})" msgstr "" #. type: table #: doc/guix.texi:23814 msgid "" "Whether ALSA applications should transparently be made to use the " "@uref{https://www.pulseaudio.org/, PulseAudio} sound server." msgstr "" #. type: table #: doc/guix.texi:23818 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:23819 #, no-wrap msgid "@code{extra-options} (default: @var{\"\"})" msgstr "" #. type: table #: doc/guix.texi:23821 msgid "String to append to the @file{/etc/asound.conf} file." msgstr "" #. type: Plain text #: doc/guix.texi:23827 msgid "" "Individual users who want to override the system configuration of ALSA can " "do it with the @file{~/.asoundrc} file:" msgstr "" #. type: example #: doc/guix.texi:23833 #, no-wrap msgid "" "# In guix, we have to specify the absolute path for plugins.\n" "pcm_type.jack @{\n" " lib \"/home/alice/.guix-profile/lib/alsa-lib/libasound_module_pcm_jack.so\"\n" "@}\n" "\n" msgstr "" #. type: example #: doc/guix.texi:23842 #, no-wrap msgid "" "# Routing ALSA to jack:\n" "# .\n" "pcm.rawjack @{\n" " type jack\n" " playback_ports @{\n" " 0 system:playback_1\n" " 1 system:playback_2\n" " @}\n" "\n" msgstr "" #. type: example #: doc/guix.texi:23848 #, no-wrap msgid "" " capture_ports @{\n" " 0 system:capture_1\n" " 1 system:capture_2\n" " @}\n" "@}\n" "\n" msgstr "" #. type: example #: doc/guix.texi:23855 #, no-wrap msgid "" "pcm.!default @{\n" " type plug\n" " slave @{\n" " pcm \"rawjack\"\n" " @}\n" "@}\n" msgstr "" #. type: Plain text #: doc/guix.texi:23859 msgid "" "See @uref{https://www.alsa-project.org/main/index.php/Asoundrc} for the " "details." msgstr "" #. type: deffn #: doc/guix.texi:23860 #, no-wrap msgid "{Scheme Variable} pulseaudio-service-type" msgstr "" #. type: deffn #: doc/guix.texi:23864 msgid "" "This is the type for the @uref{https://www.pulseaudio.org/, PulseAudio} " "sound server. It exists to allow system overrides of the default settings " "via @code{pulseaudio-configuration}, see below." msgstr "" #. type: quotation #: doc/guix.texi:23870 msgid "" "This service overrides per-user configuration files. If you want PulseAudio " "to honor configuration files in @file{~/.config/pulse} you have to unset the " "environment variables @env{PULSE_CONFIG} and @env{PULSE_CLIENTCONFIG} in " "your @file{~/.bash_profile}." msgstr "" #. type: quotation #: doc/guix.texi:23878 msgid "" "This service on its own does not ensure, that the @code{pulseaudio} package " "exists on your machine. It merely adds configuration files for it, as " "detailed below. In the (admittedly unlikely) case, that you find yourself " "without a @code{pulseaudio} package, consider enabling it through the " "@code{alsa-service-type} above." msgstr "" #. type: deftp #: doc/guix.texi:23881 #, no-wrap msgid "{Data Type} pulseaudio-configuration" msgstr "" #. type: deftp #: doc/guix.texi:23883 msgid "Data type representing the configuration for @code{pulseaudio-service}." msgstr "" #. type: item #: doc/guix.texi:23885 #, no-wrap msgid "@code{client-conf} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:23890 msgid "" "List of settings to set in @file{client.conf}. Accepts a list of strings or " "symbol-value pairs. A string will be inserted as-is with a newline added. " "A pair will be formatted as ``key = value'', again with a newline added." msgstr "" #. type: item #: doc/guix.texi:23891 #, no-wrap msgid "@code{daemon-conf} (default: @code{'((flat-volumes . no))})" msgstr "" #. type: table #: doc/guix.texi:23894 msgid "" "List of settings to set in @file{daemon.conf}, formatted just like " "@var{client-conf}." msgstr "" #. type: item #: doc/guix.texi:23895 #, no-wrap msgid "@code{script-file} (default: @code{(file-append pulseaudio \"/etc/pulse/default.pa\")})" msgstr "" #. type: table #: doc/guix.texi:23900 msgid "" "Script file to use as @file{default.pa}. In case the @code{extra-script-" "files} field below is used, an @code{.include} directive pointing to @file{/" "etc/pulse/default.pa.d} is appended to the provided script." msgstr "" #. type: item #: doc/guix.texi:23901 #, no-wrap msgid "@code{extra-script-files} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:23908 msgid "" "A list of file-like objects defining extra PulseAudio scripts to run at the " "initialization of the @command{pulseaudio} daemon, after the main " "@code{script-file}. The scripts are deployed to the @file{/etc/pulse/" "default.pa.d} directory; they should have the @samp{.pa} file name " "extension. For a reference of the available commands, refer to @command{man " "pulse-cli-syntax}." msgstr "" #. type: item #: doc/guix.texi:23909 #, no-wrap msgid "@code{system-script-file} (default: @code{(file-append pulseaudio \"/etc/pulse/system.pa\")})" msgstr "" #. type: table #: doc/guix.texi:23911 msgid "Script file to use as @file{system.pa}." msgstr "" #. type: deftp #: doc/guix.texi:23916 msgid "" "The example below sets the default PulseAudio card profile, the default sink " "and the default source to use for a old SoundBlaster Audigy sound card:" msgstr "" #. type: lisp #: doc/guix.texi:23925 #, no-wrap msgid "" "(pulseaudio-configuration\n" " (extra-script-files\n" " (list (plain-file \"audigy.pa\"\n" " (string-append \"\\\n" "set-card-profile alsa_card.pci-0000_01_01.0 \\\n" " output:analog-surround-40+input:analog-mono\n" "set-default-source alsa_input.pci-0000_01_01.0.analog-mono\n" "set-default-sink alsa_output.pci-0000_01_01.0.analog-surround-40\\n\")))))\n" msgstr "" #. type: deftp #: doc/guix.texi:23933 msgid "" "Note that @code{pulseaudio-service-type} is part of @code{%desktop-" "services}; if your operating system declaration was derived from one of the " "desktop templates, you'll want to adjust the above example to modify the " "existing @code{pulseaudio-service-type} via @code{modify-services} " "(@pxref{Service Reference, @code{modify-services}}), instead of defining a " "new one." msgstr "" #. type: deffn #: doc/guix.texi:23936 #, no-wrap msgid "{Scheme Variable} ladspa-service-type" msgstr "" #. type: deffn #: doc/guix.texi:23939 msgid "" "This service sets the @var{LADSPA_PATH} variable, so that programs, which " "respect it, e.g. PulseAudio, can load LADSPA plugins." msgstr "" #. type: deffn #: doc/guix.texi:23942 msgid "" "The following example will setup the service to enable modules from the " "@code{swh-plugins} package:" msgstr "" #. type: lisp #: doc/guix.texi:23946 #, no-wrap msgid "" "(service ladspa-service-type\n" " (ladspa-configuration (plugins (list swh-plugins))))\n" msgstr "" #. type: deffn #: doc/guix.texi:23950 msgid "" "See @uref{http://plugin.org.uk/ladspa-swh/docs/ladspa-swh.html} for the " "details." msgstr "" #. type: cindex #: doc/guix.texi:23957 #, no-wrap msgid "SQL" msgstr "" #. type: Plain text #: doc/guix.texi:23959 msgid "" "The @code{(gnu services databases)} module provides the following services." msgstr "" #. type: subsubheading #: doc/guix.texi:23960 #, no-wrap msgid "PostgreSQL" msgstr "" #. type: Plain text #: doc/guix.texi:23964 msgid "" "The following example describes a PostgreSQL service with the default " "configuration." msgstr "" #. type: lisp #: doc/guix.texi:23969 #, no-wrap msgid "" "(service postgresql-service-type\n" " (postgresql-configuration\n" " (postgresql postgresql-10)))\n" msgstr "" #. type: Plain text #: doc/guix.texi:23975 msgid "" "If the services fails to start, it may be due to an incompatible cluster " "already present in @var{data-directory}. Adjust it (or, if you don't need " "the cluster anymore, delete @var{data-directory}), then restart the service." msgstr "" #. type: Plain text #: doc/guix.texi:23982 msgid "" "Peer authentication is used by default and the @code{postgres} user account " "has no shell, which prevents the direct execution of @code{psql} commands as " "this user. To use @code{psql}, you can temporarily log in as " "@code{postgres} using a shell, create a PostgreSQL superuser with the same " "name as one of the system users and then create the associated database." msgstr "" #. type: example #: doc/guix.texi:23987 #, no-wrap msgid "" "sudo -u postgres -s /bin/sh\n" "createuser --interactive\n" "createdb $MY_USER_LOGIN # Replace appropriately.\n" msgstr "" #. type: deftp #: doc/guix.texi:23989 #, no-wrap msgid "{Data Type} postgresql-configuration" msgstr "" #. type: deftp #: doc/guix.texi:23992 msgid "" "Data type representing the configuration for the @code{postgresql-service-" "type}." msgstr "" #. type: code{#1} #: doc/guix.texi:23994 #, no-wrap msgid "postgresql" msgstr "" #. type: table #: doc/guix.texi:23996 msgid "PostgreSQL package to use for the service." msgstr "" #. type: item #: doc/guix.texi:23997 #, no-wrap msgid "@code{port} (default: @code{5432})" msgstr "" #. type: table #: doc/guix.texi:23999 msgid "Port on which PostgreSQL should listen." msgstr "" #. type: table #: doc/guix.texi:24002 msgid "Locale to use as the default when creating the database cluster." msgstr "" #. type: item #: doc/guix.texi:24003 #, no-wrap msgid "@code{config-file} (default: @code{(postgresql-config-file)})" msgstr "" #. type: table #: doc/guix.texi:24007 msgid "" "The configuration file to use when running PostgreSQL@. The default " "behaviour uses the postgresql-config-file record with the default values for " "the fields." msgstr "" #. type: item #: doc/guix.texi:24008 #, no-wrap msgid "@code{log-directory} (default: @code{\"/var/log/postgresql\"})" msgstr "" #. type: table #: doc/guix.texi:24012 msgid "" "The directory where @command{pg_ctl} output will be written in a file named " "@code{\"pg_ctl.log\"}. This file can be useful to debug PostgreSQL " "configuration errors for instance." msgstr "" #. type: item #: doc/guix.texi:24013 #, no-wrap msgid "@code{data-directory} (default: @code{\"/var/lib/postgresql/data\"})" msgstr "" #. type: table #: doc/guix.texi:24015 msgid "Directory in which to store the data." msgstr "" #. type: item #: doc/guix.texi:24016 #, no-wrap msgid "@code{extension-packages} (default: @code{'()})" msgstr "" #. type: cindex #: doc/guix.texi:24017 #, no-wrap msgid "postgresql extension-packages" msgstr "" #. type: table #: doc/guix.texi:24022 msgid "" "Additional extensions are loaded from packages listed in @var{extension-" "packages}. Extensions are available at runtime. For instance, to create a " "geographic database using the @code{postgis} extension, a user can configure " "the postgresql-service as in this example:" msgstr "" #. type: cindex #: doc/guix.texi:24023 #, no-wrap msgid "postgis" msgstr "" #. type: lisp #: doc/guix.texi:24026 #, no-wrap msgid "" "(use-package-modules databases geo)\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:24039 #, no-wrap msgid "" "(operating-system\n" " ...\n" " ;; postgresql is required to run `psql' but postgis is not required for\n" " ;; proper operation.\n" " (packages (cons* postgresql %base-packages))\n" " (services\n" " (cons*\n" " (service postgresql-service-type\n" " (postgresql-configuration\n" " (postgresql postgresql-10)\n" " (extension-packages (list postgis))))\n" " %base-services)))\n" msgstr "" #. type: table #: doc/guix.texi:24043 msgid "" "Then the extension becomes visible and you can initialise an empty " "geographic database in this way:" msgstr "" #. type: example #: doc/guix.texi:24050 #, no-wrap msgid "" "psql -U postgres\n" "> create database postgistest;\n" "> \\connect postgistest;\n" "> create extension postgis;\n" "> create extension postgis_topology;\n" msgstr "" #. type: table #: doc/guix.texi:24055 msgid "" "There is no need to add this field for contrib extensions such as hstore or " "dblink as they are already loadable by postgresql. This field is only " "required to add extensions provided by other packages." msgstr "" #. type: deftp #: doc/guix.texi:24059 #, no-wrap msgid "{Data Type} postgresql-config-file" msgstr "" #. type: deftp #: doc/guix.texi:24065 msgid "" "Data type representing the PostgreSQL configuration file. As shown in the " "following example, this can be used to customize the configuration of " "PostgreSQL@. Note that you can use any G-expression or filename in place of " "this record, if you already have a configuration file you'd like to use for " "example." msgstr "" #. type: lisp #: doc/guix.texi:24085 #, no-wrap msgid "" "(service postgresql-service-type\n" " (postgresql-configuration\n" " (config-file\n" " (postgresql-config-file\n" " (log-destination \"stderr\")\n" " (hba-file\n" " (plain-file \"pg_hba.conf\"\n" " \"\n" "local\tall\tall\t\t\ttrust\n" "host\tall\tall\t127.0.0.1/32 \tmd5\n" "host\tall\tall\t::1/128 \tmd5\"))\n" " (extra-config\n" " '((\"session_preload_libraries\" \"auto_explain\")\n" " (\"random_page_cost\" 2)\n" " (\"auto_explain.log_min_duration\" \"100 ms\")\n" " (\"work_mem\" \"500 MB\")\n" " (\"logging_collector\" #t)\n" " (\"log_directory\" \"/var/log/postgresql\")))))))\n" msgstr "" #. type: item #: doc/guix.texi:24088 #, no-wrap msgid "@code{log-destination} (default: @code{\"syslog\"})" msgstr "" #. type: table #: doc/guix.texi:24091 msgid "" "The logging method to use for PostgreSQL@. Multiple values are accepted, " "separated by commas." msgstr "" #. type: item #: doc/guix.texi:24092 #, no-wrap msgid "@code{hba-file} (default: @code{%default-postgres-hba})" msgstr "" #. type: table #: doc/guix.texi:24095 msgid "" "Filename or G-expression for the host-based authentication configuration." msgstr "" #. type: item #: doc/guix.texi:24096 #, no-wrap msgid "@code{ident-file} (default: @code{%default-postgres-ident})" msgstr "" #. type: table #: doc/guix.texi:24098 msgid "Filename or G-expression for the user name mapping configuration." msgstr "" #. type: item #: doc/guix.texi:24099 #, no-wrap msgid "@code{socket-directory} (default: @code{\"/var/run/postgresql\"})" msgstr "" #. type: table #: doc/guix.texi:24104 msgid "" "Specifies the directory of the Unix-domain socket(s) on which PostgreSQL is " "to listen for connections from client applications. If set to @code{\"\"} " "PostgreSQL does not listen on any Unix-domain sockets, in which case only " "TCP/IP sockets can be used to connect to the server." msgstr "" #. type: table #: doc/guix.texi:24107 msgid "" "By default, the @code{#false} value means the PostgreSQL default value will " "be used, which is currently @samp{/tmp}." msgstr "" #. type: table #: doc/guix.texi:24112 msgid "" "List of additional keys and values to include in the PostgreSQL config " "file. Each entry in the list should be a list where the first element is " "the key, and the remaining elements are the values." msgstr "" #. type: table #: doc/guix.texi:24118 msgid "" "The values can be numbers, booleans or strings and will be mapped to " "PostgreSQL parameters types @code{Boolean}, @code{String}, @code{Numeric}, " "@code{Numeric with Unit} and @code{Enumerated} described @uref{https://www." "postgresql.org/docs/current/config-setting.html, here}." msgstr "" #. type: deffn #: doc/guix.texi:24122 #, no-wrap msgid "{Scheme Variable} postgresql-role-service-type" msgstr "" #. type: deffn #: doc/guix.texi:24125 msgid "" "This service allows to create PostgreSQL roles and databases after " "PostgreSQL service start. Here is an example of its use." msgstr "" #. type: lisp #: doc/guix.texi:24133 #, no-wrap msgid "" "(service postgresql-role-service-type\n" " (postgresql-role-configuration\n" " (roles\n" " (list (postgresql-role\n" " (name \"test\")\n" " (create-database? #t))))))\n" msgstr "" #. type: deffn #: doc/guix.texi:24137 msgid "This service can be extended with extra roles, as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:24143 #, no-wrap msgid "" "(service-extension postgresql-role-service-type\n" " (const (postgresql-role\n" " (name \"alice\")\n" " (create-database? #t))))\n" msgstr "" #. type: deftp #: doc/guix.texi:24146 #, no-wrap msgid "{Data Type} postgresql-role" msgstr "" #. type: deftp #: doc/guix.texi:24152 msgid "" "PostgreSQL manages database access permissions using the concept of roles. " "A role can be thought of as either a database user, or a group of database " "users, depending on how the role is set up. Roles can own database objects " "(for example, tables) and can assign privileges on those objects to other " "roles to control who has access to which objects." msgstr "" #. type: table #: doc/guix.texi:24156 msgid "The role name." msgstr "" #. type: item #: doc/guix.texi:24157 #, no-wrap msgid "@code{permissions} (default: @code{'(createdb login)})" msgstr "" #. type: table #: doc/guix.texi:24161 msgid "" "The role permissions list. Supported permissions are @code{bypassrls}, " "@code{createdb}, @code{createrole}, @code{login}, @code{replication} and " "@code{superuser}." msgstr "" #. type: item #: doc/guix.texi:24162 #, no-wrap msgid "@code{create-database?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:24164 msgid "Whether to create a database with the same name as the role." msgstr "" #. type: deftp #: doc/guix.texi:24168 #, no-wrap msgid "{Data Type} postgresql-role-configuration" msgstr "" #. type: deftp #: doc/guix.texi:24171 msgid "" "Data type representing the configuration of @var{postgresql-role-service-" "type}." msgstr "" #. type: item #: doc/guix.texi:24173 #, no-wrap msgid "@code{host} (default: @code{\"/var/run/postgresql\"})" msgstr "" #. type: table #: doc/guix.texi:24175 msgid "The PostgreSQL host to connect to." msgstr "" #. type: item #: doc/guix.texi:24176 #, no-wrap msgid "@code{log} (default: @code{\"/var/log/postgresql_roles.log\"})" msgstr "" #. type: table #: doc/guix.texi:24178 msgid "File name of the log file." msgstr "" #. type: item #: doc/guix.texi:24179 #, no-wrap msgid "@code{roles} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:24181 msgid "The initial PostgreSQL roles to create." msgstr "" #. type: subsubheading #: doc/guix.texi:24184 #, no-wrap msgid "MariaDB/MySQL" msgstr "" #. type: defvr #: doc/guix.texi:24186 #, no-wrap msgid "{Scheme Variable} mysql-service-type" msgstr "" #. type: defvr #: doc/guix.texi:24190 msgid "" "This is the service type for a MySQL or MariaDB database server. Its value " "is a @code{mysql-configuration} object that specifies which package to use, " "as well as various settings for the @command{mysqld} daemon." msgstr "" #. type: deftp #: doc/guix.texi:24192 #, no-wrap msgid "{Data Type} mysql-configuration" msgstr "" #. type: deftp #: doc/guix.texi:24194 msgid "Data type representing the configuration of @var{mysql-service-type}." msgstr "" #. type: item #: doc/guix.texi:24196 #, no-wrap msgid "@code{mysql} (default: @var{mariadb})" msgstr "" #. type: table #: doc/guix.texi:24199 msgid "" "Package object of the MySQL database server, can be either @var{mariadb} or " "@var{mysql}." msgstr "" #. type: table #: doc/guix.texi:24202 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:24203 doc/guix.texi:28041 #, no-wrap msgid "@code{bind-address} (default: @code{\"127.0.0.1\"})" msgstr "" #. type: table #: doc/guix.texi:24206 msgid "" "The IP on which to listen for network connections. Use @code{\"0.0.0.0\"} " "to bind to all available network interfaces." msgstr "" #. type: item #: doc/guix.texi:24207 #, no-wrap msgid "@code{port} (default: @code{3306})" msgstr "" #. type: table #: doc/guix.texi:24209 msgid "TCP port on which the database server listens for incoming connections." msgstr "" #. type: item #: doc/guix.texi:24210 #, no-wrap msgid "@code{socket} (default: @code{\"/run/mysqld/mysqld.sock\"})" msgstr "" #. type: table #: doc/guix.texi:24212 msgid "Socket file to use for local (non-network) connections." msgstr "" #. type: table #: doc/guix.texi:24215 msgid "Additional settings for the @file{my.cnf} configuration file." msgstr "" #. type: item #: doc/guix.texi:24216 #, no-wrap msgid "@code{extra-environment} (default: @code{#~'()})" msgstr "" #. type: table #: doc/guix.texi:24218 msgid "List of environment variables passed to the @command{mysqld} process." msgstr "" #. type: item #: doc/guix.texi:24219 #, no-wrap msgid "@code{auto-upgrade?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:24224 msgid "" "Whether to automatically run @command{mysql_upgrade} after starting the " "service. This is necessary to upgrade the @dfn{system schema} after " "``major'' updates (such as switching from MariaDB 10.4 to 10.5), but can be " "disabled if you would rather do that manually." msgstr "" #. type: subsubheading #: doc/guix.texi:24228 #, no-wrap msgid "Memcached" msgstr "" #. type: defvr #: doc/guix.texi:24230 #, no-wrap msgid "{Scheme Variable} memcached-service-type" msgstr "" #. type: defvr #: doc/guix.texi:24234 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: lisp #: doc/guix.texi:24238 #, no-wrap msgid "(service memcached-service-type)\n" msgstr "" #. type: deftp #: doc/guix.texi:24240 #, no-wrap msgid "{Data Type} memcached-configuration" msgstr "" #. type: deftp #: doc/guix.texi:24242 msgid "Data type representing the configuration of memcached." msgstr "" #. type: item #: doc/guix.texi:24244 #, no-wrap msgid "@code{memcached} (default: @code{memcached})" msgstr "" #. type: table #: doc/guix.texi:24246 msgid "The Memcached package to use." msgstr "" #. type: item #: doc/guix.texi:24247 #, no-wrap msgid "@code{interfaces} (default: @code{'(\"0.0.0.0\")})" msgstr "" #. type: table #: doc/guix.texi:24249 msgid "Network interfaces on which to listen." msgstr "" #. type: item #: doc/guix.texi:24250 #, no-wrap msgid "@code{tcp-port} (default: @code{11211})" msgstr "" #. type: table #: doc/guix.texi:24252 msgid "Port on which to accept connections." msgstr "" #. type: item #: doc/guix.texi:24253 #, no-wrap msgid "@code{udp-port} (default: @code{11211})" msgstr "" #. type: table #: doc/guix.texi:24256 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:24257 #, no-wrap msgid "@code{additional-options} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:24259 msgid "Additional command line options to pass to @code{memcached}." msgstr "" #. type: subsubheading #: doc/guix.texi:24262 #, no-wrap msgid "Redis" msgstr "" #. type: defvr #: doc/guix.texi:24264 #, no-wrap msgid "{Scheme Variable} redis-service-type" msgstr "" #. type: defvr #: doc/guix.texi:24267 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:24269 #, no-wrap msgid "{Data Type} redis-configuration" msgstr "" #. type: deftp #: doc/guix.texi:24271 msgid "Data type representing the configuration of redis." msgstr "" #. type: item #: doc/guix.texi:24273 #, no-wrap msgid "@code{redis} (default: @code{redis})" msgstr "" #. type: table #: doc/guix.texi:24275 msgid "The Redis package to use." msgstr "" #. type: item #: doc/guix.texi:24276 #, no-wrap msgid "@code{bind} (default: @code{\"127.0.0.1\"})" msgstr "" #. type: table #: doc/guix.texi:24278 msgid "Network interface on which to listen." msgstr "" #. type: item #: doc/guix.texi:24279 #, no-wrap msgid "@code{port} (default: @code{6379})" msgstr "" #. type: table #: doc/guix.texi:24282 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:24283 #, no-wrap msgid "@code{working-directory} (default: @code{\"/var/lib/redis\"})" msgstr "" #. type: table #: doc/guix.texi:24285 msgid "Directory in which to store the database and related files." msgstr "" #. type: cindex #: doc/guix.texi:24291 #, no-wrap msgid "mail" msgstr "" #. type: cindex #: doc/guix.texi:24292 #, no-wrap msgid "email" msgstr "" #. type: Plain text #: doc/guix.texi:24297 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:24298 #, no-wrap msgid "Dovecot Service" msgstr "" #. type: deffn #: doc/guix.texi:24300 #, no-wrap msgid "{Scheme Procedure} dovecot-service [#:config (dovecot-configuration)]" msgstr "" #. type: deffn #: doc/guix.texi:24302 msgid "Return a service that runs the Dovecot IMAP/POP3/LMTP mail server." msgstr "" #. type: Plain text #: doc/guix.texi:24312 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:24315 msgid "" "For example, to specify that mail is located at @code{maildir~/.mail}, one " "would instantiate the Dovecot service like this:" msgstr "" #. type: lisp #: doc/guix.texi:24320 #, no-wrap msgid "" "(dovecot-service #:config\n" " (dovecot-configuration\n" " (mail-location \"maildir:~/.mail\")))\n" msgstr "" #. type: Plain text #: doc/guix.texi:24328 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:24338 msgid "Available @code{dovecot-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:24339 #, no-wrap msgid "{@code{dovecot-configuration} parameter} package dovecot" msgstr "" #. type: deftypevr #: doc/guix.texi:24341 doc/guix.texi:25690 msgid "The dovecot package." msgstr "" #. type: deftypevr #: doc/guix.texi:24343 #, no-wrap msgid "{@code{dovecot-configuration} parameter} comma-separated-string-list listen" msgstr "" #. type: deftypevr #: doc/guix.texi:24349 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:24351 #, no-wrap msgid "{@code{dovecot-configuration} parameter} protocol-configuration-list protocols" msgstr "" #. type: deftypevr #: doc/guix.texi:24354 msgid "" "List of protocols we want to serve. Available protocols include " "@samp{imap}, @samp{pop3}, and @samp{lmtp}." msgstr "" #. type: deftypevr #: doc/guix.texi:24356 msgid "Available @code{protocol-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:24357 #, no-wrap msgid "{@code{protocol-configuration} parameter} string name" msgstr "" #. type: deftypevr #: doc/guix.texi:24359 msgid "The name of the protocol." msgstr "" #. type: deftypevr #: doc/guix.texi:24361 #, no-wrap msgid "{@code{protocol-configuration} parameter} string auth-socket-path" msgstr "" #. type: deftypevr #: doc/guix.texi:24365 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:24367 #, no-wrap msgid "{@code{protocol-configuration} parameter} boolean imap-metadata?" msgstr "" #. type: deftypevr #: doc/guix.texi:24372 msgid "" "Whether to enable the @code{IMAP METADATA} extension as defined in " "@uref{https://tools.ietf.org/html/rfc5464,RFC@tie{}5464}, which provides a " "means for clients to set and retrieve per-mailbox, per-user metadata and " "annotations over IMAP." msgstr "" #. type: deftypevr #: doc/guix.texi:24375 msgid "" "If this is @samp{#t}, you must also specify a dictionary @i{via} the " "@code{mail-attribute-dict} setting." msgstr "" #. type: deftypevr #: doc/guix.texi:24380 #, no-wrap msgid "{@code{protocol-configuration} parameter} space-separated-string-list managesieve-notify-capabilities" msgstr "" #. type: deftypevr #: doc/guix.texi:24385 msgid "" "Which NOTIFY capabilities to report to clients that first connect to the " "ManageSieve service, before authentication. These may differ from the " "capabilities offered to authenticated users. If this field is left empty, " "report what the Sieve interpreter supports by default." msgstr "" #. type: deftypevr #: doc/guix.texi:24389 #, no-wrap msgid "{@code{protocol-configuration} parameter} space-separated-string-list managesieve-sieve-capability" msgstr "" #. type: deftypevr #: doc/guix.texi:24394 msgid "" "Which SIEVE capabilities to report to clients that first connect to the " "ManageSieve service, before authentication. These may differ from the " "capabilities offered to authenticated users. If this field is left empty, " "report what the Sieve interpreter supports by default." msgstr "" #. type: deftypevr #: doc/guix.texi:24399 #, no-wrap msgid "{@code{protocol-configuration} parameter} space-separated-string-list mail-plugins" msgstr "" #. type: deftypevr #: doc/guix.texi:24401 msgid "Space separated list of plugins to load." msgstr "" #. type: deftypevr #: doc/guix.texi:24403 #, no-wrap msgid "{@code{protocol-configuration} parameter} non-negative-integer mail-max-userip-connections" msgstr "" #. type: deftypevr #: doc/guix.texi:24407 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:24411 #, no-wrap msgid "{@code{dovecot-configuration} parameter} service-configuration-list services" msgstr "" #. type: deftypevr #: doc/guix.texi:24415 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:24417 msgid "Available @code{service-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:24418 #, no-wrap msgid "{@code{service-configuration} parameter} string kind" msgstr "" #. type: deftypevr #: doc/guix.texi:24423 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:24425 #, no-wrap msgid "{@code{service-configuration} parameter} listener-configuration-list listeners" msgstr "" #. type: deftypevr #: doc/guix.texi:24430 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:24432 msgid "Available @code{unix-listener-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:24433 #, no-wrap msgid "{@code{unix-listener-configuration} parameter} string path" msgstr "" #. type: deftypevr #: doc/guix.texi:24436 doc/guix.texi:24459 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:24438 #, no-wrap msgid "{@code{unix-listener-configuration} parameter} string mode" msgstr "" #. type: deftypevr #: doc/guix.texi:24441 doc/guix.texi:24464 msgid "The access mode for the socket. Defaults to @samp{\"0600\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:24443 #, no-wrap msgid "{@code{unix-listener-configuration} parameter} string user" msgstr "" #. type: deftypevr #: doc/guix.texi:24446 doc/guix.texi:24469 msgid "The user to own the socket. Defaults to @samp{\"\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:24448 #, no-wrap msgid "{@code{unix-listener-configuration} parameter} string group" msgstr "" #. type: deftypevr #: doc/guix.texi:24451 doc/guix.texi:24474 msgid "The group to own the socket. Defaults to @samp{\"\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:24455 msgid "Available @code{fifo-listener-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:24456 #, no-wrap msgid "{@code{fifo-listener-configuration} parameter} string path" msgstr "" #. type: deftypevr #: doc/guix.texi:24461 #, no-wrap msgid "{@code{fifo-listener-configuration} parameter} string mode" msgstr "" #. type: deftypevr #: doc/guix.texi:24466 #, no-wrap msgid "{@code{fifo-listener-configuration} parameter} string user" msgstr "" #. type: deftypevr #: doc/guix.texi:24471 #, no-wrap msgid "{@code{fifo-listener-configuration} parameter} string group" msgstr "" #. type: deftypevr #: doc/guix.texi:24478 msgid "Available @code{inet-listener-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:24479 #, no-wrap msgid "{@code{inet-listener-configuration} parameter} string protocol" msgstr "" #. type: deftypevr #: doc/guix.texi:24481 msgid "The protocol to listen for." msgstr "" #. type: deftypevr #: doc/guix.texi:24483 #, no-wrap msgid "{@code{inet-listener-configuration} parameter} string address" msgstr "" #. type: deftypevr #: doc/guix.texi:24486 msgid "" "The address on which to listen, or empty for all addresses. Defaults to " "@samp{\"\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:24488 #, no-wrap msgid "{@code{inet-listener-configuration} parameter} non-negative-integer port" msgstr "" #. type: deftypevr #: doc/guix.texi:24490 msgid "The port on which to listen." msgstr "" #. type: deftypevr #: doc/guix.texi:24492 #, no-wrap msgid "{@code{inet-listener-configuration} parameter} boolean ssl?" msgstr "" #. type: deftypevr #: doc/guix.texi:24496 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:24500 #, no-wrap msgid "{@code{service-configuration} parameter} non-negative-integer client-limit" msgstr "" #. type: deftypevr #: doc/guix.texi:24505 msgid "" "Maximum number of simultaneous client connections per process. Once this " "number of connections is received, the next incoming connection will prompt " "Dovecot to spawn another process. If set to 0, @code{default-client-limit} " "is used instead." msgstr "" #. type: deftypevr #: doc/guix.texi:24510 #, no-wrap msgid "{@code{service-configuration} parameter} non-negative-integer service-count" msgstr "" #. type: deftypevr #: doc/guix.texi:24515 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. . Defaults to @samp{1}." msgstr "" #. type: deftypevr #: doc/guix.texi:24518 #, no-wrap msgid "{@code{service-configuration} parameter} non-negative-integer process-limit" msgstr "" #. type: deftypevr #: doc/guix.texi:24521 msgid "" "Maximum number of processes that can exist for this service. If set to 0, " "@code{default-process-limit} is used instead." msgstr "" #. type: deftypevr #: doc/guix.texi:24526 #, no-wrap msgid "{@code{service-configuration} parameter} non-negative-integer process-min-avail" msgstr "" #. type: deftypevr #: doc/guix.texi:24529 msgid "" "Number of processes to always keep waiting for more connections. Defaults " "to @samp{0}." msgstr "" #. type: deftypevr #: doc/guix.texi:24531 #, no-wrap msgid "{@code{service-configuration} parameter} non-negative-integer vsz-limit" msgstr "" #. type: deftypevr #: doc/guix.texi:24535 msgid "" "If you set @samp{service-count 0}, you probably need to grow this. Defaults " "to @samp{256000000}." msgstr "" #. type: deftypevr #: doc/guix.texi:24539 #, no-wrap msgid "{@code{dovecot-configuration} parameter} dict-configuration dict" msgstr "" #. type: deftypevr #: doc/guix.texi:24542 msgid "" "Dict configuration, as created by the @code{dict-configuration} constructor." msgstr "" #. type: deftypevr #: doc/guix.texi:24544 msgid "Available @code{dict-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:24545 #, no-wrap msgid "{@code{dict-configuration} parameter} free-form-fields entries" msgstr "" #. type: deftypevr #: doc/guix.texi:24548 msgid "" "A list of key-value pairs that this dict should hold. Defaults to @samp{()}." msgstr "" #. type: deftypevr #: doc/guix.texi:24552 #, no-wrap msgid "{@code{dovecot-configuration} parameter} passdb-configuration-list passdbs" msgstr "" #. type: deftypevr #: doc/guix.texi:24555 msgid "" "A list of passdb configurations, each one created by the @code{passdb-" "configuration} constructor." msgstr "" #. type: deftypevr #: doc/guix.texi:24557 msgid "Available @code{passdb-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:24558 #, no-wrap msgid "{@code{passdb-configuration} parameter} string driver" msgstr "" #. type: deftypevr #: doc/guix.texi:24563 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:24565 #, no-wrap msgid "{@code{passdb-configuration} parameter} space-separated-string-list args" msgstr "" #. type: deftypevr #: doc/guix.texi:24568 msgid "" "Space separated list of arguments to the passdb driver. Defaults to " "@samp{\"\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:24572 #, no-wrap msgid "{@code{dovecot-configuration} parameter} userdb-configuration-list userdbs" msgstr "" #. type: deftypevr #: doc/guix.texi:24575 msgid "" "List of userdb configurations, each one created by the @code{userdb-" "configuration} constructor." msgstr "" #. type: deftypevr #: doc/guix.texi:24577 msgid "Available @code{userdb-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:24578 #, no-wrap msgid "{@code{userdb-configuration} parameter} string driver" msgstr "" #. type: deftypevr #: doc/guix.texi:24582 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:24584 #, no-wrap msgid "{@code{userdb-configuration} parameter} space-separated-string-list args" msgstr "" #. type: deftypevr #: doc/guix.texi:24587 msgid "" "Space separated list of arguments to the userdb driver. Defaults to " "@samp{\"\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:24589 #, no-wrap msgid "{@code{userdb-configuration} parameter} free-form-args override-fields" msgstr "" #. type: deftypevr #: doc/guix.texi:24592 msgid "Override fields from passwd. Defaults to @samp{()}." msgstr "" #. type: deftypevr #: doc/guix.texi:24596 #, no-wrap msgid "{@code{dovecot-configuration} parameter} plugin-configuration plugin-configuration" msgstr "" #. type: deftypevr #: doc/guix.texi:24599 msgid "" "Plug-in configuration, created by the @code{plugin-configuration} " "constructor." msgstr "" #. type: deftypevr #: doc/guix.texi:24601 #, no-wrap msgid "{@code{dovecot-configuration} parameter} list-of-namespace-configuration namespaces" msgstr "" #. type: deftypevr #: doc/guix.texi:24604 msgid "" "List of namespaces. Each item in the list is created by the @code{namespace-" "configuration} constructor." msgstr "" #. type: deftypevr #: doc/guix.texi:24606 msgid "Available @code{namespace-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:24607 #, no-wrap msgid "{@code{namespace-configuration} parameter} string name" msgstr "" #. type: deftypevr #: doc/guix.texi:24609 msgid "Name for this namespace." msgstr "" #. type: deftypevr #: doc/guix.texi:24611 #, no-wrap msgid "{@code{namespace-configuration} parameter} string type" msgstr "" #. type: deftypevr #: doc/guix.texi:24614 msgid "" "Namespace type: @samp{private}, @samp{shared} or @samp{public}. Defaults to " "@samp{\"private\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:24616 #, no-wrap msgid "{@code{namespace-configuration} parameter} string separator" msgstr "" #. type: deftypevr #: doc/guix.texi:24622 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:24624 #, no-wrap msgid "{@code{namespace-configuration} parameter} string prefix" msgstr "" #. type: deftypevr #: doc/guix.texi:24628 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:24630 #, no-wrap msgid "{@code{namespace-configuration} parameter} string location" msgstr "" #. type: deftypevr #: doc/guix.texi:24634 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:24636 #, no-wrap msgid "{@code{namespace-configuration} parameter} boolean inbox?" msgstr "" #. type: deftypevr #: doc/guix.texi:24640 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:24642 #, no-wrap msgid "{@code{namespace-configuration} parameter} boolean hidden?" msgstr "" #. type: deftypevr #: doc/guix.texi:24650 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:24652 #, no-wrap msgid "{@code{namespace-configuration} parameter} boolean list?" msgstr "" #. type: deftypevr #: doc/guix.texi:24658 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:24660 #, no-wrap msgid "{@code{namespace-configuration} parameter} boolean subscriptions?" msgstr "" #. type: deftypevr #: doc/guix.texi:24665 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:24667 #, no-wrap msgid "{@code{namespace-configuration} parameter} mailbox-configuration-list mailboxes" msgstr "" #. type: deftypevr #: doc/guix.texi:24670 msgid "List of predefined mailboxes in this namespace. Defaults to @samp{()}." msgstr "" #. type: deftypevr #: doc/guix.texi:24672 msgid "Available @code{mailbox-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:24673 #, no-wrap msgid "{@code{mailbox-configuration} parameter} string name" msgstr "" #. type: deftypevr #: doc/guix.texi:24675 msgid "Name for this mailbox." msgstr "" #. type: deftypevr #: doc/guix.texi:24677 #, no-wrap msgid "{@code{mailbox-configuration} parameter} string auto" msgstr "" #. type: deftypevr #: doc/guix.texi:24681 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:24683 #, no-wrap msgid "{@code{mailbox-configuration} parameter} space-separated-string-list special-use" msgstr "" #. type: deftypevr #: doc/guix.texi:24688 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:24694 #, no-wrap msgid "{@code{dovecot-configuration} parameter} file-name base-dir" msgstr "" #. type: deftypevr #: doc/guix.texi:24697 msgid "" "Base directory where to store runtime data. Defaults to @samp{\"/var/run/" "dovecot/\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:24699 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string login-greeting" msgstr "" #. type: deftypevr #: doc/guix.texi:24702 msgid "Greeting message for clients. Defaults to @samp{\"Dovecot ready.\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:24704 #, no-wrap msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-trusted-networks" msgstr "" #. type: deftypevr #: doc/guix.texi:24711 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:24713 #, no-wrap msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-access-sockets" msgstr "" #. type: deftypevr #: doc/guix.texi:24716 msgid "" "List of login access check sockets (e.g.@: tcpwrap). Defaults to @samp{()}." msgstr "" #. type: deftypevr #: doc/guix.texi:24718 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean verbose-proctitle?" msgstr "" #. type: deftypevr #: doc/guix.texi:24724 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:24726 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean shutdown-clients?" msgstr "" #. type: deftypevr #: doc/guix.texi:24732 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:24734 #, no-wrap msgid "{@code{dovecot-configuration} parameter} non-negative-integer doveadm-worker-count" msgstr "" #. type: deftypevr #: doc/guix.texi:24738 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:24740 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string doveadm-socket-path" msgstr "" #. type: deftypevr #: doc/guix.texi:24743 msgid "" "UNIX socket or host:port used for connecting to doveadm server. Defaults to " "@samp{\"doveadm-server\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:24745 #, no-wrap msgid "{@code{dovecot-configuration} parameter} space-separated-string-list import-environment" msgstr "" #. type: deftypevr #: doc/guix.texi:24749 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:24751 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean disable-plaintext-auth?" msgstr "" #. type: deftypevr #: doc/guix.texi:24758 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:24760 #, no-wrap msgid "{@code{dovecot-configuration} parameter} non-negative-integer auth-cache-size" msgstr "" #. type: deftypevr #: doc/guix.texi:24765 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:24767 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string auth-cache-ttl" msgstr "" #. type: deftypevr #: doc/guix.texi:24775 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:24777 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string auth-cache-negative-ttl" msgstr "" #. type: deftypevr #: doc/guix.texi:24781 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:24783 #, no-wrap msgid "{@code{dovecot-configuration} parameter} space-separated-string-list auth-realms" msgstr "" #. type: deftypevr #: doc/guix.texi:24789 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:24791 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string auth-default-realm" msgstr "" #. type: deftypevr #: doc/guix.texi:24796 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:24798 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string auth-username-chars" msgstr "" #. type: deftypevr #: doc/guix.texi:24805 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:24807 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string auth-username-translation" msgstr "" #. type: deftypevr #: doc/guix.texi:24813 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:24815 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string auth-username-format" msgstr "" #. type: deftypevr #: doc/guix.texi:24822 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:24824 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string auth-master-user-separator" msgstr "" #. type: deftypevr #: doc/guix.texi:24832 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 . UW-IMAP uses " "@samp{*} as the separator, so that could be a good choice. Defaults to " "@samp{\"\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:24834 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string auth-anonymous-username" msgstr "" #. type: deftypevr #: doc/guix.texi:24838 msgid "" "Username to use for users logging in with ANONYMOUS SASL mechanism. " "Defaults to @samp{\"anonymous\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:24840 #, no-wrap msgid "{@code{dovecot-configuration} parameter} non-negative-integer auth-worker-max-count" msgstr "" #. type: deftypevr #: doc/guix.texi:24845 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:24847 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string auth-gssapi-hostname" msgstr "" #. type: deftypevr #: doc/guix.texi:24852 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:24854 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string auth-krb5-keytab" msgstr "" #. type: deftypevr #: doc/guix.texi:24860 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:24862 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean auth-use-winbind?" msgstr "" #. type: deftypevr #: doc/guix.texi:24867 msgid "" "Do NTLM and GSS-SPNEGO authentication using Samba's winbind daemon and " "@samp{ntlm-auth} helper. . " "Defaults to @samp{#f}." msgstr "" #. type: deftypevr #: doc/guix.texi:24869 #, no-wrap msgid "{@code{dovecot-configuration} parameter} file-name auth-winbind-helper-path" msgstr "" #. type: deftypevr #: doc/guix.texi:24872 msgid "" "Path for Samba's @samp{ntlm-auth} helper binary. Defaults to @samp{\"/usr/" "bin/ntlm_auth\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:24874 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string auth-failure-delay" msgstr "" #. type: deftypevr #: doc/guix.texi:24877 msgid "" "Time to delay before replying to failed authentications. Defaults to " "@samp{\"2 secs\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:24879 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean auth-ssl-require-client-cert?" msgstr "" #. type: deftypevr #: doc/guix.texi:24883 msgid "" "Require a valid SSL client certificate or the authentication fails. " "Defaults to @samp{#f}." msgstr "" #. type: deftypevr #: doc/guix.texi:24885 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean auth-ssl-username-from-cert?" msgstr "" #. type: deftypevr #: doc/guix.texi:24890 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:24892 #, no-wrap msgid "{@code{dovecot-configuration} parameter} space-separated-string-list auth-mechanisms" msgstr "" #. type: deftypevr #: doc/guix.texi:24898 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:24900 #, no-wrap msgid "{@code{dovecot-configuration} parameter} space-separated-string-list director-servers" msgstr "" #. type: deftypevr #: doc/guix.texi:24905 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:24907 #, no-wrap msgid "{@code{dovecot-configuration} parameter} space-separated-string-list director-mail-servers" msgstr "" #. type: deftypevr #: doc/guix.texi:24911 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:24913 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string director-user-expire" msgstr "" #. type: deftypevr #: doc/guix.texi:24917 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:24919 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string director-username-hash" msgstr "" #. type: deftypevr #: doc/guix.texi:24924 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:24926 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string log-path" msgstr "" #. type: deftypevr #: doc/guix.texi:24930 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:24932 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string info-log-path" msgstr "" #. type: deftypevr #: doc/guix.texi:24936 msgid "" "Log file to use for informational messages. Defaults to @samp{log-path}. " "Defaults to @samp{\"\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:24938 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string debug-log-path" msgstr "" #. type: deftypevr #: doc/guix.texi:24942 msgid "" "Log file to use for debug messages. Defaults to @samp{info-log-path}. " "Defaults to @samp{\"\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:24944 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string syslog-facility" msgstr "" #. type: deftypevr #: doc/guix.texi:24949 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:24951 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean auth-verbose?" msgstr "" #. type: deftypevr #: doc/guix.texi:24955 msgid "" "Log unsuccessful authentication attempts and the reasons why they failed. " "Defaults to @samp{#f}." msgstr "" #. type: deftypevr #: doc/guix.texi:24957 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string auth-verbose-passwords" msgstr "" #. type: deftypevr #: doc/guix.texi:24964 msgid "" "In case of password mismatches, log the attempted password. Valid values " "are no, plain and sha1. sha1 can be useful for detecting brute force " "password attempts vs. user simply trying the same password over and over " "again. You can also truncate the value to n chars by appending \":n\" (e.g." "@: sha1:6). Defaults to @samp{\"no\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:24966 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean auth-debug?" msgstr "" #. type: deftypevr #: doc/guix.texi:24970 msgid "" "Even more verbose logging for debugging purposes. Shows for example SQL " "queries. Defaults to @samp{#f}." msgstr "" #. type: deftypevr #: doc/guix.texi:24972 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean auth-debug-passwords?" msgstr "" #. type: deftypevr #: doc/guix.texi:24977 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:24979 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean mail-debug?" msgstr "" #. type: deftypevr #: doc/guix.texi:24983 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:24985 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean verbose-ssl?" msgstr "" #. type: deftypevr #: doc/guix.texi:24988 msgid "Show protocol level SSL errors. Defaults to @samp{#f}." msgstr "" #. type: deftypevr #: doc/guix.texi:24990 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string log-timestamp" msgstr "" #. type: deftypevr #: doc/guix.texi:24994 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:24996 #, no-wrap msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-log-format-elements" msgstr "" #. type: deftypevr #: doc/guix.texi:25000 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:25002 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string login-log-format" msgstr "" #. type: deftypevr #: doc/guix.texi:25006 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:25008 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string mail-log-prefix" msgstr "" #. type: deftypevr #: doc/guix.texi:25012 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:25014 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string deliver-log-format" msgstr "" #. type: deftypevr #: doc/guix.texi:25016 msgid "Format to use for logging mail deliveries. You can use variables:" msgstr "" #. type: item #: doc/guix.texi:25017 #, no-wrap msgid "%$" msgstr "" #. type: table #: doc/guix.texi:25019 msgid "Delivery status message (e.g.@: @samp{saved to INBOX})" msgstr "" #. type: item #: doc/guix.texi:25019 #, no-wrap msgid "%m" msgstr "" #. type: table #: doc/guix.texi:25021 msgid "Message-ID" msgstr "" #. type: item #: doc/guix.texi:25021 doc/guix.texi:25564 #, no-wrap msgid "%s" msgstr "" #. type: table #: doc/guix.texi:25023 msgid "Subject" msgstr "" #. type: item #: doc/guix.texi:25023 #, no-wrap msgid "%f" msgstr "" #. type: table #: doc/guix.texi:25025 msgid "From address" msgstr "" #. type: table #: doc/guix.texi:25027 msgid "Physical size" msgstr "" #. type: item #: doc/guix.texi:25027 #, no-wrap msgid "%w" msgstr "" #. type: table #: doc/guix.texi:25029 msgid "Virtual size." msgstr "" #. type: deftypevr #: doc/guix.texi:25031 msgid "Defaults to @samp{\"msgid=%m: %$\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:25033 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string mail-location" msgstr "" #. type: deftypevr #: doc/guix.texi:25038 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:25044 msgid "" "If you're using mbox, giving a path to the INBOX file (e.g.@: @file{/var/" "mail/%u}) isn't enough. You'll also need to tell Dovecot where the other " "mailboxes are kept. This is called the @emph{root mail directory}, and it " "must be the first path given in the @samp{mail-location} setting." msgstr "" #. type: deftypevr #: doc/guix.texi:25046 msgid "There are a few special variables you can use, e.g.:" msgstr "" #. type: table #: doc/guix.texi:25050 msgid "username" msgstr "" #. type: item #: doc/guix.texi:25050 doc/guix.texi:25560 #, no-wrap msgid "%n" msgstr "" #. type: table #: doc/guix.texi:25052 msgid "user part in user@@domain, same as %u if there's no domain" msgstr "" #. type: item #: doc/guix.texi:25052 #, no-wrap msgid "%d" msgstr "" #. type: table #: doc/guix.texi:25054 msgid "domain part in user@@domain, empty if there's no domain" msgstr "" #. type: item #: doc/guix.texi:25054 #, no-wrap msgid "%h" msgstr "" #. type: table #: doc/guix.texi:25056 msgid "home director" msgstr "" #. type: deftypevr #: doc/guix.texi:25059 msgid "See doc/wiki/Variables.txt for full list. Some examples:" msgstr "" #. type: item #: doc/guix.texi:25060 #, no-wrap msgid "maildir:~/Maildir" msgstr "" #. type: item #: doc/guix.texi:25061 #, no-wrap msgid "mbox:~/mail:INBOX=/var/mail/%u" msgstr "" #. type: item #: doc/guix.texi:25062 #, no-wrap msgid "mbox:/var/mail/%d/%1n/%n:INDEX=/var/indexes/%d/%1n/%" msgstr "" #. type: deftypevr #: doc/guix.texi:25067 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string mail-uid" msgstr "" #. type: deftypevr #: doc/guix.texi:25072 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. . Defaults to @samp{\"\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:25074 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string mail-gid" msgstr "" #. type: deftypevr #: doc/guix.texi:25079 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string mail-privileged-group" msgstr "" #. type: deftypevr #: doc/guix.texi:25085 msgid "" "Group to enable temporarily for privileged operations. Currently this is " "used only with INBOX when either its initial creation or dotlocking fails. " "Typically this is set to @samp{\"mail\"} to give access to @file{/var/" "mail}. Defaults to @samp{\"\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:25087 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string mail-access-groups" msgstr "" #. type: deftypevr #: doc/guix.texi:25095 msgid "" "Grant access to these supplementary groups for mail processes. Typically " "these are used to set up access to shared mailboxes. Note that it may be " "dangerous to set these if users can create symlinks (e.g.@: if @samp{mail} " "group is set here, @code{ln -s /var/mail ~/mail/var} could allow a user to " "delete others' mailboxes, or @code{ln -s /secret/shared/box ~/mail/mybox} " "would allow reading it). Defaults to @samp{\"\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:25097 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string mail-attribute-dict" msgstr "" #. type: deftypevr #: doc/guix.texi:25100 msgid "" "The location of a dictionary used to store @code{IMAP METADATA} as defined " "by @uref{https://tools.ietf.org/html/rfc5464, RFC@tie{}5464}." msgstr "" #. type: deftypevr #: doc/guix.texi:25103 msgid "" "The IMAP METADATA commands are available only if the ``imap'' protocol " "configuration's @code{imap-metadata?} field is @samp{#t}." msgstr "" #. type: deftypevr #: doc/guix.texi:25108 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean mail-full-filesystem-access?" msgstr "" #. type: deftypevr #: doc/guix.texi:25114 msgid "" "Allow full file system access to clients. There's no access checks other " "than what the operating system does for the active UID/GID@. It works with " "both maildir and mboxes, allowing you to prefix mailboxes names with e.g.@: " "@file{/path/} or @file{~user/}. Defaults to @samp{#f}." msgstr "" #. type: deftypevr #: doc/guix.texi:25116 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean mmap-disable?" msgstr "" #. type: deftypevr #: doc/guix.texi:25120 msgid "" "Don't use @code{mmap()} at all. This is required if you store indexes to " "shared file systems (NFS or clustered file system). Defaults to @samp{#f}." msgstr "" #. type: deftypevr #: doc/guix.texi:25122 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean dotlock-use-excl?" msgstr "" #. type: deftypevr #: doc/guix.texi:25127 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:25129 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string mail-fsync" msgstr "" #. type: deftypevr #: doc/guix.texi:25131 msgid "When to use fsync() or fdatasync() calls:" msgstr "" #. type: item #: doc/guix.texi:25132 #, no-wrap msgid "optimized" msgstr "" #. type: table #: doc/guix.texi:25134 msgid "Whenever necessary to avoid losing important data" msgstr "" #. type: table #: doc/guix.texi:25136 msgid "Useful with e.g.@: NFS when @code{write()}s are delayed" msgstr "" #. type: table #: doc/guix.texi:25138 msgid "Never use it (best performance, but crashes can lose data)." msgstr "" #. type: deftypevr #: doc/guix.texi:25140 msgid "Defaults to @samp{\"optimized\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:25142 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean mail-nfs-storage?" msgstr "" #. type: deftypevr #: doc/guix.texi:25147 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:25149 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean mail-nfs-index?" msgstr "" #. type: deftypevr #: doc/guix.texi:25153 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:25155 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string lock-method" msgstr "" #. type: deftypevr #: doc/guix.texi:25161 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:25163 #, no-wrap msgid "{@code{dovecot-configuration} parameter} file-name mail-temp-dir" msgstr "" #. type: deftypevr #: doc/guix.texi:25167 msgid "" "Directory in which LDA/LMTP temporarily stores incoming mails >128 kB. " "Defaults to @samp{\"/tmp\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:25169 #, no-wrap msgid "{@code{dovecot-configuration} parameter} non-negative-integer first-valid-uid" msgstr "" #. type: deftypevr #: doc/guix.texi:25175 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:25177 #, no-wrap msgid "{@code{dovecot-configuration} parameter} non-negative-integer last-valid-uid" msgstr "" #. type: deftypevr #: doc/guix.texi:25182 #, no-wrap msgid "{@code{dovecot-configuration} parameter} non-negative-integer first-valid-gid" msgstr "" #. type: deftypevr #: doc/guix.texi:25187 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:25189 #, no-wrap msgid "{@code{dovecot-configuration} parameter} non-negative-integer last-valid-gid" msgstr "" #. type: deftypevr #: doc/guix.texi:25194 #, no-wrap msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-max-keyword-length" msgstr "" #. type: deftypevr #: doc/guix.texi:25198 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:25200 #, no-wrap msgid "{@code{dovecot-configuration} parameter} colon-separated-file-name-list valid-chroot-dirs" msgstr "" #. type: deftypevr #: doc/guix.texi:25210 msgid "" "List of directories under which chrooting is allowed for mail processes (i.e." "@: @file{/var/mail} will allow chrooting to @file{/var/mail/foo/bar} too). " "This setting doesn't affect @samp{login-chroot} @samp{mail-chroot} or auth " "chroot settings. If this setting is empty, @samp{/./} in home dirs are " "ignored. WARNING: Never add directories here which local users can modify, " "that may lead to root exploit. Usually this should be done only if you " "don't allow shell access for users. . Defaults to " "@samp{()}." msgstr "" #. type: deftypevr #: doc/guix.texi:25212 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string mail-chroot" msgstr "" #. type: deftypevr #: doc/guix.texi:25221 msgid "" "Default chroot directory for mail processes. This can be overridden for " "specific users in user database by giving @samp{/./} in user's home " "directory (e.g.@: @samp{/home/./user} chroots into @file{/home}). Note that " "usually there is no real need to do chrooting, Dovecot doesn't allow users " "to access files outside their mail directory anyway. If your home " "directories are prefixed with the chroot directory, append @samp{/.} to " "@samp{mail-chroot}. . Defaults to @samp{\"\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:25223 #, no-wrap msgid "{@code{dovecot-configuration} parameter} file-name auth-socket-path" msgstr "" #. type: deftypevr #: doc/guix.texi:25227 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:25229 #, no-wrap msgid "{@code{dovecot-configuration} parameter} file-name mail-plugin-dir" msgstr "" #. type: deftypevr #: doc/guix.texi:25232 msgid "" "Directory where to look up mail plugins. Defaults to @samp{\"/usr/lib/" "dovecot\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:25234 #, no-wrap msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mail-plugins" msgstr "" #. type: deftypevr #: doc/guix.texi:25238 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:25240 #, no-wrap msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-cache-min-mail-count" msgstr "" #. type: deftypevr #: doc/guix.texi:25245 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:25247 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string mailbox-idle-check-interval" msgstr "" #. type: deftypevr #: doc/guix.texi:25254 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:25256 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean mail-save-crlf?" msgstr "" #. type: deftypevr #: doc/guix.texi:25263 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:25265 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean maildir-stat-dirs?" msgstr "" #. type: deftypevr #: doc/guix.texi:25273 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:25275 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean maildir-copy-with-hardlinks?" msgstr "" #. type: deftypevr #: doc/guix.texi:25280 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:25282 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean maildir-very-dirty-syncs?" msgstr "" #. type: deftypevr #: doc/guix.texi:25287 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:25289 #, no-wrap msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mbox-read-locks" msgstr "" #. type: deftypevr #: doc/guix.texi:25292 msgid "" "Which locking methods to use for locking mbox. There are four available:" msgstr "" #. type: item #: doc/guix.texi:25294 #, no-wrap msgid "dotlock" msgstr "" #. type: table #: doc/guix.texi:25298 msgid "" "Create .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:25298 #, no-wrap msgid "dotlock-try" msgstr "" #. type: table #: doc/guix.texi:25301 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:25301 #, no-wrap msgid "fcntl" msgstr "" #. type: table #: doc/guix.texi:25303 msgid "Use this if possible. Works with NFS too if lockd is used." msgstr "" #. type: item #: doc/guix.texi:25303 #, no-wrap msgid "flock" msgstr "" #. type: table #: doc/guix.texi:25305 doc/guix.texi:25307 msgid "May not exist in all systems. Doesn't work with NFS." msgstr "" #. type: item #: doc/guix.texi:25305 #, no-wrap msgid "lockf" msgstr "" #. type: deftypevr #: doc/guix.texi:25313 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:25315 #, no-wrap msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mbox-write-locks" msgstr "" #. type: deftypevr #: doc/guix.texi:25319 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string mbox-lock-timeout" msgstr "" #. type: deftypevr #: doc/guix.texi:25322 msgid "" "Maximum time to wait for lock (all of them) before aborting. Defaults to " "@samp{\"5 mins\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:25324 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string mbox-dotlock-change-timeout" msgstr "" #. type: deftypevr #: doc/guix.texi:25328 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:25330 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean mbox-dirty-syncs?" msgstr "" #. type: deftypevr #: doc/guix.texi:25341 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:25343 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean mbox-very-dirty-syncs?" msgstr "" #. type: deftypevr #: doc/guix.texi:25348 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:25350 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean mbox-lazy-writes?" msgstr "" #. type: deftypevr #: doc/guix.texi:25356 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:25358 #, no-wrap msgid "{@code{dovecot-configuration} parameter} non-negative-integer mbox-min-index-size" msgstr "" #. type: deftypevr #: doc/guix.texi:25363 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:25365 #, no-wrap msgid "{@code{dovecot-configuration} parameter} non-negative-integer mdbox-rotate-size" msgstr "" #. type: deftypevr #: doc/guix.texi:25368 msgid "" "Maximum dbox file size until it's rotated. Defaults to @samp{10000000}." msgstr "" #. type: deftypevr #: doc/guix.texi:25370 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string mdbox-rotate-interval" msgstr "" #. type: deftypevr #: doc/guix.texi:25375 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:25377 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean mdbox-preallocate-space?" msgstr "" #. type: deftypevr #: doc/guix.texi:25382 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:25384 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string mail-attachment-dir" msgstr "" #. type: deftypevr #: doc/guix.texi:25388 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:25390 msgid "" "WARNING: This feature hasn't been tested much yet. Use at your own risk." msgstr "" #. type: deftypevr #: doc/guix.texi:25393 msgid "" "Directory root where to store mail attachments. Disabled, if empty. " "Defaults to @samp{\"\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:25395 #, no-wrap msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-attachment-min-size" msgstr "" #. type: deftypevr #: doc/guix.texi:25400 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:25402 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string mail-attachment-fs" msgstr "" #. type: deftypevr #: doc/guix.texi:25404 msgid "File system backend to use for saving attachments:" msgstr "" #. type: item #: doc/guix.texi:25405 #, no-wrap msgid "posix" msgstr "" #. type: table #: doc/guix.texi:25407 msgid "No SiS done by Dovecot (but this might help FS's own deduplication)" msgstr "" #. type: item #: doc/guix.texi:25407 #, no-wrap msgid "sis posix" msgstr "" #. type: table #: doc/guix.texi:25409 msgid "SiS with immediate byte-by-byte comparison during saving" msgstr "" #. type: item #: doc/guix.texi:25409 #, no-wrap msgid "sis-queue posix" msgstr "" #. type: table #: doc/guix.texi:25411 msgid "SiS with delayed comparison and deduplication." msgstr "" #. type: deftypevr #: doc/guix.texi:25413 msgid "Defaults to @samp{\"sis posix\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:25415 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string mail-attachment-hash" msgstr "" #. type: deftypevr #: doc/guix.texi:25421 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:25423 #, no-wrap msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-process-limit" msgstr "" #. type: deftypevr #: doc/guix.texi:25428 #, no-wrap msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-client-limit" msgstr "" #. type: deftypevr #: doc/guix.texi:25431 doc/guix.texi:33185 msgid "Defaults to @samp{1000}." msgstr "" #. type: deftypevr #: doc/guix.texi:25433 #, no-wrap msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-vsz-limit" msgstr "" #. type: deftypevr #: doc/guix.texi:25438 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:25440 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string default-login-user" msgstr "" #. type: deftypevr #: doc/guix.texi:25445 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:25447 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string default-internal-user" msgstr "" #. type: deftypevr #: doc/guix.texi:25452 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:25454 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string ssl?" msgstr "" #. type: deftypevr #: doc/guix.texi:25457 msgid "" "SSL/TLS support: yes, no, required. . Defaults to " "@samp{\"required\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:25459 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string ssl-cert" msgstr "" #. type: deftypevr #: doc/guix.texi:25462 msgid "" "PEM encoded X.509 SSL/TLS certificate (public key). Defaults to @samp{\" was automatically rejected:%n%r\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:25572 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string recipient-delimiter" msgstr "" #. type: deftypevr #: doc/guix.texi:25576 msgid "" "Delimiter character between local-part and detail in email address. " "Defaults to @samp{\"+\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:25578 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string lda-original-recipient-header" msgstr "" #. type: deftypevr #: doc/guix.texi:25584 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:25586 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean lda-mailbox-autocreate?" msgstr "" #. type: deftypevr #: doc/guix.texi:25590 msgid "" "Should saving a mail to a nonexistent mailbox automatically create it?. " "Defaults to @samp{#f}." msgstr "" #. type: deftypevr #: doc/guix.texi:25592 #, no-wrap msgid "{@code{dovecot-configuration} parameter} boolean lda-mailbox-autosubscribe?" msgstr "" #. type: deftypevr #: doc/guix.texi:25596 msgid "" "Should automatically created mailboxes be also automatically subscribed?. " "Defaults to @samp{#f}." msgstr "" #. type: deftypevr #: doc/guix.texi:25598 #, no-wrap msgid "{@code{dovecot-configuration} parameter} non-negative-integer imap-max-line-length" msgstr "" #. type: deftypevr #: doc/guix.texi:25604 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:25606 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string imap-logout-format" msgstr "" #. type: deftypevr #: doc/guix.texi:25608 msgid "IMAP logout format string:" msgstr "" #. type: item #: doc/guix.texi:25609 #, no-wrap msgid "%i" msgstr "" #. type: table #: doc/guix.texi:25611 msgid "total number of bytes read from client" msgstr "" #. type: item #: doc/guix.texi:25611 #, no-wrap msgid "%o" msgstr "" #. type: table #: doc/guix.texi:25613 msgid "total number of bytes sent to client." msgstr "" #. type: deftypevr #: doc/guix.texi:25616 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:25618 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string imap-capability" msgstr "" #. type: deftypevr #: doc/guix.texi:25622 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:25624 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string imap-idle-notify-interval" msgstr "" #. type: deftypevr #: doc/guix.texi:25628 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:25630 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string imap-id-send" msgstr "" #. type: deftypevr #: doc/guix.texi:25636 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:25638 #, no-wrap msgid "{@code{dovecot-configuration} parameter} string imap-id-log" msgstr "" #. type: deftypevr #: doc/guix.texi:25641 msgid "" "ID fields sent by client to log. * means everything. Defaults to " "@samp{\"\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:25643 #, no-wrap msgid "{@code{dovecot-configuration} parameter} space-separated-string-list imap-client-workarounds" msgstr "" #. type: deftypevr #: doc/guix.texi:25645 msgid "Workarounds for various client bugs:" msgstr "" #. type: item #: doc/guix.texi:25647 #, no-wrap msgid "delay-newmail" msgstr "" #. type: table #: doc/guix.texi:25654 msgid "" "Send EXISTS/RECENT new mail notifications only when replying to NOOP and " "CHECK commands. Some clients ignore them otherwise, for example OSX Mail " "(' 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 " "Mumble server log to ensure that Mumble is using the cipher suites that you " "expected it to." msgstr "" #. type: quotation #: doc/guix.texi:27055 msgid "" "Changing this option may impact the backwards compatibility of your Mumble-" "Server server, and can remove the ability for older Mumble clients to be " "able to connect to it." msgstr "" #. type: item #: doc/guix.texi:27057 #, no-wrap msgid "@code{public-registration} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:27060 msgid "" "Must be a @code{} record or " "@code{#f}." msgstr "" #. type: table #: doc/guix.texi:27065 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:27067 msgid "It might take a few hours until it shows up in the public list." msgstr "" #. type: item #: doc/guix.texi:27068 doc/guix.texi:29228 #, no-wrap msgid "@code{file} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:27070 msgid "Optional alternative override for this configuration." msgstr "" #. type: deftp #: doc/guix.texi:27073 #, no-wrap msgid "{Data Type} mumble-server-public-registration-configuration" msgstr "" #. type: deftp #: doc/guix.texi:27075 msgid "Configuration for public registration of a mumble-server service." msgstr "" #. type: table #: doc/guix.texi:27079 msgid "" "This is a display name for your server. Not to be confused with the " "hostname." msgstr "" #. type: itemx #: doc/guix.texi:27080 doc/guix.texi:36202 doc/guix.texi:37721 #, no-wrap msgid "password" msgstr "" #. type: table #: doc/guix.texi:27083 msgid "" "A password to identify your registration. Subsequent updates will need the " "same password. Don't lose your password." msgstr "" #. type: table #: doc/guix.texi:27087 msgid "" "This should be a @code{http://} or @code{https://} link to your web site." msgstr "" #. type: item #: doc/guix.texi:27088 doc/guix.texi:30119 #, no-wrap msgid "@code{hostname} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:27091 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: quotation #: doc/guix.texi:27094 #, no-wrap msgid "Deprecation notice" msgstr "" #. type: quotation #: doc/guix.texi:27099 msgid "" "Due to historical reasons, all of the above @code{mumble-server-} procedures " "are also exported with the @code{murmur-} prefix. It is recommended that " "you switch to using @code{mumble-server-} going forward." msgstr "" #. type: Plain text #: doc/guix.texi:27106 msgid "" "The @code{(gnu services file-sharing)} module provides services that assist " "with transferring files over peer-to-peer file-sharing networks." msgstr "" #. type: subsubheading #: doc/guix.texi:27107 #, no-wrap msgid "Transmission Daemon Service" msgstr "" #. type: Plain text #: doc/guix.texi:27115 msgid "" "@uref{https://transmissionbt.com/, Transmission} is a flexible BitTorrent " "client that offers a variety of graphical and command-line interfaces. A " "@code{transmission-daemon-service-type} service provides Transmission's " "headless variant, @command{transmission-daemon}, as a system service, " "allowing users to share files via BitTorrent even when they are not logged " "in." msgstr "" #. type: deffn #: doc/guix.texi:27116 #, no-wrap msgid "{Scheme Variable} transmission-daemon-service-type" msgstr "" #. type: deffn #: doc/guix.texi:27120 msgid "" "The service type for the Transmission Daemon BitTorrent client. Its value " "must be a @code{transmission-daemon-configuration} object as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:27131 #, no-wrap msgid "" "(service transmission-daemon-service-type\n" " (transmission-daemon-configuration\n" " ;; Restrict access to the RPC (\"control\") interface\n" " (rpc-authentication-required? #t)\n" " (rpc-username \"transmission\")\n" " (rpc-password\n" " (transmission-password-hash\n" " \"transmission\" ; desired password\n" " \"uKd1uMs9\")) ; arbitrary salt value\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:27136 #, no-wrap msgid "" " ;; Accept requests from this and other hosts on the\n" " ;; local network\n" " (rpc-whitelist-enabled? #t)\n" " (rpc-whitelist '(\"::1\" \"127.0.0.1\" \"192.168.0.*\"))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:27140 #, no-wrap msgid "" " ;; Limit bandwidth use during work hours\n" " (alt-speed-down (* 1024 2)) ; 2 MB/s\n" " (alt-speed-up 512) ; 512 kB/s\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:27147 #, no-wrap msgid "" " (alt-speed-time-enabled? #t)\n" " (alt-speed-time-day 'weekdays)\n" " (alt-speed-time-begin\n" " (+ (* 60 8) 30)) ; 8:30 am\n" " (alt-speed-time-end\n" " (+ (* 60 (+ 12 5)) 30)))) ; 5:30 pm\n" msgstr "" #. type: Plain text #: doc/guix.texi:27160 msgid "" "Once the service is started, users can interact with the daemon through its " "Web interface (at @code{http://localhost:9091/}) or by using the " "@command{transmission-remote} command-line tool, available in the " "@code{transmission} package. (Emacs users may want to also consider the " "@code{emacs-transmission} package.) Both communicate with the daemon " "through its remote procedure call (RPC) interface, which by default is " "available to all users on the system; you may wish to change this by " "assigning values to the @code{rpc-authentication-required?}, @code{rpc-" "username} and @code{rpc-password} settings, as shown in the example above " "and documented further below." msgstr "" #. type: Plain text #: doc/guix.texi:27168 msgid "" "The value for @code{rpc-password} must be a password hash of the type " "generated and used by Transmission clients. This can be copied verbatim " "from an existing @file{settings.json} file, if another Transmission client " "is already being used. Otherwise, the @code{transmission-password-hash} and " "@code{transmission-random-salt} procedures provided by this module can be " "used to obtain a suitable hash value." msgstr "" #. type: deffn #: doc/guix.texi:27169 #, no-wrap msgid "{Scheme Procedure} transmission-password-hash @var{password} @var{salt}" msgstr "" #. type: deffn #: doc/guix.texi:27173 msgid "" "Returns a string containing the result of hashing @var{password} together " "with @var{salt}, in the format recognized by Transmission clients for their " "@code{rpc-password} configuration setting." msgstr "" #. type: deffn #: doc/guix.texi:27177 msgid "" "@var{salt} must be an eight-character string. The @code{transmission-random-" "salt} procedure can be used to generate a suitable salt value at random." msgstr "" #. type: deffn #: doc/guix.texi:27179 #, no-wrap msgid "{Scheme Procedure} transmission-random-salt" msgstr "" #. type: deffn #: doc/guix.texi:27183 msgid "" "Returns a string containing a random, eight-character salt value of the type " "generated and used by Transmission clients, suitable for passing to the " "@code{transmission-password-hash} procedure." msgstr "" #. type: Plain text #: doc/guix.texi:27189 msgid "" "These procedures are accessible from within a Guile REPL started with the " "@command{guix repl} command (@pxref{Invoking guix repl}). This is useful " "for obtaining a random salt value to provide as the second parameter to " "`transmission-password-hash`, as in this example session:" msgstr "" #. type: example #: doc/guix.texi:27195 #, no-wrap msgid "" "$ guix repl\n" "scheme@@(guix-user)> ,use (gnu services file-sharing)\n" "scheme@@(guix-user)> (transmission-random-salt)\n" "$1 = \"uKd1uMs9\"\n" msgstr "" #. type: Plain text #: doc/guix.texi:27198 msgid "Alternatively, a complete password hash can generated in a single step:" msgstr "" #. type: example #: doc/guix.texi:27203 #, no-wrap msgid "" "scheme@@(guix-user)> (transmission-password-hash \"transmission\"\n" "(transmission-random-salt))\n" "$2 = \"@{c8bbc6d1740cd8dc819a6e25563b67812c1c19c9VtFPfdsX\"\n" msgstr "" #. type: Plain text #: doc/guix.texi:27208 msgid "" "The resulting string can be used as-is for the value of @code{rpc-password}, " "allowing the password to be kept hidden even in the operating-system " "configuration." msgstr "" #. type: Plain text #: doc/guix.texi:27217 msgid "" "Torrent files downloaded by the daemon are directly accessible only to users " "in the ``transmission'' user group, who receive read-only access to the " "directory specified by the @code{download-dir} configuration setting (and " "also the directory specified by @code{incomplete-dir}, if @code{incomplete-" "dir-enabled?} is @code{#t}). Downloaded files can be moved to another " "directory or deleted altogether using @command{transmission-remote} with its " "@code{--move} and @code{--remove-and-delete} options." msgstr "" #. type: Plain text #: doc/guix.texi:27224 msgid "" "If the @code{watch-dir-enabled?} setting is set to @code{#t}, users in the " "``transmission'' group are able also to place @file{.torrent} files in the " "directory specified by @code{watch-dir} to have the corresponding torrents " "added by the daemon. (The @code{trash-original-torrent-files?} setting " "controls whether the daemon deletes these files after processing them.)" msgstr "" #. type: Plain text #: doc/guix.texi:27229 msgid "" "Some of the daemon's configuration settings can be changed temporarily by " "@command{transmission-remote} and similar tools. To undo these changes, use " "the service's @code{reload} action to have the daemon reload its settings " "from disk:" msgstr "" #. type: example #: doc/guix.texi:27232 #, no-wrap msgid "# herd reload transmission-daemon\n" msgstr "" #. type: Plain text #: doc/guix.texi:27236 msgid "" "The full set of available configuration settings is defined by the " "@code{transmission-daemon-configuration} data type." msgstr "" #. type: deftp #: doc/guix.texi:27237 #, no-wrap msgid "{Data Type} transmission-daemon-configuration" msgstr "" #. type: deftp #: doc/guix.texi:27241 msgid "" "The data type representing configuration settings for Transmission Daemon. " "These correspond directly to the settings recognized by Transmission clients " "in their @file{settings.json} file." msgstr "" #. type: Plain text #: doc/guix.texi:27255 msgid "Available @code{transmission-daemon-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:27256 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} package transmission" msgstr "" #. type: deftypevr #: doc/guix.texi:27258 msgid "The Transmission package to use." msgstr "" #. type: deftypevr #: doc/guix.texi:27261 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer stop-wait-period" msgstr "" #. type: deftypevr #: doc/guix.texi:27267 msgid "" "The period, in seconds, to wait when stopping the service for " "@command{transmission-daemon} to exit before killing its process. This " "allows the daemon time to complete its housekeeping and send a final update " "to trackers as it shuts down. On slow hosts, or hosts with a slow network " "connection, this value may need to be increased." msgstr "" #. type: deftypevr #: doc/guix.texi:27269 doc/guix.texi:27641 doc/guix.texi:35137 #: doc/guix.texi:35372 doc/guix.texi:35380 doc/guix.texi:35388 msgid "Defaults to @samp{10}." msgstr "" #. type: deftypevr #: doc/guix.texi:27272 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} string download-dir" msgstr "" #. type: deftypevr #: doc/guix.texi:27274 msgid "The directory to which torrent files are downloaded." msgstr "" #. type: deftypevr #: doc/guix.texi:27276 msgid "Defaults to @samp{\"/var/lib/transmission-daemon/downloads\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:27279 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean incomplete-dir-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27284 msgid "" "If @code{#t}, files will be held in @code{incomplete-dir} while their " "torrent is being downloaded, then moved to @code{download-dir} once the " "torrent is complete. Otherwise, files for all torrents (including those " "still being downloaded) will be placed in @code{download-dir}." msgstr "" #. type: deftypevr #: doc/guix.texi:27289 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} maybe-string incomplete-dir" msgstr "" #. type: deftypevr #: doc/guix.texi:27292 msgid "" "The directory in which files from incompletely downloaded torrents will be " "held when @code{incomplete-dir-enabled?} is @code{#t}." msgstr "" #. type: deftypevr #: doc/guix.texi:27294 doc/guix.texi:27338 doc/guix.texi:27551 #: doc/guix.texi:27607 doc/guix.texi:27781 doc/guix.texi:27792 #: doc/guix.texi:27865 doc/guix.texi:28500 doc/guix.texi:28543 #: doc/guix.texi:28551 doc/guix.texi:28559 doc/guix.texi:28567 #: doc/guix.texi:28576 doc/guix.texi:28584 doc/guix.texi:28591 #: doc/guix.texi:28599 doc/guix.texi:28607 doc/guix.texi:28617 #: doc/guix.texi:28624 doc/guix.texi:28648 doc/guix.texi:28656 #: doc/guix.texi:28682 doc/guix.texi:28691 doc/guix.texi:28700 #: doc/guix.texi:28709 doc/guix.texi:28718 doc/guix.texi:28727 #: doc/guix.texi:28735 doc/guix.texi:28743 doc/guix.texi:28750 #: doc/guix.texi:28758 doc/guix.texi:28765 doc/guix.texi:28773 #: doc/guix.texi:28781 doc/guix.texi:28790 doc/guix.texi:28799 #: doc/guix.texi:28807 doc/guix.texi:28815 doc/guix.texi:28823 #: doc/guix.texi:28834 doc/guix.texi:28844 doc/guix.texi:28855 #: doc/guix.texi:28864 doc/guix.texi:28874 doc/guix.texi:28882 #: doc/guix.texi:28893 doc/guix.texi:28902 doc/guix.texi:28912 #: doc/guix.texi:32321 doc/guix.texi:32328 doc/guix.texi:32335 #: doc/guix.texi:32342 doc/guix.texi:32349 doc/guix.texi:32356 #: doc/guix.texi:32364 doc/guix.texi:32372 doc/guix.texi:32379 #: doc/guix.texi:32386 doc/guix.texi:32393 doc/guix.texi:32400 #: doc/guix.texi:32430 doc/guix.texi:32468 doc/guix.texi:32475 #: doc/guix.texi:32484 doc/guix.texi:32506 doc/guix.texi:32514 #: doc/guix.texi:32521 doc/guix.texi:32550 doc/guix.texi:32557 #: doc/guix.texi:32564 doc/guix.texi:32571 doc/guix.texi:32704 #: doc/guix.texi:32724 doc/guix.texi:32739 doc/guix.texi:32746 #: doc/guix.texi:35509 doc/guix.texi:35517 doc/guix.texi:35525 #: doc/guix.texi:35533 doc/guix.texi:35541 doc/guix.texi:35549 msgid "Defaults to @samp{disabled}." msgstr "" #. type: deftypevr #: doc/guix.texi:27297 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} umask umask" msgstr "" #. type: deftypevr #: doc/guix.texi:27300 msgid "" "The file mode creation mask used for downloaded files. (See the " "@command{umask} man page for more information.)" msgstr "" #. type: deftypevr #: doc/guix.texi:27302 msgid "Defaults to @samp{18}." msgstr "" #. type: deftypevr #: doc/guix.texi:27305 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean rename-partial-files?" msgstr "" #. type: deftypevr #: doc/guix.texi:27308 msgid "" "When @code{#t}, ``.part'' is appended to the name of partially downloaded " "files." msgstr "" #. type: deftypevr #: doc/guix.texi:27313 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} preallocation-mode preallocation" msgstr "" #. type: deftypevr #: doc/guix.texi:27318 msgid "" "The mode by which space should be preallocated for downloaded files, one of " "@code{none}, @code{fast} (or @code{sparse}) and @code{full}. Specifying " "@code{full} will minimize disk fragmentation at a cost to file-creation " "speed." msgstr "" #. type: deftypevr #: doc/guix.texi:27320 msgid "Defaults to @samp{fast}." msgstr "" #. type: deftypevr #: doc/guix.texi:27323 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean watch-dir-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27328 msgid "" "If @code{#t}, the directory specified by @code{watch-dir} will be watched " "for new @file{.torrent} files and the torrents they describe added " "automatically (and the original files removed, if @code{trash-original-" "torrent-files?} is @code{#t})." msgstr "" #. type: deftypevr #: doc/guix.texi:27333 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} maybe-string watch-dir" msgstr "" #. type: deftypevr #: doc/guix.texi:27336 msgid "" "The directory to be watched for @file{.torrent} files indicating new " "torrents to be added, when @code{watch-dir-enabled} is @code{#t}." msgstr "" #. type: deftypevr #: doc/guix.texi:27341 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean trash-original-torrent-files?" msgstr "" #. type: deftypevr #: doc/guix.texi:27345 msgid "" "When @code{#t}, @file{.torrent} files will be deleted from the watch " "directory once their torrent has been added (see @code{watch-directory-" "enabled?})." msgstr "" #. type: deftypevr #: doc/guix.texi:27350 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean speed-limit-down-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27353 msgid "" "When @code{#t}, the daemon's download speed will be limited to the rate " "specified by @code{speed-limit-down}." msgstr "" #. type: deftypevr #: doc/guix.texi:27358 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer speed-limit-down" msgstr "" #. type: deftypevr #: doc/guix.texi:27360 msgid "The default global-maximum download speed, in kilobytes per second." msgstr "" #. type: deftypevr #: doc/guix.texi:27365 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean speed-limit-up-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27368 msgid "" "When @code{#t}, the daemon's upload speed will be limited to the rate " "specified by @code{speed-limit-up}." msgstr "" #. type: deftypevr #: doc/guix.texi:27373 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer speed-limit-up" msgstr "" #. type: deftypevr #: doc/guix.texi:27375 msgid "The default global-maximum upload speed, in kilobytes per second." msgstr "" #. type: deftypevr #: doc/guix.texi:27380 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean alt-speed-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27386 msgid "" "When @code{#t}, the alternate speed limits @code{alt-speed-down} and " "@code{alt-speed-up} are used (in place of @code{speed-limit-down} and " "@code{speed-limit-up}, if they are enabled) to constrain the daemon's " "bandwidth usage. This can be scheduled to occur automatically at certain " "times during the week; see @code{alt-speed-time-enabled?}." msgstr "" #. type: deftypevr #: doc/guix.texi:27391 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer alt-speed-down" msgstr "" #. type: deftypevr #: doc/guix.texi:27393 msgid "The alternate global-maximum download speed, in kilobytes per second." msgstr "" #. type: deftypevr #: doc/guix.texi:27395 doc/guix.texi:27402 doc/guix.texi:27574 #: doc/guix.texi:35144 doc/guix.texi:35159 msgid "Defaults to @samp{50}." msgstr "" #. type: deftypevr #: doc/guix.texi:27398 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer alt-speed-up" msgstr "" #. type: deftypevr #: doc/guix.texi:27400 msgid "The alternate global-maximum upload speed, in kilobytes per second." msgstr "" #. type: deftypevr #: doc/guix.texi:27405 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean alt-speed-time-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27410 msgid "" "When @code{#t}, the alternate speed limits @code{alt-speed-down} and " "@code{alt-speed-up} will be enabled automatically during the periods " "specified by @code{alt-speed-time-day}, @code{alt-speed-time-begin} and " "@code{alt-time-speed-end}." msgstr "" #. type: deftypevr #: doc/guix.texi:27415 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} day-list alt-speed-time-day" msgstr "" #. type: deftypevr #: doc/guix.texi:27420 msgid "" "The days of the week on which the alternate-speed schedule should be used, " "specified either as a list of days (@code{sunday}, @code{monday}, and so on) " "or using one of the symbols @code{weekdays}, @code{weekends} or @code{all}." msgstr "" #. type: deftypevr #: doc/guix.texi:27422 msgid "Defaults to @samp{all}." msgstr "" #. type: deftypevr #: doc/guix.texi:27425 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer alt-speed-time-begin" msgstr "" #. type: deftypevr #: doc/guix.texi:27428 msgid "" "The time of day at which to enable the alternate speed limits, expressed as " "a number of minutes since midnight." msgstr "" #. type: deftypevr #: doc/guix.texi:27430 msgid "Defaults to @samp{540}." msgstr "" #. type: deftypevr #: doc/guix.texi:27433 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer alt-speed-time-end" msgstr "" #. type: deftypevr #: doc/guix.texi:27436 msgid "" "The time of day at which to disable the alternate speed limits, expressed as " "a number of minutes since midnight." msgstr "" #. type: deftypevr #: doc/guix.texi:27438 msgid "Defaults to @samp{1020}." msgstr "" #. type: deftypevr #: doc/guix.texi:27441 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} string bind-address-ipv4" msgstr "" #. type: deftypevr #: doc/guix.texi:27444 msgid "" "The IP address at which to listen for peer connections, or ``0.0.0.0'' to " "listen at all available IP addresses." msgstr "" #. type: deftypevr #: doc/guix.texi:27446 doc/guix.texi:27749 doc/guix.texi:32983 msgid "Defaults to @samp{\"0.0.0.0\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:27449 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} string bind-address-ipv6" msgstr "" #. type: deftypevr #: doc/guix.texi:27452 msgid "" "The IPv6 address at which to listen for peer connections, or ``::'' to " "listen at all available IPv6 addresses." msgstr "" #. type: deftypevr #: doc/guix.texi:27454 msgid "Defaults to @samp{\"::\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:27457 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean peer-port-random-on-start?" msgstr "" #. type: deftypevr #: doc/guix.texi:27463 msgid "" "If @code{#t}, when the daemon starts it will select a port at random on " "which to listen for peer connections, from the range specified (inclusively) " "by @code{peer-port-random-low} and @code{peer-port-random-high}. Otherwise, " "it listens on the port specified by @code{peer-port}." msgstr "" #. type: deftypevr #: doc/guix.texi:27468 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} port-number peer-port-random-low" msgstr "" #. type: deftypevr #: doc/guix.texi:27471 msgid "" "The lowest selectable port number when @code{peer-port-random-on-start?} is " "@code{#t}." msgstr "" #. type: deftypevr #: doc/guix.texi:27473 msgid "Defaults to @samp{49152}." msgstr "" #. type: deftypevr #: doc/guix.texi:27476 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} port-number peer-port-random-high" msgstr "" #. type: deftypevr #: doc/guix.texi:27479 msgid "" "The highest selectable port number when @code{peer-port-random-on-start} is " "@code{#t}." msgstr "" #. type: deftypevr #: doc/guix.texi:27481 msgid "Defaults to @samp{65535}." msgstr "" #. type: deftypevr #: doc/guix.texi:27484 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} port-number peer-port" msgstr "" #. type: deftypevr #: doc/guix.texi:27487 msgid "" "The port on which to listen for peer connections when @code{peer-port-random-" "on-start?} is @code{#f}." msgstr "" #. type: deftypevr #: doc/guix.texi:27489 msgid "Defaults to @samp{51413}." msgstr "" #. type: deftypevr #: doc/guix.texi:27492 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean port-forwarding-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27496 msgid "" "If @code{#t}, the daemon will attempt to configure port-forwarding on an " "upstream gateway automatically using @acronym{UPnP} and @acronym{NAT-PMP}." msgstr "" #. type: deftypevr #: doc/guix.texi:27501 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} encryption-mode encryption" msgstr "" #. type: deftypevr #: doc/guix.texi:27506 msgid "" "The encryption preference for peer connections, one of @code{prefer-" "unencrypted-connections}, @code{prefer-encrypted-connections} or " "@code{require-encrypted-connections}." msgstr "" #. type: deftypevr #: doc/guix.texi:27508 msgid "Defaults to @samp{prefer-encrypted-connections}." msgstr "" #. type: deftypevr #: doc/guix.texi:27511 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} maybe-string peer-congestion-algorithm" msgstr "" #. type: deftypevr #: doc/guix.texi:27516 msgid "" "The TCP congestion-control algorithm to use for peer connections, specified " "using a string recognized by the operating system in calls to " "@code{setsockopt}. When left unspecified, the operating-system default is " "used." msgstr "" #. type: deftypevr #: doc/guix.texi:27525 msgid "" "Note that on GNU/Linux systems, the kernel must be configured to allow " "processes to use a congestion-control algorithm not in the default set; " "otherwise, it will deny these requests with ``Operation not permitted''. To " "see which algorithms are available on your system and which are currently " "permitted for use, look at the contents of the files " "@file{tcp_available_congestion_control} and " "@file{tcp_allowed_congestion_control} in the @file{/proc/sys/net/ipv4} " "directory." msgstr "" #. type: deftypevr #: doc/guix.texi:27533 msgid "" "As an example, to have Transmission Daemon use @uref{http://www-ece.rice.edu/" "networks/TCP-LP/,the TCP Low Priority congestion-control algorithm}, you'll " "need to modify your kernel configuration to build in support for the " "algorithm, then update your operating-system configuration to allow its use " "by adding a @code{sysctl-service-type} service (or updating the existing " "one's configuration) with lines like the following:" msgstr "" #. type: lisp #: doc/guix.texi:27540 #, no-wrap msgid "" "(service sysctl-service-type\n" " (sysctl-configuration\n" " (settings\n" " (\"net.ipv4.tcp_allowed_congestion_control\" .\n" " \"reno cubic lp\"))))\n" msgstr "" #. type: deftypevr #: doc/guix.texi:27543 msgid "The Transmission Daemon configuration can then be updated with" msgstr "" #. type: lisp #: doc/guix.texi:27546 #, no-wrap msgid "(peer-congestion-algorithm \"lp\")\n" msgstr "" #. type: deftypevr #: doc/guix.texi:27549 msgid "and the system reconfigured to have the changes take effect." msgstr "" #. type: deftypevr #: doc/guix.texi:27554 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} tcp-type-of-service peer-socket-tos" msgstr "" #. type: deftypevr #: doc/guix.texi:27558 msgid "" "The type of service to request in outgoing @acronym{TCP} packets, one of " "@code{default}, @code{low-cost}, @code{throughput}, @code{low-delay} and " "@code{reliability}." msgstr "" #. type: deftypevr #: doc/guix.texi:27560 msgid "Defaults to @samp{default}." msgstr "" #. type: deftypevr #: doc/guix.texi:27563 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer peer-limit-global" msgstr "" #. type: deftypevr #: doc/guix.texi:27565 msgid "The global limit on the number of connected peers." msgstr "" #. type: deftypevr #: doc/guix.texi:27567 msgid "Defaults to @samp{200}." msgstr "" #. type: deftypevr #: doc/guix.texi:27570 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer peer-limit-per-torrent" msgstr "" #. type: deftypevr #: doc/guix.texi:27572 msgid "The per-torrent limit on the number of connected peers." msgstr "" #. type: deftypevr #: doc/guix.texi:27577 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer upload-slots-per-torrent" msgstr "" #. type: deftypevr #: doc/guix.texi:27580 msgid "" "The maximum number of peers to which the daemon will upload data " "simultaneously for each torrent." msgstr "" #. type: deftypevr #: doc/guix.texi:27582 msgid "Defaults to @samp{14}." msgstr "" #. type: deftypevr #: doc/guix.texi:27585 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer peer-id-ttl-hours" msgstr "" #. type: deftypevr #: doc/guix.texi:27588 msgid "" "The maximum lifespan, in hours, of the peer ID associated with each public " "torrent before it is regenerated." msgstr "" #. type: deftypevr #: doc/guix.texi:27590 msgid "Defaults to @samp{6}." msgstr "" #. type: deftypevr #: doc/guix.texi:27593 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean blocklist-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27596 msgid "" "When @code{#t}, the daemon will ignore peers mentioned in the blocklist it " "has most recently downloaded from @code{blocklist-url}." msgstr "" #. type: deftypevr #: doc/guix.texi:27601 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} maybe-string blocklist-url" msgstr "" #. type: deftypevr #: doc/guix.texi:27605 msgid "" "The URL of a peer blocklist (in @acronym{P2P}-plaintext or eMule @file{.dat} " "format) to be periodically downloaded and applied when @code{blocklist-" "enabled?} is @code{#t}." msgstr "" #. type: deftypevr #: doc/guix.texi:27610 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean download-queue-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27613 msgid "" "If @code{#t}, the daemon will be limited to downloading at most " "@code{download-queue-size} non-stalled torrents simultaneously." msgstr "" #. type: deftypevr #: doc/guix.texi:27618 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer download-queue-size" msgstr "" #. type: deftypevr #: doc/guix.texi:27622 msgid "" "The size of the daemon's download queue, which limits the number of non-" "stalled torrents it will download at any one time when @code{download-queue-" "enabled?} is @code{#t}." msgstr "" #. type: deftypevr #: doc/guix.texi:27627 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean seed-queue-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27630 msgid "" "If @code{#t}, the daemon will be limited to seeding at most @code{seed-queue-" "size} non-stalled torrents simultaneously." msgstr "" #. type: deftypevr #: doc/guix.texi:27635 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer seed-queue-size" msgstr "" #. type: deftypevr #: doc/guix.texi:27639 msgid "" "The size of the daemon's seed queue, which limits the number of non-stalled " "torrents it will seed at any one time when @code{seed-queue-enabled?} is " "@code{#t}." msgstr "" #. type: deftypevr #: doc/guix.texi:27644 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean queue-stalled-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27649 msgid "" "When @code{#t}, the daemon will consider torrents for which it has not " "shared data in the past @code{queue-stalled-minutes} minutes to be stalled " "and not count them against its @code{download-queue-size} and @code{seed-" "queue-size} limits." msgstr "" #. type: deftypevr #: doc/guix.texi:27654 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer queue-stalled-minutes" msgstr "" #. type: deftypevr #: doc/guix.texi:27658 msgid "" "The maximum period, in minutes, a torrent may be idle before it is " "considered to be stalled, when @code{queue-stalled-enabled?} is @code{#t}." msgstr "" #. type: deftypevr #: doc/guix.texi:27663 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean ratio-limit-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27666 msgid "" "When @code{#t}, a torrent being seeded will automatically be paused once it " "reaches the ratio specified by @code{ratio-limit}." msgstr "" #. type: deftypevr #: doc/guix.texi:27671 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} non-negative-rational ratio-limit" msgstr "" #. type: deftypevr #: doc/guix.texi:27674 msgid "" "The ratio at which a torrent being seeded will be paused, when @code{ratio-" "limit-enabled?} is @code{#t}." msgstr "" #. type: deftypevr #: doc/guix.texi:27676 msgid "Defaults to @samp{2.0}." msgstr "" #. type: deftypevr #: doc/guix.texi:27679 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean idle-seeding-limit-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27682 msgid "" "When @code{#t}, a torrent being seeded will automatically be paused once it " "has been idle for @code{idle-seeding-limit} minutes." msgstr "" #. type: deftypevr #: doc/guix.texi:27687 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer idle-seeding-limit" msgstr "" #. type: deftypevr #: doc/guix.texi:27691 msgid "" "The maximum period, in minutes, a torrent being seeded may be idle before it " "is paused, when @code{idle-seeding-limit-enabled?} is @code{#t}." msgstr "" #. type: deftypevr #: doc/guix.texi:27696 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean dht-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27700 msgid "" "Enable @uref{http://bittorrent.org/beps/bep_0005.html,the distributed hash " "table (@acronym{DHT}) protocol}, which supports the use of trackerless " "torrents." msgstr "" #. type: deftypevr #: doc/guix.texi:27705 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean lpd-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27710 msgid "" "Enable @uref{https://en.wikipedia.org/wiki/Local_Peer_Discovery,local peer " "discovery} (@acronym{LPD}), which allows the discovery of peers on the local " "network and may reduce the amount of data sent over the public Internet." msgstr "" #. type: deftypevr #: doc/guix.texi:27715 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean pex-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27719 msgid "" "Enable @uref{https://en.wikipedia.org/wiki/Peer_exchange,peer exchange} " "(@acronym{PEX}), which reduces the daemon's reliance on external trackers " "and may improve its performance." msgstr "" #. type: deftypevr #: doc/guix.texi:27724 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean utp-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27729 msgid "" "Enable @uref{http://bittorrent.org/beps/bep_0029.html,the micro transport " "protocol} (@acronym{uTP}), which aims to reduce the impact of BitTorrent " "traffic on other users of the local network while maintaining full " "utilization of the available bandwidth." msgstr "" #. type: deftypevr #: doc/guix.texi:27734 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean rpc-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27739 msgid "" "If @code{#t}, enable the remote procedure call (@acronym{RPC}) interface, " "which allows remote control of the daemon via its Web interface, the " "@command{transmission-remote} command-line client, and similar tools." msgstr "" #. type: deftypevr #: doc/guix.texi:27744 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} string rpc-bind-address" msgstr "" #. type: deftypevr #: doc/guix.texi:27747 msgid "" "The IP address at which to listen for @acronym{RPC} connections, or " "``0.0.0.0'' to listen at all available IP addresses." msgstr "" #. type: deftypevr #: doc/guix.texi:27752 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} port-number rpc-port" msgstr "" #. type: deftypevr #: doc/guix.texi:27754 msgid "The port on which to listen for @acronym{RPC} connections." msgstr "" #. type: deftypevr #: doc/guix.texi:27756 msgid "Defaults to @samp{9091}." msgstr "" #. type: deftypevr #: doc/guix.texi:27759 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} string rpc-url" msgstr "" #. type: deftypevr #: doc/guix.texi:27761 msgid "The path prefix to use in the @acronym{RPC}-endpoint @acronym{URL}." msgstr "" #. type: deftypevr #: doc/guix.texi:27763 msgid "Defaults to @samp{\"/transmission/\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:27766 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean rpc-authentication-required?" msgstr "" #. type: deftypevr #: doc/guix.texi:27771 msgid "" "When @code{#t}, clients must authenticate (see @code{rpc-username} and " "@code{rpc-password}) when using the @acronym{RPC} interface. Note this has " "the side effect of disabling host-name whitelisting (see @code{rpc-host-" "whitelist-enabled?}." msgstr "" #. type: deftypevr #: doc/guix.texi:27776 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} maybe-string rpc-username" msgstr "" #. type: deftypevr #: doc/guix.texi:27779 msgid "" "The username required by clients to access the @acronym{RPC} interface when " "@code{rpc-authentication-required?} is @code{#t}." msgstr "" #. type: deftypevr #: doc/guix.texi:27784 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} maybe-transmission-password-hash rpc-password" msgstr "" #. type: deftypevr #: doc/guix.texi:27790 msgid "" "The password required by clients to access the @acronym{RPC} interface when " "@code{rpc-authentication-required?} is @code{#t}. This must be specified " "using a password hash in the format recognized by Transmission clients, " "either copied from an existing @file{settings.json} file or generated using " "the @code{transmission-password-hash} procedure." msgstr "" #. type: deftypevr #: doc/guix.texi:27795 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean rpc-whitelist-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27798 msgid "" "When @code{#t}, @acronym{RPC} requests will be accepted only when they " "originate from an address specified in @code{rpc-whitelist}." msgstr "" #. type: deftypevr #: doc/guix.texi:27803 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} string-list rpc-whitelist" msgstr "" #. type: deftypevr #: doc/guix.texi:27807 msgid "" "The list of IP and IPv6 addresses from which @acronym{RPC} requests will be " "accepted when @code{rpc-whitelist-enabled?} is @code{#t}. Wildcards may be " "specified using @samp{*}." msgstr "" #. type: deftypevr #: doc/guix.texi:27809 msgid "Defaults to @samp{(\"127.0.0.1\" \"::1\")}." msgstr "" #. type: deftypevr #: doc/guix.texi:27812 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean rpc-host-whitelist-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27817 msgid "" "When @code{#t}, @acronym{RPC} requests will be accepted only when they are " "addressed to a host named in @code{rpc-host-whitelist}. Note that requests " "to ``localhost'' or ``localhost.'', or to a numeric address, are always " "accepted regardless of these settings." msgstr "" #. type: deftypevr #: doc/guix.texi:27820 msgid "" "Note also this functionality is disabled when @code{rpc-authentication-" "required?} is @code{#t}." msgstr "" #. type: deftypevr #: doc/guix.texi:27825 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} string-list rpc-host-whitelist" msgstr "" #. type: deftypevr #: doc/guix.texi:27828 msgid "" "The list of host names recognized by the @acronym{RPC} server when @code{rpc-" "host-whitelist-enabled?} is @code{#t}." msgstr "" #. type: deftypevr #: doc/guix.texi:27833 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} message-level message-level" msgstr "" #. type: deftypevr #: doc/guix.texi:27837 msgid "" "The minimum severity level of messages to be logged (to @file{/var/log/" "transmission.log}) by the daemon, one of @code{none} (no logging), " "@code{error}, @code{info} and @code{debug}." msgstr "" #. type: deftypevr #: doc/guix.texi:27842 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean start-added-torrents?" msgstr "" #. type: deftypevr #: doc/guix.texi:27845 msgid "" "When @code{#t}, torrents are started as soon as they are added; otherwise, " "they are added in ``paused'' state." msgstr "" #. type: deftypevr #: doc/guix.texi:27850 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean script-torrent-done-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27854 msgid "" "When @code{#t}, the script specified by @code{script-torrent-done-filename} " "will be invoked each time a torrent completes." msgstr "" #. type: deftypevr #: doc/guix.texi:27859 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} maybe-file-object script-torrent-done-filename" msgstr "" #. type: deftypevr #: doc/guix.texi:27863 msgid "" "A file name or file-like object specifying a script to run each time a " "torrent completes, when @code{script-torrent-done-enabled?} is @code{#t}." msgstr "" #. type: deftypevr #: doc/guix.texi:27868 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean scrape-paused-torrents-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27871 msgid "" "When @code{#t}, the daemon will scrape trackers for a torrent even when the " "torrent is paused." msgstr "" #. type: deftypevr #: doc/guix.texi:27876 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer cache-size-mb" msgstr "" #. type: deftypevr #: doc/guix.texi:27880 msgid "" "The amount of memory, in megabytes, to allocate for the daemon's in-memory " "cache. A larger value may increase performance by reducing the frequency of " "disk I/O." msgstr "" #. type: deftypevr #: doc/guix.texi:27882 msgid "Defaults to @samp{4}." msgstr "" #. type: deftypevr #: doc/guix.texi:27885 #, no-wrap msgid "{@code{transmission-daemon-configuration} parameter} boolean prefetch-enabled?" msgstr "" #. type: deftypevr #: doc/guix.texi:27889 msgid "" "When @code{#t}, the daemon will try to improve I/O performance by hinting to " "the operating system which data is likely to be read next from disk to " "satisfy requests from peers." msgstr "" #. type: subsubheading #: doc/guix.texi:27902 #, no-wrap msgid "Tailon Service" msgstr "" #. type: Plain text #: doc/guix.texi:27906 msgid "" "@uref{https://tailon.readthedocs.io/, Tailon} is a web application for " "viewing and searching log files." msgstr "" #. type: Plain text #: doc/guix.texi:27909 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: lisp #: doc/guix.texi:27912 #, no-wrap msgid "(service tailon-service-type)\n" msgstr "" #. type: Plain text #: doc/guix.texi:27916 msgid "" "The following example customises more of the Tailon configuration, adding " "@command{sed} to the list of allowed commands." msgstr "" #. type: lisp #: doc/guix.texi:27923 #, 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:27926 #, no-wrap msgid "{Data Type} tailon-configuration" msgstr "" #. type: deftp #: doc/guix.texi:27929 msgid "" "Data type representing the configuration of Tailon. This type has the " "following parameters:" msgstr "" #. type: item #: doc/guix.texi:27931 #, no-wrap msgid "@code{config-file} (default: @code{(tailon-configuration-file)})" msgstr "" #. type: table #: doc/guix.texi:27935 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:27938 msgid "" "For example, to instead use a local file, the @code{local-file} function can " "be used:" msgstr "" #. type: lisp #: doc/guix.texi:27943 #, 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:27945 #, no-wrap msgid "@code{package} (default: @code{tailon})" msgstr "" #. type: table #: doc/guix.texi:27947 msgid "The tailon package to use." msgstr "" #. type: deftp #: doc/guix.texi:27951 #, no-wrap msgid "{Data Type} tailon-configuration-file" msgstr "" #. type: deftp #: doc/guix.texi:27954 msgid "" "Data type representing the configuration options for Tailon. This type has " "the following parameters:" msgstr "" #. type: item #: doc/guix.texi:27956 #, no-wrap msgid "@code{files} (default: @code{(list \"/var/log\")})" msgstr "" #. type: table #: doc/guix.texi:27961 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:27962 #, no-wrap msgid "@code{bind} (default: @code{\"localhost:8080\"})" msgstr "" #. type: table #: doc/guix.texi:27964 msgid "Address and port to which Tailon should bind on." msgstr "" #. type: item #: doc/guix.texi:27965 #, no-wrap msgid "@code{relative-root} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:27967 msgid "URL path to use for Tailon, set to @code{#f} to not use a path." msgstr "" #. type: item #: doc/guix.texi:27968 #, no-wrap msgid "@code{allow-transfers?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:27970 msgid "Allow downloading the log files in the web interface." msgstr "" #. type: item #: doc/guix.texi:27971 #, no-wrap msgid "@code{follow-names?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:27973 msgid "Allow tailing of not-yet existent files." msgstr "" #. type: item #: doc/guix.texi:27974 #, no-wrap msgid "@code{tail-lines} (default: @code{200})" msgstr "" #. type: table #: doc/guix.texi:27976 msgid "Number of lines to read initially from each file." msgstr "" #. type: item #: doc/guix.texi:27977 #, no-wrap msgid "@code{allowed-commands} (default: @code{(list \"tail\" \"grep\" \"awk\")})" msgstr "" #. type: table #: doc/guix.texi:27979 msgid "Commands to allow running. By default, @code{sed} is disabled." msgstr "" #. type: table #: doc/guix.texi:27982 msgid "Set @code{debug?} to @code{#t} to show debug messages." msgstr "" #. type: item #: doc/guix.texi:27983 #, no-wrap msgid "@code{wrap-lines} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:27987 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:27988 #, no-wrap msgid "@code{http-auth} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:27992 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:27993 #, no-wrap msgid "@code{users} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:27998 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: lisp #: doc/guix.texi:28004 #, no-wrap msgid "" "(tailon-configuration-file\n" " (http-auth \"basic\")\n" " (users '((\"user1\" . \"password1\")\n" " (\"user2\" . \"password2\"))))\n" msgstr "" #. type: subsubheading #: doc/guix.texi:28010 #, no-wrap msgid "Darkstat Service" msgstr "" #. type: cindex #: doc/guix.texi:28011 #, no-wrap msgid "darkstat" msgstr "" #. type: Plain text #: doc/guix.texi:28014 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:28015 #, no-wrap msgid "{Scheme Variable} darkstat-service-type" msgstr "" #. type: defvar #: doc/guix.texi:28020 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: lisp #: doc/guix.texi:28025 #, no-wrap msgid "" "(service darkstat-service-type\n" " (darkstat-configuration\n" " (interface \"eno1\")))\n" msgstr "" #. type: deftp #: doc/guix.texi:28028 #, no-wrap msgid "{Data Type} darkstat-configuration" msgstr "" #. type: deftp #: doc/guix.texi:28030 msgid "Data type representing the configuration of @command{darkstat}." msgstr "" #. type: item #: doc/guix.texi:28032 #, no-wrap msgid "@code{package} (default: @code{darkstat})" msgstr "" #. type: table #: doc/guix.texi:28034 msgid "The darkstat package to use." msgstr "" #. type: code{#1} #: doc/guix.texi:28035 #, no-wrap msgid "interface" msgstr "" #. type: table #: doc/guix.texi:28037 msgid "Capture traffic on the specified network interface." msgstr "" #. type: item #: doc/guix.texi:28038 #, no-wrap msgid "@code{port} (default: @code{\"667\"})" msgstr "" #. type: table #: doc/guix.texi:28040 msgid "Bind the web interface to the specified port." msgstr "" #. type: table #: doc/guix.texi:28043 doc/guix.texi:28079 msgid "Bind the web interface to the specified address." msgstr "" #. type: item #: doc/guix.texi:28044 #, no-wrap msgid "@code{base} (default: @code{\"/\"})" msgstr "" #. type: table #: doc/guix.texi:28047 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:28052 doc/guix.texi:28053 #, no-wrap msgid "prometheus-node-exporter" msgstr "" #. type: subsubheading #: doc/guix.texi:28052 #, no-wrap msgid "Prometheus Node Exporter Service" msgstr "" #. type: Plain text #: doc/guix.texi:28059 msgid "" "The Prometheus ``node exporter'' makes hardware and operating system " "statistics provided by the Linux kernel available for the Prometheus " "monitoring system. This service should be deployed on all physical nodes " "and virtual machines, where monitoring these statistics is desirable." msgstr "" #. type: defvar #: doc/guix.texi:28060 #, no-wrap msgid "{Scheme variable} prometheus-node-exporter-service-type" msgstr "" #. type: defvar #: doc/guix.texi:28064 msgid "" "This is the service type for the @uref{https://github.com/prometheus/" "node_exporter/, prometheus-node-exporter} service, its value must be a " "@code{prometheus-node-exporter-configuration}." msgstr "" #. type: lisp #: doc/guix.texi:28067 #, no-wrap msgid "(service prometheus-node-exporter-service-type)\n" msgstr "" #. type: deftp #: doc/guix.texi:28070 #, no-wrap msgid "{Data Type} prometheus-node-exporter-configuration" msgstr "" #. type: deftp #: doc/guix.texi:28072 msgid "Data type representing the configuration of @command{node_exporter}." msgstr "" #. type: item #: doc/guix.texi:28074 #, no-wrap msgid "@code{package} (default: @code{go-github-com-prometheus-node-exporter})" msgstr "" #. type: table #: doc/guix.texi:28076 msgid "The prometheus-node-exporter package to use." msgstr "" #. type: item #: doc/guix.texi:28077 #, no-wrap msgid "@code{web-listen-address} (default: @code{\":9100\"})" msgstr "" #. type: item #: doc/guix.texi:28080 #, no-wrap msgid "@code{textfile-directory} (default: @code{\"/var/lib/prometheus/node-exporter\"})" msgstr "" #. type: table #: doc/guix.texi:28084 msgid "" "This directory can be used to export metrics specific to this machine. " "Files containing metrics in the text format, with the filename ending in " "@code{.prom} should be placed in this directory." msgstr "" #. type: table #: doc/guix.texi:28087 msgid "Extra options to pass to the Prometheus node exporter." msgstr "" #. type: subsubheading #: doc/guix.texi:28091 #, no-wrap msgid "Zabbix server" msgstr "" #. type: cindex #: doc/guix.texi:28092 #, no-wrap msgid "zabbix zabbix-server" msgstr "" #. type: Plain text #: doc/guix.texi:28097 msgid "" "Zabbix is a high performance monitoring system that can collect data from a " "variety of sources and provide the results in a web-based interface. " "Alerting and reporting is built-in, as well as @dfn{templates} for common " "operating system metrics such as network utilization, CPU load, and disk " "space consumption." msgstr "" #. type: Plain text #: doc/guix.texi:28104 msgid "" "This service provides the central Zabbix monitoring service; you also need " "@ref{zabbix-front-end,@code{zabbix-front-end-service-type}} to configure " "Zabbix and display results, and optionally @ref{zabbix-agent, @code{zabbix-" "agent-service-type}} on machines that should be monitored (other data " "sources are supported, such as @ref{prometheus-node-exporter, Prometheus " "Node Exporter})." msgstr "" #. type: defvar #: doc/guix.texi:28105 #, no-wrap msgid "{Scheme variable} zabbix-server-service-type" msgstr "" #. type: defvar #: doc/guix.texi:28108 msgid "" "This is the service type for the Zabbix server service. Its value must be a " "@code{zabbix-server-configuration} record, shown below." msgstr "" #. type: deftp #: doc/guix.texi:28112 #, no-wrap msgid "{Data Type} zabbix-server-configuration" msgstr "" #. type: deftp #: doc/guix.texi:28114 msgid "Available @code{zabbix-server-configuration} fields are:" msgstr "" #. type: item #: doc/guix.texi:28116 doc/guix.texi:28279 #, no-wrap msgid "@code{zabbix-server} (default: @code{zabbix-server}) (type: file-like)" msgstr "" #. type: table #: doc/guix.texi:28118 msgid "The zabbix-server package." msgstr "" #. type: item #: doc/guix.texi:28119 doc/guix.texi:28205 #, no-wrap msgid "@code{user} (default: @code{\"zabbix\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:28121 msgid "User who will run the Zabbix server." msgstr "" #. type: item #: doc/guix.texi:28122 doc/guix.texi:28208 #, no-wrap msgid "@code{group} (default: @code{\"zabbix\"}) (type: group)" msgstr "" #. type: table #: doc/guix.texi:28124 msgid "Group who will run the Zabbix server." msgstr "" #. type: item #: doc/guix.texi:28125 #, no-wrap msgid "@code{db-host} (default: @code{\"127.0.0.1\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:28127 doc/guix.texi:28289 msgid "Database host name." msgstr "" #. type: item #: doc/guix.texi:28128 doc/guix.texi:28293 #, no-wrap msgid "@code{db-name} (default: @code{\"zabbix\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:28130 doc/guix.texi:28295 msgid "Database name." msgstr "" #. type: item #: doc/guix.texi:28131 doc/guix.texi:28296 #, no-wrap msgid "@code{db-user} (default: @code{\"zabbix\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:28133 doc/guix.texi:28298 msgid "Database user." msgstr "" #. type: item #: doc/guix.texi:28134 doc/guix.texi:28299 #, no-wrap msgid "@code{db-password} (default: @code{\"\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:28137 msgid "" "Database password. Please, use @code{include-files} with " "@code{DBPassword=SECRET} inside a specified file instead." msgstr "" #. type: item #: doc/guix.texi:28138 doc/guix.texi:28290 #, no-wrap msgid "@code{db-port} (default: @code{5432}) (type: number)" msgstr "" #. type: table #: doc/guix.texi:28140 doc/guix.texi:28292 msgid "Database port." msgstr "" #. type: item #: doc/guix.texi:28141 doc/guix.texi:28215 #, no-wrap msgid "@code{log-type} (default: @code{\"\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:28143 doc/guix.texi:28217 msgid "Specifies where log messages are written to:" msgstr "" #. type: itemize #: doc/guix.texi:28146 doc/guix.texi:28221 #, no-wrap msgid "@code{system} - syslog." msgstr "" #. type: item #: doc/guix.texi:28148 #, no-wrap msgid "@code{file} - file specified with @code{log-file} parameter." msgstr "" #. type: item #: doc/guix.texi:28150 doc/guix.texi:28225 #, no-wrap msgid "@code{console} - standard output." msgstr "" #. type: item #: doc/guix.texi:28154 #, no-wrap msgid "@code{log-file} (default: @code{\"/var/log/zabbix/server.log\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:28156 doc/guix.texi:28231 msgid "Log file name for @code{log-type} @code{file} parameter." msgstr "" #. type: item #: doc/guix.texi:28157 #, no-wrap msgid "@code{pid-file} (default: @code{\"/var/run/zabbix/zabbix_server.pid\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:28159 doc/guix.texi:28234 msgid "Name of PID file." msgstr "" #. type: item #: doc/guix.texi:28160 #, no-wrap msgid "@code{ssl-ca-location} (default: @code{\"/etc/ssl/certs/ca-certificates.crt\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:28163 msgid "" "The location of certificate authority (CA) files for SSL server certificate " "verification." msgstr "" #. type: item #: doc/guix.texi:28164 #, no-wrap msgid "@code{ssl-cert-location} (default: @code{\"/etc/ssl/certs\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:28166 msgid "Location of SSL client certificates." msgstr "" #. type: item #: doc/guix.texi:28167 doc/guix.texi:28245 #, no-wrap msgid "@code{extra-options} (default: @code{\"\"}) (type: extra-options)" msgstr "" #. type: table #: doc/guix.texi:28169 doc/guix.texi:28247 msgid "Extra options will be appended to Zabbix server configuration file." msgstr "" #. type: item #: doc/guix.texi:28170 doc/guix.texi:28248 #, no-wrap msgid "@code{include-files} (default: @code{()}) (type: include-files)" msgstr "" #. type: table #: doc/guix.texi:28173 doc/guix.texi:28251 msgid "" "You may include individual files or all files in a directory in the " "configuration file." msgstr "" #. type: anchor{#1} #: doc/guix.texi:28182 msgid "zabbix-agent" msgstr "" #. type: subsubheading #: doc/guix.texi:28182 #, no-wrap msgid "Zabbix agent" msgstr "" #. type: cindex #: doc/guix.texi:28183 #, no-wrap msgid "zabbix zabbix-agent" msgstr "" #. type: Plain text #: doc/guix.texi:28190 msgid "" "The Zabbix agent gathers information about the running system for the Zabbix " "monitoring server. It has a variety of built-in checks, and can be extended " "with custom @uref{https://www.zabbix.com/documentation/current/en/manual/" "config/items/userparameters, @dfn{user parameters}}." msgstr "" #. type: defvar #: doc/guix.texi:28191 #, no-wrap msgid "{Scheme variable} zabbix-agent-service-type" msgstr "" #. type: defvar #: doc/guix.texi:28194 msgid "" "This is the service type for the Zabbix agent service. Its value must be a " "@code{zabbix-agent-configuration} record, shown below." msgstr "" #. type: deftp #: doc/guix.texi:28198 #, no-wrap msgid "{Data Type} zabbix-agent-configuration" msgstr "" #. type: deftp #: doc/guix.texi:28200 msgid "Available @code{zabbix-agent-configuration} fields are:" msgstr "" #. type: item #: doc/guix.texi:28202 #, no-wrap msgid "@code{zabbix-agent} (default: @code{zabbix-agentd}) (type: file-like)" msgstr "" #. type: table #: doc/guix.texi:28204 msgid "The zabbix-agent package." msgstr "" #. type: table #: doc/guix.texi:28207 msgid "User who will run the Zabbix agent." msgstr "" #. type: table #: doc/guix.texi:28210 msgid "Group who will run the Zabbix agent." msgstr "" #. type: item #: doc/guix.texi:28211 #, no-wrap msgid "@code{hostname} (default: @code{\"\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:28214 msgid "" "Unique, case sensitive hostname which is required for active checks and must " "match hostname as configured on the server." msgstr "" #. type: item #: doc/guix.texi:28222 #, no-wrap msgid "@code{file} - file specified with" msgstr "" #. type: itemize #: doc/guix.texi:28224 msgid "@code{log-file} parameter." msgstr "" #. type: item #: doc/guix.texi:28229 #, no-wrap msgid "@code{log-file} (default: @code{\"/var/log/zabbix/agent.log\"}) (type: string)" msgstr "" #. type: item #: doc/guix.texi:28232 #, no-wrap msgid "@code{pid-file} (default: @code{\"/var/run/zabbix/zabbix_agent.pid\"}) (type: string)" msgstr "" #. type: item #: doc/guix.texi:28235 #, no-wrap msgid "@code{server} (default: @code{(\"127.0.0.1\")}) (type: list)" msgstr "" #. type: table #: doc/guix.texi:28239 msgid "" "List of IP addresses, optionally in CIDR notation, or hostnames of Zabbix " "servers and Zabbix proxies. Incoming connections will be accepted only from " "the hosts listed here." msgstr "" #. type: item #: doc/guix.texi:28240 #, no-wrap msgid "@code{server-active} (default: @code{(\"127.0.0.1\")}) (type: list)" msgstr "" #. type: table #: doc/guix.texi:28244 msgid "" "List of IP:port (or hostname:port) pairs of Zabbix servers and Zabbix " "proxies for active checks. If port is not specified, default port is used. " "If this parameter is not specified, active checks are disabled." msgstr "" #. type: anchor{#1} #: doc/guix.texi:28260 msgid "zabbix-front-end" msgstr "" #. type: subsubheading #: doc/guix.texi:28260 #, no-wrap msgid "Zabbix front-end" msgstr "" #. type: cindex #: doc/guix.texi:28261 #, no-wrap msgid "zabbix zabbix-front-end" msgstr "" #. type: Plain text #: doc/guix.texi:28267 msgid "" "The Zabbix front-end provides a web interface to Zabbix. It does not need " "to run on the same machine as the Zabbix server. This service works by " "extending the @ref{PHP-FPM} and @ref{NGINX} services with the configuration " "necessary for loading the Zabbix user interface." msgstr "" #. type: defvar #: doc/guix.texi:28268 #, no-wrap msgid "{Scheme variable} zabbix-front-end-service-type" msgstr "" #. type: defvar #: doc/guix.texi:28271 msgid "" "This is the service type for the Zabbix web frontend. Its value must be a " "@code{zabbix-front-end-configuration} record, shown below." msgstr "" #. type: deftp #: doc/guix.texi:28275 #, no-wrap msgid "{Data Type} zabbix-front-end-configuration" msgstr "" #. type: deftp #: doc/guix.texi:28277 msgid "Available @code{zabbix-front-end-configuration} fields are:" msgstr "" #. type: table #: doc/guix.texi:28281 msgid "The Zabbix server package to use." msgstr "" #. type: item #: doc/guix.texi:28282 #, no-wrap msgid "@code{nginx} (default: @code{()}) (type: list)" msgstr "" #. type: table #: doc/guix.texi:28286 msgid "" "List of @ref{nginx-server-configuration,@code{nginx-server-configuration}} " "blocks for the Zabbix front-end. When empty, a default that listens on port " "80 is used." msgstr "" #. type: item #: doc/guix.texi:28287 #, no-wrap msgid "@code{db-host} (default: @code{\"localhost\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:28301 msgid "Database password. Please, use @code{db-secret-file} instead." msgstr "" #. type: item #: doc/guix.texi:28302 #, no-wrap msgid "@code{db-secret-file} (default: @code{\"\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:28306 msgid "" "Secret file which will be appended to @file{zabbix.conf.php} file. This " "file contains credentials for use by Zabbix front-end. You are expected to " "create it manually." msgstr "" #. type: item #: doc/guix.texi:28307 #, no-wrap msgid "@code{zabbix-host} (default: @code{\"localhost\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:28309 msgid "Zabbix server hostname." msgstr "" #. type: item #: doc/guix.texi:28310 #, no-wrap msgid "@code{zabbix-port} (default: @code{10051}) (type: number)" msgstr "" #. type: table #: doc/guix.texi:28312 msgid "Zabbix server port." msgstr "" #. type: cindex #: doc/guix.texi:28322 #, no-wrap msgid "Kerberos" msgstr "" #. type: Plain text #: doc/guix.texi:28326 msgid "" "The @code{(gnu services kerberos)} module provides services relating to the " "authentication protocol @dfn{Kerberos}." msgstr "" #. type: subsubheading #: doc/guix.texi:28327 #, no-wrap msgid "Krb5 Service" msgstr "" #. type: Plain text #: doc/guix.texi:28334 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:28338 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:28339 #, no-wrap msgid "{Scheme Variable} krb5-service-type" msgstr "" #. type: defvr #: doc/guix.texi:28341 msgid "A service type for Kerberos 5 clients." msgstr "" #. type: Plain text #: doc/guix.texi:28345 msgid "Here is an example of its use:" msgstr "" #. type: lisp #: doc/guix.texi:28359 #, 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:28363 msgid "This example provides a Kerberos@tie{}5 client configuration which:" msgstr "" #. type: item #: doc/guix.texi:28364 #, no-wrap msgid "Recognizes two realms, @i{viz:} ``EXAMPLE.COM'' and ``ARGRX.EDU'', both" msgstr "" #. type: itemize #: doc/guix.texi:28366 msgid "" "of which have distinct administration servers and key distribution centers;" msgstr "" #. type: item #: doc/guix.texi:28366 #, no-wrap msgid "Will default to the realm ``EXAMPLE.COM'' if the realm is not explicitly" msgstr "" #. type: itemize #: doc/guix.texi:28368 msgid "specified by clients;" msgstr "" #. type: item #: doc/guix.texi:28368 #, no-wrap msgid "Accepts services which only support encryption types known to be weak." msgstr "" #. type: Plain text #: doc/guix.texi:28376 msgid "" "The @code{krb5-realm} and @code{krb5-configuration} types have many fields. " "Only the most commonly used ones are described here. For a full list, and " "more detailed explanation of each, see the MIT @uref{https://web.mit.edu/" "kerberos/krb5-devel/doc/admin/conf_files/krb5_conf.html,,krb5.conf} " "documentation." msgstr "" #. type: deftp #: doc/guix.texi:28378 #, no-wrap msgid "{Data Type} krb5-realm" msgstr "" #. type: cindex #: doc/guix.texi:28379 #, no-wrap msgid "realm, kerberos" msgstr "" #. type: table #: doc/guix.texi:28385 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:28386 #, no-wrap msgid "admin-server" msgstr "" #. type: table #: doc/guix.texi:28389 msgid "" "This field is a string identifying the host where the administration server " "is running." msgstr "" #. type: code{#1} #: doc/guix.texi:28390 #, no-wrap msgid "kdc" msgstr "" #. type: table #: doc/guix.texi:28393 msgid "" "This field is a string identifying the key distribution center for the realm." msgstr "" #. type: deftp #: doc/guix.texi:28396 #, no-wrap msgid "{Data Type} krb5-configuration" msgstr "" #. type: item #: doc/guix.texi:28399 #, no-wrap msgid "@code{allow-weak-crypto?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:28402 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:28403 #, no-wrap msgid "@code{default-realm} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:28410 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:28411 #, no-wrap msgid "realms" msgstr "" #. type: table #: doc/guix.texi:28416 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:28420 #, no-wrap msgid "PAM krb5 Service" msgstr "" #. type: cindex #: doc/guix.texi:28421 #, no-wrap msgid "pam-krb5" msgstr "" #. type: Plain text #: doc/guix.texi:28427 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:28428 #, no-wrap msgid "{Scheme Variable} pam-krb5-service-type" msgstr "" #. type: defvr #: doc/guix.texi:28430 msgid "A service type for the Kerberos 5 PAM module." msgstr "" #. type: deftp #: doc/guix.texi:28432 #, no-wrap msgid "{Data Type} pam-krb5-configuration" msgstr "" #. type: deftp #: doc/guix.texi:28435 msgid "" "Data type representing the configuration of the Kerberos 5 PAM module. This " "type has the following parameters:" msgstr "" #. type: item #: doc/guix.texi:28436 #, no-wrap msgid "@code{pam-krb5} (default: @code{pam-krb5})" msgstr "" #. type: table #: doc/guix.texi:28438 msgid "The pam-krb5 package to use." msgstr "" #. type: item #: doc/guix.texi:28439 #, no-wrap msgid "@code{minimum-uid} (default: @code{1000})" msgstr "" #. type: table #: doc/guix.texi:28442 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:28448 #, no-wrap msgid "LDAP" msgstr "" #. type: cindex #: doc/guix.texi:28449 #, no-wrap msgid "nslcd, LDAP service" msgstr "" #. type: Plain text #: doc/guix.texi:28456 msgid "" "The @code{(gnu services authentication)} module provides the @code{nslcd-" "service-type}, which can be used to authenticate against an LDAP server. In " "addition to configuring the service itself, you may want to add @code{ldap} " "as a name service to the Name Service Switch. @xref{Name Service Switch} for " "detailed information." msgstr "" #. type: Plain text #: doc/guix.texi:28460 msgid "" "Here is a simple operating system declaration with a default configuration " "of the @code{nslcd-service-type} and a Name Service Switch configuration " "that consults the @code{ldap} name service last:" msgstr "" #. type: lisp #: doc/guix.texi:28483 #, no-wrap msgid "" "(use-service-modules authentication)\n" "(use-modules (gnu system nss))\n" "...\n" "(operating-system\n" " ...\n" " (services\n" " (cons*\n" " (service nslcd-service-type)\n" " (service dhcp-client-service-type)\n" " %base-services))\n" " (name-service-switch\n" " (let ((services (list (name-service (name \"db\"))\n" " (name-service (name \"files\"))\n" " (name-service (name \"ldap\")))))\n" " (name-service-switch\n" " (inherit %mdns-host-lookup-nss)\n" " (password services)\n" " (shadow services)\n" " (group services)\n" " (netgroup services)\n" " (gshadow services)))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:28488 msgid "Available @code{nslcd-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:28489 #, no-wrap msgid "{@code{nslcd-configuration} parameter} package nss-pam-ldapd" msgstr "" #. type: deftypevr #: doc/guix.texi:28491 msgid "The @code{nss-pam-ldapd} package to use." msgstr "" #. type: deftypevr #: doc/guix.texi:28494 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-number threads" msgstr "" #. type: deftypevr #: doc/guix.texi:28498 msgid "" "The number of threads to start that can handle requests and perform LDAP " "queries. Each thread opens a separate connection to the LDAP server. The " "default is to start 5 threads." msgstr "" #. type: deftypevr #: doc/guix.texi:28503 #, no-wrap msgid "{@code{nslcd-configuration} parameter} string uid" msgstr "" #. type: deftypevr #: doc/guix.texi:28505 msgid "This specifies the user id with which the daemon should be run." msgstr "" #. type: deftypevr #: doc/guix.texi:28507 doc/guix.texi:28514 msgid "Defaults to @samp{\"nslcd\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:28510 #, no-wrap msgid "{@code{nslcd-configuration} parameter} string gid" msgstr "" #. type: deftypevr #: doc/guix.texi:28512 msgid "This specifies the group id with which the daemon should be run." msgstr "" #. type: deftypevr #: doc/guix.texi:28517 #, no-wrap msgid "{@code{nslcd-configuration} parameter} log-option log" msgstr "" #. type: deftypevr #: doc/guix.texi:28525 msgid "" "This option controls the way logging is done via a list containing SCHEME " "and LEVEL@. The SCHEME argument may either be the symbols @samp{none} or " "@samp{syslog}, or an absolute file name. The LEVEL argument is optional and " "specifies the log level. The log level may be one of the following symbols: " "@samp{crit}, @samp{error}, @samp{warning}, @samp{notice}, @samp{info} or " "@samp{debug}. All messages with the specified log level or higher are " "logged." msgstr "" #. type: deftypevr #: doc/guix.texi:28527 msgid "Defaults to @samp{(\"/var/log/nslcd\" info)}." msgstr "" #. type: deftypevr #: doc/guix.texi:28530 #, no-wrap msgid "{@code{nslcd-configuration} parameter} list uri" msgstr "" #. type: deftypevr #: doc/guix.texi:28533 msgid "" "The list of LDAP server URIs. Normally, only the first server will be used " "with the following servers as fall-back." msgstr "" #. type: deftypevr #: doc/guix.texi:28535 msgid "Defaults to @samp{(\"ldap://localhost:389/\")}." msgstr "" #. type: deftypevr #: doc/guix.texi:28538 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-string ldap-version" msgstr "" #. type: deftypevr #: doc/guix.texi:28541 msgid "" "The version of the LDAP protocol to use. The default is to use the maximum " "version supported by the LDAP library." msgstr "" #. type: deftypevr #: doc/guix.texi:28546 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-string binddn" msgstr "" #. type: deftypevr #: doc/guix.texi:28549 msgid "" "Specifies the distinguished name with which to bind to the directory server " "for lookups. The default is to bind anonymously." msgstr "" #. type: deftypevr #: doc/guix.texi:28554 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-string bindpw" msgstr "" #. type: deftypevr #: doc/guix.texi:28557 msgid "" "Specifies the credentials with which to bind. This option is only " "applicable when used with binddn." msgstr "" #. type: deftypevr #: doc/guix.texi:28562 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-string rootpwmoddn" msgstr "" #. type: deftypevr #: doc/guix.texi:28565 msgid "" "Specifies the distinguished name to use when the root user tries to modify a " "user's password using the PAM module." msgstr "" #. type: deftypevr #: doc/guix.texi:28570 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-string rootpwmodpw" msgstr "" #. type: deftypevr #: doc/guix.texi:28574 msgid "" "Specifies the credentials with which to bind if the root user tries to " "change a user's password. This option is only applicable when used with " "rootpwmoddn" msgstr "" #. type: deftypevr #: doc/guix.texi:28579 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-string sasl-mech" msgstr "" #. type: deftypevr #: doc/guix.texi:28582 msgid "" "Specifies the SASL mechanism to be used when performing SASL authentication." msgstr "" #. type: deftypevr #: doc/guix.texi:28587 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-string sasl-realm" msgstr "" #. type: deftypevr #: doc/guix.texi:28589 msgid "" "Specifies the SASL realm to be used when performing SASL authentication." msgstr "" #. type: deftypevr #: doc/guix.texi:28594 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-string sasl-authcid" msgstr "" #. type: deftypevr #: doc/guix.texi:28597 msgid "" "Specifies the authentication identity to be used when performing SASL " "authentication." msgstr "" #. type: deftypevr #: doc/guix.texi:28602 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-string sasl-authzid" msgstr "" #. type: deftypevr #: doc/guix.texi:28605 msgid "" "Specifies the authorization identity to be used when performing SASL " "authentication." msgstr "" #. type: deftypevr #: doc/guix.texi:28610 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-boolean sasl-canonicalize?" msgstr "" #. type: deftypevr #: doc/guix.texi:28615 msgid "" "Determines whether the LDAP server host name should be canonicalised. If " "this is enabled the LDAP library will do a reverse host name lookup. By " "default, it is left up to the LDAP library whether this check is performed " "or not." msgstr "" #. type: deftypevr #: doc/guix.texi:28620 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-string krb5-ccname" msgstr "" #. type: deftypevr #: doc/guix.texi:28622 msgid "Set the name for the GSS-API Kerberos credentials cache." msgstr "" #. type: deftypevr #: doc/guix.texi:28627 #, no-wrap msgid "{@code{nslcd-configuration} parameter} string base" msgstr "" #. type: deftypevr #: doc/guix.texi:28629 msgid "The directory search base." msgstr "" #. type: deftypevr #: doc/guix.texi:28631 msgid "Defaults to @samp{\"dc=example,dc=com\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:28634 #, no-wrap msgid "{@code{nslcd-configuration} parameter} scope-option scope" msgstr "" #. type: deftypevr #: doc/guix.texi:28638 msgid "" "Specifies the search scope (subtree, onelevel, base or children). The " "default scope is subtree; base scope is almost never useful for name service " "lookups; children scope is not supported on all servers." msgstr "" #. type: deftypevr #: doc/guix.texi:28640 msgid "Defaults to @samp{(subtree)}." msgstr "" #. type: deftypevr #: doc/guix.texi:28643 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-deref-option deref" msgstr "" #. type: deftypevr #: doc/guix.texi:28646 msgid "" "Specifies the policy for dereferencing aliases. The default policy is to " "never dereference aliases." msgstr "" #. type: deftypevr #: doc/guix.texi:28651 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-boolean referrals" msgstr "" #. type: deftypevr #: doc/guix.texi:28654 msgid "" "Specifies whether automatic referral chasing should be enabled. The default " "behaviour is to chase referrals." msgstr "" #. type: deftypevr #: doc/guix.texi:28659 #, no-wrap msgid "{@code{nslcd-configuration} parameter} list-of-map-entries maps" msgstr "" #. type: deftypevr #: doc/guix.texi:28664 msgid "" "This option allows for custom attributes to be looked up instead of the " "default RFC 2307 attributes. It is a list of maps, each consisting of the " "name of a map, the RFC 2307 attribute to match and the query expression for " "the attribute as it is available in the directory." msgstr "" #. type: deftypevr #: doc/guix.texi:28669 #, no-wrap msgid "{@code{nslcd-configuration} parameter} list-of-filter-entries filters" msgstr "" #. type: deftypevr #: doc/guix.texi:28672 msgid "" "A list of filters consisting of the name of a map to which the filter " "applies and an LDAP search filter expression." msgstr "" #. type: deftypevr #: doc/guix.texi:28677 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-number bind-timelimit" msgstr "" #. type: deftypevr #: doc/guix.texi:28680 msgid "" "Specifies the time limit in seconds to use when connecting to the directory " "server. The default value is 10 seconds." msgstr "" #. type: deftypevr #: doc/guix.texi:28685 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-number timelimit" msgstr "" #. type: deftypevr #: doc/guix.texi:28689 msgid "" "Specifies the time limit (in seconds) to wait for a response from the LDAP " "server. A value of zero, which is the default, is to wait indefinitely for " "searches to be completed." msgstr "" #. type: deftypevr #: doc/guix.texi:28694 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-number idle-timelimit" msgstr "" #. type: deftypevr #: doc/guix.texi:28698 msgid "" "Specifies the period if inactivity (in seconds) after which the con‐ nection " "to the LDAP server will be closed. The default is not to time out " "connections." msgstr "" #. type: deftypevr #: doc/guix.texi:28703 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-number reconnect-sleeptime" msgstr "" #. type: deftypevr #: doc/guix.texi:28707 msgid "" "Specifies the number of seconds to sleep when connecting to all LDAP servers " "fails. By default one second is waited between the first failure and the " "first retry." msgstr "" #. type: deftypevr #: doc/guix.texi:28712 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-number reconnect-retrytime" msgstr "" #. type: deftypevr #: doc/guix.texi:28716 msgid "" "Specifies the time after which the LDAP server is considered to be " "permanently unavailable. Once this time is reached retries will be done " "only once per this time period. The default value is 10 seconds." msgstr "" #. type: deftypevr #: doc/guix.texi:28721 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-ssl-option ssl" msgstr "" #. type: deftypevr #: doc/guix.texi:28725 msgid "" "Specifies whether to use SSL/TLS or not (the default is not to). If 'start-" "tls is specified then StartTLS is used rather than raw LDAP over SSL." msgstr "" #. type: deftypevr #: doc/guix.texi:28730 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-tls-reqcert-option tls-reqcert" msgstr "" #. type: deftypevr #: doc/guix.texi:28733 msgid "" "Specifies what checks to perform on a server-supplied certificate. The " "meaning of the values is described in the ldap.conf(5) manual page." msgstr "" #. type: deftypevr #: doc/guix.texi:28738 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-string tls-cacertdir" msgstr "" #. type: deftypevr #: doc/guix.texi:28741 msgid "" "Specifies the directory containing X.509 certificates for peer authen‐ " "tication. This parameter is ignored when using GnuTLS." msgstr "" #. type: deftypevr #: doc/guix.texi:28746 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-string tls-cacertfile" msgstr "" #. type: deftypevr #: doc/guix.texi:28748 msgid "Specifies the path to the X.509 certificate for peer authentication." msgstr "" #. type: deftypevr #: doc/guix.texi:28753 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-string tls-randfile" msgstr "" #. type: deftypevr #: doc/guix.texi:28756 msgid "" "Specifies the path to an entropy source. This parameter is ignored when " "using GnuTLS." msgstr "" #. type: deftypevr #: doc/guix.texi:28761 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-string tls-ciphers" msgstr "" #. type: deftypevr #: doc/guix.texi:28763 msgid "Specifies the ciphers to use for TLS as a string." msgstr "" #. type: deftypevr #: doc/guix.texi:28768 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-string tls-cert" msgstr "" #. type: deftypevr #: doc/guix.texi:28771 msgid "" "Specifies the path to the file containing the local certificate for client " "TLS authentication." msgstr "" #. type: deftypevr #: doc/guix.texi:28776 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-string tls-key" msgstr "" #. type: deftypevr #: doc/guix.texi:28779 msgid "" "Specifies the path to the file containing the private key for client TLS " "authentication." msgstr "" #. type: deftypevr #: doc/guix.texi:28784 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-number pagesize" msgstr "" #. type: deftypevr #: doc/guix.texi:28788 msgid "" "Set this to a number greater than 0 to request paged results from the LDAP " "server in accordance with RFC2696. The default (0) is to not request paged " "results." msgstr "" #. type: deftypevr #: doc/guix.texi:28793 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-ignore-users-option nss-initgroups-ignoreusers" msgstr "" #. type: deftypevr #: doc/guix.texi:28797 msgid "" "This option prevents group membership lookups through LDAP for the specified " "users. Alternatively, the value 'all-local may be used. With that value " "nslcd builds a full list of non-LDAP users on startup." msgstr "" #. type: deftypevr #: doc/guix.texi:28802 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-number nss-min-uid" msgstr "" #. type: deftypevr #: doc/guix.texi:28805 msgid "" "This option ensures that LDAP users with a numeric user id lower than the " "specified value are ignored." msgstr "" #. type: deftypevr #: doc/guix.texi:28810 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-number nss-uid-offset" msgstr "" #. type: deftypevr #: doc/guix.texi:28813 msgid "" "This option specifies an offset that is added to all LDAP numeric user ids. " "This can be used to avoid user id collisions with local users." msgstr "" #. type: deftypevr #: doc/guix.texi:28818 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-number nss-gid-offset" msgstr "" #. type: deftypevr #: doc/guix.texi:28821 msgid "" "This option specifies an offset that is added to all LDAP numeric group " "ids. This can be used to avoid user id collisions with local groups." msgstr "" #. type: deftypevr #: doc/guix.texi:28826 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-boolean nss-nested-groups" msgstr "" #. type: deftypevr #: doc/guix.texi:28832 msgid "" "If this option is set, the member attribute of a group may point to another " "group. Members of nested groups are also returned in the higher level group " "and parent groups are returned when finding groups for a specific user. The " "default is not to perform extra searches for nested groups." msgstr "" #. type: deftypevr #: doc/guix.texi:28837 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-boolean nss-getgrent-skipmembers" msgstr "" #. type: deftypevr #: doc/guix.texi:28842 msgid "" "If this option is set, the group member list is not retrieved when looking " "up groups. Lookups for finding which groups a user belongs to will remain " "functional so the user will likely still get the correct groups assigned on " "login." msgstr "" #. type: deftypevr #: doc/guix.texi:28847 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-boolean nss-disable-enumeration" msgstr "" #. type: deftypevr #: doc/guix.texi:28853 msgid "" "If this option is set, functions which cause all user/group entries to be " "loaded from the directory will not succeed in doing so. This can " "dramatically reduce LDAP server load in situations where there are a great " "number of users and/or groups. This option is not recommended for most " "configurations." msgstr "" #. type: deftypevr #: doc/guix.texi:28858 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-string validnames" msgstr "" #. type: deftypevr #: doc/guix.texi:28862 msgid "" "This option can be used to specify how user and group names are verified " "within the system. This pattern is used to check all user and group names " "that are requested and returned from LDAP." msgstr "" #. type: deftypevr #: doc/guix.texi:28867 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-boolean ignorecase" msgstr "" #. type: deftypevr #: doc/guix.texi:28872 msgid "" "This specifies whether or not to perform searches using case-insensitive " "matching. Enabling this could open up the system to authorization bypass " "vulnerabilities and introduce nscd cache poisoning vulnerabilities which " "allow denial of service." msgstr "" #. type: deftypevr #: doc/guix.texi:28877 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-boolean pam-authc-ppolicy" msgstr "" #. type: deftypevr #: doc/guix.texi:28880 msgid "" "This option specifies whether password policy controls are requested and " "handled from the LDAP server when performing user authentication." msgstr "" #. type: deftypevr #: doc/guix.texi:28885 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-string pam-authc-search" msgstr "" #. type: deftypevr #: doc/guix.texi:28891 msgid "" "By default nslcd performs an LDAP search with the user's credentials after " "BIND (authentication) to ensure that the BIND operation was successful. The " "default search is a simple check to see if the user's DN exists. A search " "filter can be specified that will be used instead. It should return at " "least one entry." msgstr "" #. type: deftypevr #: doc/guix.texi:28896 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-string pam-authz-search" msgstr "" #. type: deftypevr #: doc/guix.texi:28900 msgid "" "This option allows flexible fine tuning of the authorisation check that " "should be performed. The search filter specified is executed and if any " "entries match, access is granted, otherwise access is denied." msgstr "" #. type: deftypevr #: doc/guix.texi:28905 #, no-wrap msgid "{@code{nslcd-configuration} parameter} maybe-string pam-password-prohibit-message" msgstr "" #. type: deftypevr #: doc/guix.texi:28910 msgid "" "If this option is set password modification using pam_ldap will be denied " "and the specified message will be presented to the user instead. The " "message can be used to direct the user to an alternative means of changing " "their password." msgstr "" #. type: deftypevr #: doc/guix.texi:28915 #, no-wrap msgid "{@code{nslcd-configuration} parameter} list pam-services" msgstr "" #. type: deftypevr #: doc/guix.texi:28917 msgid "List of pam service names for which LDAP authentication should suffice." msgstr "" #. type: cindex #: doc/guix.texi:28928 #, no-wrap msgid "web" msgstr "" #. type: cindex #: doc/guix.texi:28929 #, no-wrap msgid "www" msgstr "" #. type: cindex #: doc/guix.texi:28930 #, no-wrap msgid "HTTP" msgstr "" #. type: Plain text #: doc/guix.texi:28933 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:28934 #, no-wrap msgid "Apache HTTP Server" msgstr "" #. type: deffn #: doc/guix.texi:28936 #, no-wrap msgid "{Scheme Variable} httpd-service-type" msgstr "" #. type: deffn #: doc/guix.texi:28940 msgid "" "Service type for the @uref{https://httpd.apache.org/,Apache HTTP} server " "(@dfn{httpd}). The value for this service type is a @code{httpd-" "configuration} record." msgstr "" #. type: deffn #: doc/guix.texi:28942 doc/guix.texi:29124 msgid "A simple example configuration is given below." msgstr "" #. type: lisp #: doc/guix.texi:28950 #, 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:28954 msgid "" "Other services can also extend the @code{httpd-service-type} to add to the " "configuration." msgstr "" #. type: lisp #: doc/guix.texi:28963 doc/guix.texi:29103 #, no-wrap msgid "" "(simple-service 'www.example.com-server httpd-service-type\n" " (list\n" " (httpd-virtualhost\n" " \"*:80\"\n" " (list (string-join '(\"ServerName www.example.com\"\n" " \"DocumentRoot /srv/http/www.example.com\")\n" " \"\\n\")))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:28969 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:28970 #, no-wrap msgid "{Data Type} httpd-configuration" msgstr "" #. type: deffn #: doc/guix.texi:28972 msgid "This data type represents the configuration for the httpd service." msgstr "" #. type: item #: doc/guix.texi:28974 #, no-wrap msgid "@code{package} (default: @code{httpd})" msgstr "" #. type: table #: doc/guix.texi:28976 msgid "The httpd package to use." msgstr "" #. type: item #: doc/guix.texi:28977 doc/guix.texi:29066 #, no-wrap msgid "@code{pid-file} (default: @code{\"/var/run/httpd\"})" msgstr "" #. type: table #: doc/guix.texi:28979 msgid "The pid file used by the shepherd-service." msgstr "" #. type: item #: doc/guix.texi:28980 #, no-wrap msgid "@code{config} (default: @code{(httpd-config-file)})" msgstr "" #. type: table #: doc/guix.texi:28985 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:28989 #, no-wrap msgid "{Data Type} httpd-module" msgstr "" #. type: deffn #: doc/guix.texi:28991 msgid "This data type represents a module for the httpd service." msgstr "" #. type: table #: doc/guix.texi:28995 msgid "The name of the module." msgstr "" #. type: table #: doc/guix.texi:29001 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: defvr #: doc/guix.texi:29005 #, no-wrap msgid "{Scheme Variable} %default-httpd-modules" msgstr "" #. type: defvr #: doc/guix.texi:29007 msgid "A default list of @code{httpd-module} objects." msgstr "" #. type: deffn #: doc/guix.texi:29009 #, no-wrap msgid "{Data Type} httpd-config-file" msgstr "" #. type: deffn #: doc/guix.texi:29011 msgid "This data type represents a configuration file for the httpd service." msgstr "" #. type: item #: doc/guix.texi:29013 #, no-wrap msgid "@code{modules} (default: @code{%default-httpd-modules})" msgstr "" #. type: table #: doc/guix.texi:29016 msgid "" "The modules to load. Additional modules can be added here, or loaded by " "additional configuration." msgstr "" #. type: table #: doc/guix.texi:29019 msgid "" "For example, in order to handle requests for PHP files, you can use Apache’s " "@code{mod_proxy_fcgi} module along with @code{php-fpm-service-type}:" msgstr "" #. type: lisp #: doc/guix.texi:29041 #, no-wrap msgid "" "(service httpd-service-type\n" " (httpd-configuration\n" " (config\n" " (httpd-config-file\n" " (modules (cons*\n" " (httpd-module\n" " (name \"proxy_module\")\n" " (file \"modules/mod_proxy.so\"))\n" " (httpd-module\n" " (name \"proxy_fcgi_module\")\n" " (file \"modules/mod_proxy_fcgi.so\"))\n" " %default-httpd-modules))\n" " (extra-config (list \"\\\n" "\n" " SetHandler \\\"proxy:unix:/var/run/php-fpm.sock|fcgi://localhost/\\\"\n" "\"))))))\n" "(service php-fpm-service-type\n" " (php-fpm-configuration\n" " (socket \"/var/run/php-fpm.sock\")\n" " (socket-group \"httpd\")))\n" msgstr "" #. type: item #: doc/guix.texi:29043 #, no-wrap msgid "@code{server-root} (default: @code{httpd})" msgstr "" #. type: table #: doc/guix.texi:29047 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:29048 #, no-wrap msgid "@code{server-name} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:29052 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:29056 msgid "" "This doesn't need to be set in the server config, and can be specified in " "virtual hosts. The default is @code{#f} to not specify a @code{ServerName}." msgstr "" #. type: item #: doc/guix.texi:29057 #, no-wrap msgid "@code{document-root} (default: @code{\"/srv/http\"})" msgstr "" #. type: table #: doc/guix.texi:29059 msgid "The @code{DocumentRoot} from which files will be served." msgstr "" #. type: item #: doc/guix.texi:29060 #, no-wrap msgid "@code{listen} (default: @code{'(\"80\")})" msgstr "" #. type: table #: doc/guix.texi:29065 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:29070 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:29071 #, no-wrap msgid "@code{error-log} (default: @code{\"/var/log/httpd/error_log\"})" msgstr "" #. type: table #: doc/guix.texi:29073 msgid "The @code{ErrorLog} to which the server will log errors." msgstr "" #. type: item #: doc/guix.texi:29074 doc/guix.texi:29648 #, no-wrap msgid "@code{user} (default: @code{\"httpd\"})" msgstr "" #. type: table #: doc/guix.texi:29076 msgid "The @code{User} which the server will answer requests as." msgstr "" #. type: item #: doc/guix.texi:29077 #, no-wrap msgid "@code{group} (default: @code{\"httpd\"})" msgstr "" #. type: table #: doc/guix.texi:29079 msgid "The @code{Group} which the server will answer requests as." msgstr "" #. type: item #: doc/guix.texi:29080 #, no-wrap msgid "@code{extra-config} (default: @code{(list \"TypesConfig etc/httpd/mime.types\")})" msgstr "" #. type: table #: doc/guix.texi:29083 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:29086 msgid "" "Any values which the service is extended with will be appended to this list." msgstr "" #. type: deffn #: doc/guix.texi:29090 #, no-wrap msgid "{Data Type} httpd-virtualhost" msgstr "" #. type: deffn #: doc/guix.texi:29092 msgid "" "This data type represents a virtualhost configuration block for the httpd " "service." msgstr "" #. type: deffn #: doc/guix.texi:29094 msgid "These should be added to the extra-config for the httpd-service." msgstr "" #. type: code{#1} #: doc/guix.texi:29106 #, no-wrap msgid "addresses-and-ports" msgstr "" #. type: table #: doc/guix.texi:29108 msgid "The addresses and ports for the @code{VirtualHost} directive." msgstr "" #. type: code{#1} #: doc/guix.texi:29109 #, no-wrap msgid "contents" msgstr "" #. type: table #: doc/guix.texi:29112 msgid "" "The contents of the @code{VirtualHost} directive, this should be a list of " "strings and G-expressions." msgstr "" #. type: subsubheading #: doc/guix.texi:29117 #, no-wrap msgid "NGINX" msgstr "" #. type: deffn #: doc/guix.texi:29119 #, no-wrap msgid "{Scheme Variable} nginx-service-type" msgstr "" #. type: deffn #: doc/guix.texi:29122 msgid "" "Service type for the @uref{https://nginx.org/,NGinx} web server. The value " "for this service type is a @code{} record." msgstr "" #. type: lisp #: doc/guix.texi:29132 doc/guix.texi:29194 #, 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:29137 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: lisp #: doc/guix.texi:29143 #, 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:29154 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:29155 #, no-wrap msgid "{Data Type} nginx-configuration" msgstr "" #. type: deffn #: doc/guix.texi:29159 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:29161 #, no-wrap msgid "@code{nginx} (default: @code{nginx})" msgstr "" #. type: table #: doc/guix.texi:29163 msgid "The nginx package to use." msgstr "" #. type: table #: doc/guix.texi:29167 msgid "" "This is a list of symbols naming Shepherd services the nginx service will " "depend on." msgstr "" #. type: table #: doc/guix.texi:29171 msgid "" "This is useful if you would like @command{nginx} to be started after a back-" "end web server or a logging service such as Anonip has been started." msgstr "" #. type: item #: doc/guix.texi:29172 #, no-wrap msgid "@code{log-directory} (default: @code{\"/var/log/nginx\"})" msgstr "" #. type: table #: doc/guix.texi:29174 msgid "The directory to which NGinx will write log files." msgstr "" #. type: item #: doc/guix.texi:29175 #, no-wrap msgid "@code{run-directory} (default: @code{\"/var/run/nginx\"})" msgstr "" #. type: table #: doc/guix.texi:29178 msgid "" "The directory in which NGinx will create a pid file, and write temporary " "files." msgstr "" #. type: item #: doc/guix.texi:29179 #, no-wrap msgid "@code{server-blocks} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:29183 msgid "" "A list of @dfn{server blocks} to create in the generated configuration file, " "the elements should be of type @code{}." msgstr "" #. type: table #: doc/guix.texi:29187 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:29196 #, no-wrap msgid "@code{upstream-blocks} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:29200 msgid "" "A list of @dfn{upstream blocks} to create in the generated configuration " "file, the elements should be of type @code{}." msgstr "" #. type: table #: doc/guix.texi:29207 msgid "" "Configuring upstreams through the @code{upstream-blocks} can be useful when " "combined with @code{locations} in the @code{} " "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: lisp #: doc/guix.texi:29226 #, 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:29234 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:29238 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:29239 #, no-wrap msgid "@code{server-names-hash-bucket-size} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:29242 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:29243 #, no-wrap msgid "@code{server-names-hash-bucket-max-size} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:29245 msgid "Maximum bucket size for the server names hash tables." msgstr "" #. type: table #: doc/guix.texi:29249 msgid "" "List of nginx dynamic modules to load. This should be a list of file names " "of loadable modules, as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:29257 #, no-wrap msgid "" "(modules\n" " (list\n" " (file-append nginx-accept-language-module \"\\\n" "/etc/nginx/modules/ngx_http_accept_language_module.so\")\n" " (file-append nginx-lua-module \"\\\n" "/etc/nginx/modules/ngx_http_lua_module.so\")))\n" msgstr "" #. type: item #: doc/guix.texi:29259 #, no-wrap msgid "@code{lua-package-path} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:29262 msgid "" "List of nginx lua packages to load. This should be a list of package names " "of loadable lua modules, as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:29269 #, no-wrap msgid "" "(lua-package-path (list lua-resty-core\n" " lua-resty-lrucache\n" " lua-resty-signal\n" " lua-tablepool\n" " lua-resty-shell))\n" msgstr "" #. type: item #: doc/guix.texi:29271 #, no-wrap msgid "@code{lua-package-cpath} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:29274 msgid "" "List of nginx lua C packages to load. This should be a list of package " "names of loadable lua C modules, as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:29277 #, no-wrap msgid "(lua-package-cpath (list lua-resty-signal))\n" msgstr "" #. type: item #: doc/guix.texi:29279 #, no-wrap msgid "@code{global-directives} (default: @code{'((events . ()))})" msgstr "" #. type: table #: doc/guix.texi:29282 msgid "" "Association list of global directives for the top level of the nginx " "configuration. Values may themselves be association lists." msgstr "" #. type: lisp #: doc/guix.texi:29288 #, no-wrap msgid "" "(global-directives\n" " `((worker_processes . 16)\n" " (pcre_jit . on)\n" " (events . ((worker_connections . 1024)))))\n" msgstr "" #. type: table #: doc/guix.texi:29293 msgid "" "Extra content for the @code{http} block. Should be string or a string " "valued G-expression." msgstr "" #. type: anchor{#1} #: doc/guix.texi:29298 msgid "nginx-server-configuration" msgstr "" #. type: deftp #: doc/guix.texi:29298 #, no-wrap msgid "{Data Type} nginx-server-configuration" msgstr "" #. type: deftp #: doc/guix.texi:29301 msgid "" "Data type representing the configuration of an nginx server block. This " "type has the following parameters:" msgstr "" #. type: item #: doc/guix.texi:29303 #, no-wrap msgid "@code{listen} (default: @code{'(\"80\" \"443 ssl\")})" msgstr "" #. type: table #: doc/guix.texi:29308 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: lisp #: doc/guix.texi:29311 #, no-wrap msgid "'(\"127.0.0.1:8000\" \"127.0.0.1\" \"8000\" \"*:8000\" \"localhost:8000\")\n" msgstr "" #. type: item #: doc/guix.texi:29313 #, no-wrap msgid "@code{server-name} (default: @code{(list 'default)})" msgstr "" #. type: table #: doc/guix.texi:29316 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:29317 #, no-wrap msgid "@code{root} (default: @code{\"/srv/http\"})" msgstr "" #. type: table #: doc/guix.texi:29319 msgid "Root of the website nginx will serve." msgstr "" #. type: item #: doc/guix.texi:29320 #, no-wrap msgid "@code{locations} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:29324 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:29325 #, no-wrap msgid "@code{index} (default: @code{(list \"index.html\")})" msgstr "" #. type: table #: doc/guix.texi:29328 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:29329 #, no-wrap msgid "@code{try-files} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:29332 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:29333 #, no-wrap msgid "@code{ssl-certificate} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:29336 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:29337 #, no-wrap msgid "@code{ssl-certificate-key} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:29340 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:29341 #, no-wrap msgid "@code{server-tokens?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:29343 msgid "Whether the server should add its configuration to response." msgstr "" #. type: item #: doc/guix.texi:29344 #, no-wrap msgid "@code{raw-content} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:29346 msgid "A list of raw lines added to the server block." msgstr "" #. type: deftp #: doc/guix.texi:29350 #, no-wrap msgid "{Data Type} nginx-upstream-configuration" msgstr "" #. type: deftp #: doc/guix.texi:29353 msgid "" "Data type representing the configuration of an nginx @code{upstream} block. " "This type has the following parameters:" msgstr "" #. type: table #: doc/guix.texi:29357 msgid "Name for this group of servers." msgstr "" #. type: code{#1} #: doc/guix.texi:29358 #, no-wrap msgid "servers" msgstr "" #. type: table #: doc/guix.texi:29365 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: code{#1} #: doc/guix.texi:29366 #, no-wrap msgid "extra-content" msgstr "" #. type: table #: doc/guix.texi:29368 msgid "A string or list of strings to add to the upstream block." msgstr "" #. type: deftp #: doc/guix.texi:29372 #, no-wrap msgid "{Data Type} nginx-location-configuration" msgstr "" #. type: deftp #: doc/guix.texi:29375 msgid "" "Data type representing the configuration of an nginx @code{location} block. " "This type has the following parameters:" msgstr "" #. type: table #: doc/guix.texi:29379 msgid "URI which this location block matches." msgstr "" #. type: anchor{#1} #: doc/guix.texi:29381 msgid "nginx-location-configuration body" msgstr "" #. type: code{#1} #: doc/guix.texi:29381 doc/guix.texi:29402 #, no-wrap msgid "body" msgstr "" #. type: table #: doc/guix.texi:29388 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:29392 #, no-wrap msgid "{Data Type} nginx-named-location-configuration" msgstr "" #. type: deftp #: doc/guix.texi:29397 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:29401 msgid "Name to identify this location block." msgstr "" #. type: table #: doc/guix.texi:29407 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: subsubheading #: doc/guix.texi:29411 #, no-wrap msgid "Varnish Cache" msgstr "" #. type: cindex #: doc/guix.texi:29412 #, no-wrap msgid "Varnish" msgstr "" #. type: Plain text #: doc/guix.texi:29417 msgid "" "Varnish is a fast cache server that sits in between web applications and end " "users. It proxies requests from clients and caches the accessed URLs such " "that multiple requests for the same resource only creates one request to the " "back-end." msgstr "" #. type: defvr #: doc/guix.texi:29418 #, no-wrap msgid "{Scheme Variable} varnish-service-type" msgstr "" #. type: defvr #: doc/guix.texi:29420 msgid "Service type for the Varnish daemon." msgstr "" #. type: deftp #: doc/guix.texi:29422 #, no-wrap msgid "{Data Type} varnish-configuration" msgstr "" #. type: deftp #: doc/guix.texi:29425 msgid "" "Data type representing the @code{varnish} service configuration. This type " "has the following parameters:" msgstr "" #. type: item #: doc/guix.texi:29427 #, no-wrap msgid "@code{package} (default: @code{varnish})" msgstr "" #. type: table #: doc/guix.texi:29429 msgid "The Varnish package to use." msgstr "" #. type: item #: doc/guix.texi:29430 #, no-wrap msgid "@code{name} (default: @code{\"default\"})" msgstr "" #. type: table #: doc/guix.texi:29435 msgid "" "A name for this Varnish instance. Varnish will create a directory in @file{/" "var/varnish/} with this name and keep temporary files there. If the name " "starts with a forward slash, it is interpreted as an absolute directory name." msgstr "" #. type: table #: doc/guix.texi:29438 msgid "" "Pass the @code{-n} argument to other Varnish programs to connect to the " "named instance, e.g.@: @command{varnishncsa -n default}." msgstr "" #. type: item #: doc/guix.texi:29439 #, no-wrap msgid "@code{backend} (default: @code{\"localhost:8080\"})" msgstr "" #. type: table #: doc/guix.texi:29441 msgid "The backend to use. This option has no effect if @code{vcl} is set." msgstr "" #. type: item #: doc/guix.texi:29442 #, no-wrap msgid "@code{vcl} (default: #f)" msgstr "" #. type: table #: doc/guix.texi:29447 msgid "" "The @dfn{VCL} (Varnish Configuration Language) program to run. If this is " "@code{#f}, Varnish will proxy @code{backend} using the default " "configuration. Otherwise this must be a file-like object with valid VCL " "syntax." msgstr "" #. type: table #: doc/guix.texi:29451 msgid "" "For example, to mirror @url{https://www.gnu.org,www.gnu.org} with VCL you " "can do something along these lines:" msgstr "" #. type: lisp #: doc/guix.texi:29457 #, no-wrap msgid "" "(define %gnu-mirror\n" " (plain-file \"gnu.vcl\"\n" " \"vcl 4.1;\n" "backend gnu @{ .host = \\\"www.gnu.org\\\"; @}\"))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:29465 #, no-wrap msgid "" "(operating-system\n" " ;; @dots{}\n" " (services (cons (service varnish-service-type\n" " (varnish-configuration\n" " (listen '(\":80\"))\n" " (vcl %gnu-mirror)))\n" " %base-services)))\n" msgstr "" #. type: table #: doc/guix.texi:29469 msgid "" "The configuration of an already running Varnish instance can be inspected " "and changed using the @command{varnishadm} program." msgstr "" #. type: table #: doc/guix.texi:29473 msgid "" "Consult the @url{https://varnish-cache.org/docs/,Varnish User Guide} and " "@url{https://book.varnish-software.com/4.0/,Varnish Book} for comprehensive " "documentation on Varnish and its configuration language." msgstr "" #. type: item #: doc/guix.texi:29474 #, no-wrap msgid "@code{listen} (default: @code{'(\"localhost:80\")})" msgstr "" #. type: table #: doc/guix.texi:29476 msgid "List of addresses Varnish will listen on." msgstr "" #. type: item #: doc/guix.texi:29477 #, no-wrap msgid "@code{storage} (default: @code{'(\"malloc,128m\")})" msgstr "" #. type: table #: doc/guix.texi:29479 msgid "List of storage backends that will be available in VCL." msgstr "" #. type: item #: doc/guix.texi:29480 #, no-wrap msgid "@code{parameters} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:29482 msgid "" "List of run-time parameters in the form @code{'((\"parameter\" . \"value" "\"))}." msgstr "" #. type: table #: doc/guix.texi:29485 msgid "Additional arguments to pass to the @command{varnishd} process." msgstr "" #. type: cindex #: doc/guix.texi:29489 doc/guix.texi:29490 #, no-wrap msgid "Patchwork" msgstr "" #. type: Plain text #: doc/guix.texi:29493 msgid "" "Patchwork is a patch tracking system. It can collect patches sent to a " "mailing list, and display them in a web interface." msgstr "" #. type: defvr #: doc/guix.texi:29494 #, no-wrap msgid "{Scheme Variable} patchwork-service-type" msgstr "" #. type: defvr #: doc/guix.texi:29496 msgid "Service type for Patchwork." msgstr "" #. type: Plain text #: doc/guix.texi:29500 msgid "" "The following example is an example of a minimal service for Patchwork, for " "the @code{patchwork.example.com} domain." msgstr "" #. type: lisp #: doc/guix.texi:29520 #, no-wrap msgid "" "(service patchwork-service-type\n" " (patchwork-configuration\n" " (domain \"patchwork.example.com\")\n" " (settings-module\n" " (patchwork-settings-module\n" " (allowed-hosts (list domain))\n" " (default-from-email \"patchwork@@patchwork.example.com\")))\n" " (getmail-retriever-config\n" " (getmail-retriever-configuration\n" " (type \"SimpleIMAPSSLRetriever\")\n" " (server \"imap.example.com\")\n" " (port 993)\n" " (username \"patchwork\")\n" " (password-command\n" " (list (file-append coreutils \"/bin/cat\")\n" " \"/etc/getmail-patchwork-imap-password\"))\n" " (extra-parameters\n" " '((mailboxes . (\"Patches\"))))))))\n" "\n" msgstr "" #. type: Plain text #: doc/guix.texi:29526 msgid "" "There are three records for configuring the Patchwork service. The " "@code{} relates to the configuration for Patchwork " "within the HTTPD service." msgstr "" #. type: Plain text #: doc/guix.texi:29530 msgid "" "The @code{settings-module} field within the @code{} " "record can be populated with the @code{} record, " "which describes a settings module that is generated within the Guix store." msgstr "" #. type: Plain text #: doc/guix.texi:29534 msgid "" "For the @code{database-configuration} field within the @code{}, the @code{} must be " "used." msgstr "" #. type: deftp #: doc/guix.texi:29535 #, no-wrap msgid "{Data Type} patchwork-configuration" msgstr "" #. type: deftp #: doc/guix.texi:29538 msgid "" "Data type representing the Patchwork service configuration. This type has " "the following parameters:" msgstr "" #. type: item #: doc/guix.texi:29540 #, no-wrap msgid "@code{patchwork} (default: @code{patchwork})" msgstr "" #. type: table #: doc/guix.texi:29542 msgid "The Patchwork package to use." msgstr "" #. type: code{#1} #: doc/guix.texi:29543 #, no-wrap msgid "domain" msgstr "" #. type: table #: doc/guix.texi:29546 msgid "" "The domain to use for Patchwork, this is used in the HTTPD service virtual " "host." msgstr "" #. type: code{#1} #: doc/guix.texi:29547 #, no-wrap msgid "settings-module" msgstr "" #. type: table #: doc/guix.texi:29553 msgid "" "The settings module to use for Patchwork. As a Django application, " "Patchwork is configured with a Python module containing the settings. This " "can either be an instance of the @code{} record, " "any other record that represents the settings in the store, or a directory " "outside of the store." msgstr "" #. type: item #: doc/guix.texi:29554 #, no-wrap msgid "@code{static-path} (default: @code{\"/static/\"})" msgstr "" #. type: table #: doc/guix.texi:29556 msgid "The path under which the HTTPD service should serve the static files." msgstr "" #. type: code{#1} #: doc/guix.texi:29557 #, no-wrap msgid "getmail-retriever-config" msgstr "" #. type: table #: doc/guix.texi:29561 msgid "" "The getmail-retriever-configuration record value to use with Patchwork. " "Getmail will be configured with this value, the messages will be delivered " "to Patchwork." msgstr "" #. type: deftp #: doc/guix.texi:29565 #, no-wrap msgid "{Data Type} patchwork-settings-module" msgstr "" #. type: deftp #: doc/guix.texi:29570 msgid "" "Data type representing a settings module for Patchwork. Some of these " "settings relate directly to Patchwork, but others relate to Django, the web " "framework used by Patchwork, or the Django Rest Framework library. This " "type has the following parameters:" msgstr "" #. type: item #: doc/guix.texi:29572 #, no-wrap msgid "@code{database-configuration} (default: @code{(patchwork-database-configuration)})" msgstr "" #. type: table #: doc/guix.texi:29575 msgid "" "The database connection settings used for Patchwork. See the " "@code{} record type for more information." msgstr "" #. type: item #: doc/guix.texi:29576 #, no-wrap msgid "@code{secret-key-file} (default: @code{\"/etc/patchwork/django-secret-key\"})" msgstr "" #. type: table #: doc/guix.texi:29579 msgid "" "Patchwork, as a Django web application uses a secret key for " "cryptographically signing values. This file should contain a unique " "unpredictable value." msgstr "" #. type: table #: doc/guix.texi:29582 msgid "" "If this file does not exist, it will be created and populated with a random " "value by the patchwork-setup shepherd service." msgstr "" #. type: table #: doc/guix.texi:29584 msgid "This setting relates to Django." msgstr "" #. type: code{#1} #: doc/guix.texi:29585 #, no-wrap msgid "allowed-hosts" msgstr "" #. type: table #: doc/guix.texi:29588 msgid "" "A list of valid hosts for this Patchwork service. This should at least " "include the domain specified in the @code{} record." msgstr "" #. type: table #: doc/guix.texi:29590 doc/guix.texi:29604 doc/guix.texi:29610 #: doc/guix.texi:29616 msgid "This is a Django setting." msgstr "" #. type: code{#1} #: doc/guix.texi:29591 #, no-wrap msgid "default-from-email" msgstr "" #. type: table #: doc/guix.texi:29593 msgid "The email address from which Patchwork should send email by default." msgstr "" #. type: table #: doc/guix.texi:29595 doc/guix.texi:29621 doc/guix.texi:29626 #: doc/guix.texi:29631 msgid "This is a Patchwork setting." msgstr "" #. type: item #: doc/guix.texi:29596 #, no-wrap msgid "@code{static-url} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:29599 msgid "" "The URL to use when serving static assets. It can be part of a URL, or a " "full URL, but must end in a @code{/}." msgstr "" #. type: table #: doc/guix.texi:29602 msgid "" "If the default value is used, the @code{static-path} value from the " "@code{} record will be used." msgstr "" #. type: item #: doc/guix.texi:29605 #, no-wrap msgid "@code{admins} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:29608 msgid "" "Email addresses to send the details of errors that occur. Each value should " "be a list containing two elements, the name and then the email address." msgstr "" #. type: table #: doc/guix.texi:29614 msgid "" "Whether to run Patchwork in debug mode. If set to @code{#t}, detailed error " "messages will be shown." msgstr "" #. type: item #: doc/guix.texi:29617 #, no-wrap msgid "@code{enable-rest-api?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:29619 msgid "Whether to enable the Patchwork REST API." msgstr "" #. type: item #: doc/guix.texi:29622 #, no-wrap msgid "@code{enable-xmlrpc?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:29624 msgid "Whether to enable the XML RPC API." msgstr "" #. type: item #: doc/guix.texi:29627 #, no-wrap msgid "@code{force-https-links?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:29629 msgid "Whether to use HTTPS links on Patchwork pages." msgstr "" #. type: table #: doc/guix.texi:29634 msgid "Extra code to place at the end of the Patchwork settings module." msgstr "" #. type: deftp #: doc/guix.texi:29638 #, no-wrap msgid "{Data Type} patchwork-database-configuration" msgstr "" #. type: deftp #: doc/guix.texi:29640 msgid "Data type representing the database configuration for Patchwork." msgstr "" #. type: item #: doc/guix.texi:29642 #, no-wrap msgid "@code{engine} (default: @code{\"django.db.backends.postgresql_psycopg2\"})" msgstr "" #. type: table #: doc/guix.texi:29644 msgid "The database engine to use." msgstr "" #. type: item #: doc/guix.texi:29645 #, no-wrap msgid "@code{name} (default: @code{\"patchwork\"})" msgstr "" #. type: table #: doc/guix.texi:29647 msgid "The name of the database to use." msgstr "" #. type: table #: doc/guix.texi:29650 msgid "The user to connect to the database as." msgstr "" #. type: item #: doc/guix.texi:29651 #, no-wrap msgid "@code{password} (default: @code{\"\"})" msgstr "" #. type: table #: doc/guix.texi:29653 msgid "The password to use when connecting to the database." msgstr "" #. type: item #: doc/guix.texi:29654 #, no-wrap msgid "@code{host} (default: @code{\"\"})" msgstr "" #. type: table #: doc/guix.texi:29656 msgid "The host to make the database connection to." msgstr "" #. type: item #: doc/guix.texi:29657 #, no-wrap msgid "@code{port} (default: @code{\"\"})" msgstr "" #. type: table #: doc/guix.texi:29659 msgid "The port on which to connect to the database." msgstr "" #. type: subsubheading #: doc/guix.texi:29663 #, no-wrap msgid "Mumi" msgstr "" #. type: cindex #: doc/guix.texi:29665 #, no-wrap msgid "Mumi, Debbugs Web interface" msgstr "" #. type: cindex #: doc/guix.texi:29666 #, no-wrap msgid "Debbugs, Mumi Web interface" msgstr "" #. type: Plain text #: doc/guix.texi:29671 msgid "" "@uref{https://git.elephly.net/gitweb.cgi?p=software/mumi.git, Mumi} is a Web " "interface to the Debbugs bug tracker, by default for @uref{https://bugs.gnu." "org, the GNU instance}. Mumi is a Web server, but it also fetches and " "indexes mail retrieved from Debbugs." msgstr "" #. type: defvr #: doc/guix.texi:29672 #, no-wrap msgid "{Scheme Variable} mumi-service-type" msgstr "" #. type: defvr #: doc/guix.texi:29674 msgid "This is the service type for Mumi." msgstr "" #. type: deftp #: doc/guix.texi:29676 #, no-wrap msgid "{Data Type} mumi-configuration" msgstr "" #. type: deftp #: doc/guix.texi:29679 msgid "" "Data type representing the Mumi service configuration. This type has the " "following fields:" msgstr "" #. type: item #: doc/guix.texi:29681 #, no-wrap msgid "@code{mumi} (default: @code{mumi})" msgstr "" #. type: table #: doc/guix.texi:29683 msgid "The Mumi package to use." msgstr "" #. type: item #: doc/guix.texi:29684 #, no-wrap msgid "@code{mailer?} (default: @code{#true})" msgstr "" #. type: table #: doc/guix.texi:29686 msgid "Whether to enable or disable the mailer component." msgstr "" #. type: code{#1} #: doc/guix.texi:29687 #, no-wrap msgid "mumi-configuration-sender" msgstr "" #. type: table #: doc/guix.texi:29689 msgid "The email address used as the sender for comments." msgstr "" #. type: code{#1} #: doc/guix.texi:29690 #, no-wrap msgid "mumi-configuration-smtp" msgstr "" #. type: table #: doc/guix.texi:29695 msgid "" "A URI to configure the SMTP settings for Mailutils. This could be something " "like @code{sendmail:///path/to/bin/msmtp} or any other URI supported by " "Mailutils. @xref{SMTP Mailboxes, SMTP Mailboxes,, mailutils, GNU@tie{}" "Mailutils}." msgstr "" #. type: subsubheading #: doc/guix.texi:29700 #, no-wrap msgid "FastCGI" msgstr "" #. type: cindex #: doc/guix.texi:29701 #, no-wrap msgid "fastcgi" msgstr "" #. type: cindex #: doc/guix.texi:29702 #, no-wrap msgid "fcgiwrap" msgstr "" #. type: Plain text #: doc/guix.texi:29709 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:29716 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:29717 #, no-wrap msgid "{Scheme Variable} fcgiwrap-service-type" msgstr "" #. type: defvr #: doc/guix.texi:29719 msgid "A service type for the @code{fcgiwrap} FastCGI proxy." msgstr "" #. type: deftp #: doc/guix.texi:29721 #, no-wrap msgid "{Data Type} fcgiwrap-configuration" msgstr "" #. type: deftp #: doc/guix.texi:29724 msgid "" "Data type representing the configuration of the @code{fcgiwrap} service. " "This type has the following parameters:" msgstr "" #. type: item #: doc/guix.texi:29725 #, no-wrap msgid "@code{package} (default: @code{fcgiwrap})" msgstr "" #. type: table #: doc/guix.texi:29727 msgid "The fcgiwrap package to use." msgstr "" #. type: item #: doc/guix.texi:29728 #, no-wrap msgid "@code{socket} (default: @code{tcp:127.0.0.1:9000})" msgstr "" #. type: table #: doc/guix.texi:29734 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:29735 #, no-wrap msgid "@code{user} (default: @code{fcgiwrap})" msgstr "" #. type: itemx #: doc/guix.texi:29736 #, no-wrap msgid "@code{group} (default: @code{fcgiwrap})" msgstr "" #. type: table #: doc/guix.texi:29741 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:29748 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: subsubheading #: doc/guix.texi:29752 #, no-wrap msgid "PHP-FPM" msgstr "" #. type: cindex #: doc/guix.texi:29753 #, no-wrap msgid "php-fpm" msgstr "" #. type: Plain text #: doc/guix.texi:29756 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:29758 msgid "These features include:" msgstr "" #. type: item #: doc/guix.texi:29759 #, no-wrap msgid "Adaptive process spawning" msgstr "" #. type: item #: doc/guix.texi:29760 #, no-wrap msgid "Basic statistics (similar to Apache's mod_status)" msgstr "" #. type: item #: doc/guix.texi:29761 #, no-wrap msgid "Advanced process management with graceful stop/start" msgstr "" #. type: item #: doc/guix.texi:29762 #, no-wrap msgid "Ability to start workers with different uid/gid/chroot/environment" msgstr "" #. type: itemize #: doc/guix.texi:29764 msgid "and different php.ini (replaces safe_mode)" msgstr "" #. type: item #: doc/guix.texi:29764 #, no-wrap msgid "Stdout & stderr logging" msgstr "" #. type: item #: doc/guix.texi:29765 #, no-wrap msgid "Emergency restart in case of accidental opcode cache destruction" msgstr "" #. type: item #: doc/guix.texi:29766 #, no-wrap msgid "Accelerated upload support" msgstr "" #. type: item #: doc/guix.texi:29767 #, no-wrap msgid "Support for a \"slowlog\"" msgstr "" #. type: item #: doc/guix.texi:29768 #, no-wrap msgid "Enhancements to FastCGI, such as fastcgi_finish_request() -" msgstr "" #. type: itemize #: doc/guix.texi:29771 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:29773 msgid "...@: and much more." msgstr "" #. type: defvr #: doc/guix.texi:29774 #, no-wrap msgid "{Scheme Variable} php-fpm-service-type" msgstr "" #. type: defvr #: doc/guix.texi:29776 msgid "A Service type for @code{php-fpm}." msgstr "" #. type: deftp #: doc/guix.texi:29778 #, no-wrap msgid "{Data Type} php-fpm-configuration" msgstr "" #. type: deftp #: doc/guix.texi:29780 msgid "Data Type for php-fpm service configuration." msgstr "" #. type: item #: doc/guix.texi:29781 #, no-wrap msgid "@code{php} (default: @code{php})" msgstr "" #. type: table #: doc/guix.texi:29783 msgid "The php package to use." msgstr "" #. type: item #: doc/guix.texi:29783 #, 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:29785 msgid "The address on which to accept FastCGI requests. Valid syntaxes are:" msgstr "" #. type: code{#1} #: doc/guix.texi:29786 #, no-wrap msgid "\"ip.add.re.ss:port\"" msgstr "" #. type: table #: doc/guix.texi:29788 msgid "Listen on a TCP socket to a specific address on a specific port." msgstr "" #. type: code{#1} #: doc/guix.texi:29788 #, no-wrap msgid "\"port\"" msgstr "" #. type: table #: doc/guix.texi:29790 msgid "Listen on a TCP socket to all addresses on a specific port." msgstr "" #. type: code{#1} #: doc/guix.texi:29790 #, no-wrap msgid "\"/path/to/unix/socket\"" msgstr "" #. type: table #: doc/guix.texi:29792 msgid "Listen on a unix socket." msgstr "" #. type: item #: doc/guix.texi:29794 #, no-wrap msgid "@code{user} (default: @code{php-fpm})" msgstr "" #. type: table #: doc/guix.texi:29796 msgid "User who will own the php worker processes." msgstr "" #. type: item #: doc/guix.texi:29796 #, no-wrap msgid "@code{group} (default: @code{php-fpm})" msgstr "" #. type: table #: doc/guix.texi:29798 msgid "Group of the worker processes." msgstr "" #. type: item #: doc/guix.texi:29798 #, no-wrap msgid "@code{socket-user} (default: @code{php-fpm})" msgstr "" #. type: table #: doc/guix.texi:29800 msgid "User who can speak to the php-fpm socket." msgstr "" #. type: item #: doc/guix.texi:29800 #, no-wrap msgid "@code{socket-group} (default: @code{nginx})" msgstr "" #. type: table #: doc/guix.texi:29802 msgid "Group that can speak to the php-fpm socket." msgstr "" #. type: item #: doc/guix.texi:29802 #, 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:29805 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:29805 #, 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:29807 msgid "Log for the php-fpm master process." msgstr "" #. type: item #: doc/guix.texi:29807 #, no-wrap msgid "@code{process-manager} (default: @code{(php-fpm-dynamic-process-manager-configuration)})" msgstr "" #. type: table #: doc/guix.texi:29810 msgid "Detailed settings for the php-fpm process manager. Must be one of:" msgstr "" #. type: code{#1} #: doc/guix.texi:29811 #, no-wrap msgid "" msgstr "" #. type: code{#1} #: doc/guix.texi:29812 #, no-wrap msgid "" msgstr "" #. type: code{#1} #: doc/guix.texi:29813 #, no-wrap msgid "" msgstr "" #. type: item #: doc/guix.texi:29815 #, no-wrap msgid "@code{display-errors} (default @code{#f})" msgstr "" #. type: table #: doc/guix.texi:29820 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:29820 #, no-wrap msgid "@code{timezone} (default @code{#f})" msgstr "" #. type: table #: doc/guix.texi:29822 msgid "Specifies @code{php_admin_value[date.timezone]} parameter." msgstr "" #. type: item #: doc/guix.texi:29822 #, 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:29825 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:29825 #, no-wrap msgid "@code{file} (default @code{#f})" msgstr "" #. type: table #: doc/guix.texi:29828 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: item #: doc/guix.texi:29828 #, no-wrap msgid "@code{php-ini-file} (default @code{#f})" msgstr "" #. type: table #: doc/guix.texi:29832 msgid "" "An optional override of the default php settings. It may be any ``file-" "like'' object (@pxref{G-Expressions, file-like objects}). You can use the " "@code{mixed-text-file} function or an absolute filepath for it." msgstr "" #. type: table #: doc/guix.texi:29836 msgid "" "For local development it is useful to set a higher timeout and memory limit " "for spawned php processes. This be accomplished with the following " "operating system configuration snippet:" msgstr "" #. type: lisp #: doc/guix.texi:29841 #, no-wrap msgid "" "(define %local-php-ini\n" " (plain-file \"php.ini\"\n" " \"memory_limit = 2G\n" "max_execution_time = 1800\"))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:29848 #, no-wrap msgid "" "(operating-system\n" " ;; @dots{}\n" " (services (cons (service php-fpm-service-type\n" " (php-fpm-configuration\n" " (php-ini-file %local-php-ini)))\n" " %base-services)))\n" msgstr "" #. type: table #: doc/guix.texi:29853 msgid "" "Consult the @url{https://www.php.net/manual/en/ini.core.php,core php.ini " "directives} for comprehensive documentation on the acceptable @file{php.ini} " "directives." msgstr "" #. type: deftp #: doc/guix.texi:29856 #, no-wrap msgid "{Data type} php-fpm-dynamic-process-manager-configuration" msgstr "" #. type: deftp #: doc/guix.texi:29860 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 its configured limits." msgstr "" #. type: item #: doc/guix.texi:29861 doc/guix.texi:29877 doc/guix.texi:29887 #, no-wrap msgid "@code{max-children} (default: @code{5})" msgstr "" #. type: table #: doc/guix.texi:29863 doc/guix.texi:29879 doc/guix.texi:29889 msgid "Maximum of worker processes." msgstr "" #. type: item #: doc/guix.texi:29863 #, no-wrap msgid "@code{start-servers} (default: @code{2})" msgstr "" #. type: table #: doc/guix.texi:29865 msgid "How many worker processes should be started on start-up." msgstr "" #. type: item #: doc/guix.texi:29865 #, no-wrap msgid "@code{min-spare-servers} (default: @code{1})" msgstr "" #. type: table #: doc/guix.texi:29867 msgid "How many spare worker processes should be kept around at minimum." msgstr "" #. type: item #: doc/guix.texi:29867 #, no-wrap msgid "@code{max-spare-servers} (default: @code{3})" msgstr "" #. type: table #: doc/guix.texi:29869 msgid "How many spare worker processes should be kept around at maximum." msgstr "" #. type: deftp #: doc/guix.texi:29872 #, no-wrap msgid "{Data type} php-fpm-static-process-manager-configuration" msgstr "" #. type: deftp #: doc/guix.texi:29876 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:29882 #, no-wrap msgid "{Data type} php-fpm-on-demand-process-manager-configuration" msgstr "" #. type: deftp #: doc/guix.texi:29886 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:29889 #, no-wrap msgid "@code{process-idle-timeout} (default: @code{10})" msgstr "" #. type: table #: doc/guix.texi:29891 msgid "The time in seconds after which a process with no requests is killed." msgstr "" #. type: deffn #: doc/guix.texi:29895 #, no-wrap msgid "{Scheme Procedure} nginx-php-location @" msgstr "" #. type: deffn #: doc/guix.texi:29901 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:29904 msgid "A simple services setup for nginx with php can look like this:" msgstr "" #. type: lisp #: doc/guix.texi:29917 #, no-wrap msgid "" "(services (cons* (service dhcp-client-service-type)\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" " (listen '(\"80\"))\n" " (ssl-certificate #f)\n" " (ssl-certificate-key #f)))\n" " %base-services))\n" msgstr "" #. type: cindex #: doc/guix.texi:29919 #, no-wrap msgid "cat-avatar-generator" msgstr "" #. type: Plain text #: doc/guix.texi:29923 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:29924 #, no-wrap msgid "{Scheme Procedure} cat-avatar-generator-service @" msgstr "" #. type: deffn #: doc/guix.texi:29932 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:29935 msgid "A simple setup for cat-avatar-generator can look like this:" msgstr "" #. type: lisp #: doc/guix.texi:29942 #, 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:29944 #, no-wrap msgid "Hpcguix-web" msgstr "" #. type: cindex #: doc/guix.texi:29946 #, no-wrap msgid "hpcguix-web" msgstr "" #. type: Plain text #: doc/guix.texi:29951 msgid "" "The @uref{https://github.com/UMCUGenetics/hpcguix-web/, hpcguix-web} program " "is a customizable web interface to browse Guix packages, initially designed " "for users of high-performance computing (HPC) clusters." msgstr "" #. type: defvr #: doc/guix.texi:29952 #, no-wrap msgid "{Scheme Variable} hpcguix-web-service-type" msgstr "" #. type: defvr #: doc/guix.texi:29954 msgid "The service type for @code{hpcguix-web}." msgstr "" #. type: deftp #: doc/guix.texi:29956 #, no-wrap msgid "{Data Type} hpcguix-web-configuration" msgstr "" #. type: deftp #: doc/guix.texi:29958 msgid "Data type for the hpcguix-web service configuration." msgstr "" #. type: code{#1} #: doc/guix.texi:29960 #, no-wrap msgid "specs" msgstr "" #. type: table #: doc/guix.texi:29963 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:29965 #, no-wrap msgid "@code{title-prefix} (default: @code{\"hpcguix | \"})" msgstr "" #. type: table #: doc/guix.texi:29967 msgid "The page title prefix." msgstr "" #. type: item #: doc/guix.texi:29968 #, no-wrap msgid "@code{guix-command} (default: @code{\"guix\"})" msgstr "" #. type: table #: doc/guix.texi:29970 msgid "The @command{guix} command." msgstr "" #. type: item #: doc/guix.texi:29971 #, no-wrap msgid "@code{package-filter-proc} (default: @code{(const #t)})" msgstr "" #. type: table #: doc/guix.texi:29973 msgid "A procedure specifying how to filter packages that are displayed." msgstr "" #. type: item #: doc/guix.texi:29974 #, no-wrap msgid "@code{package-page-extension-proc} (default: @code{(const '())})" msgstr "" #. type: table #: doc/guix.texi:29976 msgid "Extension package for @code{hpcguix-web}." msgstr "" #. type: item #: doc/guix.texi:29977 #, no-wrap msgid "@code{menu} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:29979 msgid "Additional entry in page @code{menu}." msgstr "" #. type: item #: doc/guix.texi:29980 #, no-wrap msgid "@code{channels} (default: @code{%default-channels})" msgstr "" #. type: table #: doc/guix.texi:29982 msgid "" "List of channels from which the package list is built (@pxref{Channels})." msgstr "" #. type: item #: doc/guix.texi:29983 #, no-wrap msgid "@code{package-list-expiration} (default: @code{(* 12 3600)})" msgstr "" #. type: table #: doc/guix.texi:29986 msgid "" "The expiration time, in seconds, after which the package list is rebuilt " "from the latest instances of the given channels." msgstr "" #. type: table #: doc/guix.texi:29991 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:29992 #, no-wrap msgid "@code{package} (default: @code{hpcguix-web})" msgstr "" #. type: table #: doc/guix.texi:29994 msgid "The hpcguix-web package to use." msgstr "" #. type: item #: doc/guix.texi:29995 #, no-wrap msgid "@code{address} (default: @code{\"127.0.0.1\"})" msgstr "" #. type: table #: doc/guix.texi:29997 msgid "The IP address to listen to." msgstr "" #. type: item #: doc/guix.texi:29998 #, no-wrap msgid "@code{port} (default: @code{5000})" msgstr "" #. type: table #: doc/guix.texi:30000 msgid "The port number to listen to." msgstr "" #. type: Plain text #: doc/guix.texi:30004 msgid "A typical hpcguix-web service declaration looks like this:" msgstr "" #. type: lisp #: doc/guix.texi:30013 #, 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: quotation #: doc/guix.texi:30020 msgid "" "The hpcguix-web service periodically updates the package list it publishes " "by pulling channels from Git. To that end, it needs to access X.509 " "certificates so that it can authenticate Git servers when communicating over " "HTTPS, and it assumes that @file{/etc/ssl/certs} contains those certificates." msgstr "" #. type: quotation #: doc/guix.texi:30024 msgid "" "Thus, make sure to add @code{nss-certs} or another certificate package to " "the @code{packages} field of your configuration. @ref{X.509 Certificates}, " "for more information on X.509 certificates." msgstr "" #. type: cindex #: doc/guix.texi:30026 doc/guix.texi:30028 #, no-wrap msgid "gmnisrv" msgstr "" #. type: Plain text #: doc/guix.texi:30031 msgid "" "The @uref{https://git.sr.ht/~sircmpwn/gmnisrv, gmnisrv} program is a simple " "@uref{https://gemini.circumlunar.space/, Gemini} protocol server." msgstr "" #. type: deffn #: doc/guix.texi:30032 #, no-wrap msgid "{Scheme Variable} gmnisrv-service-type" msgstr "" #. type: deffn #: doc/guix.texi:30035 msgid "" "This is the type of the gmnisrv service, whose value should be a " "@code{gmnisrv-configuration} object, as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:30040 #, no-wrap msgid "" "(service gmnisrv-service-type\n" " (gmnisrv-configuration\n" " (config-file (local-file \"./my-gmnisrv.ini\"))))\n" msgstr "" #. type: deftp #: doc/guix.texi:30043 #, no-wrap msgid "{Data Type} gmnisrv-configuration" msgstr "" #. type: deftp #: doc/guix.texi:30045 msgid "Data type representing the configuration of gmnisrv." msgstr "" #. type: item #: doc/guix.texi:30047 #, no-wrap msgid "@code{package} (default: @var{gmnisrv})" msgstr "" #. type: table #: doc/guix.texi:30049 msgid "Package object of the gmnisrv server." msgstr "" #. type: item #: doc/guix.texi:30050 #, no-wrap msgid "@code{config-file} (default: @code{%default-gmnisrv-config-file})" msgstr "" #. type: table #: doc/guix.texi:30056 msgid "" "File-like object of the gmnisrv configuration file to use. The default " "configuration listens on port 1965 and serves files from @file{/srv/" "gemini}. Certificates are stored in @file{/var/lib/gemini/certs}. For more " "information, run @command{man gmnisrv} and @command{man gmnisrv.ini}." msgstr "" #. type: subsubheading #: doc/guix.texi:30060 #, no-wrap msgid "Agate" msgstr "" #. type: cindex #: doc/guix.texi:30062 #, no-wrap msgid "agate" msgstr "" #. type: Plain text #: doc/guix.texi:30067 msgid "" "The @uref{gemini://qwertqwefsday.eu/agate.gmi, Agate} (@uref{https://github." "com/mbrubeck/agate, GitHub page over HTTPS}) program is a simple " "@uref{https://gemini.circumlunar.space/, Gemini} protocol server written in " "Rust." msgstr "" #. type: deffn #: doc/guix.texi:30068 #, no-wrap msgid "{Scheme Variable} agate-service-type" msgstr "" #. type: deffn #: doc/guix.texi:30071 msgid "" "This is the type of the agate service, whose value should be an @code{agate-" "service-type} object, as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:30078 #, no-wrap msgid "" "(service agate-service-type\n" "\t (agate-configuration\n" "\t (content \"/srv/gemini\")\n" "\t (cert \"/srv/cert.pem\")\n" "\t (key \"/srv/key.rsa\")))\n" msgstr "" #. type: deffn #: doc/guix.texi:30083 msgid "" "The example above represents the minimal tweaking necessary to get Agate up " "and running. Specifying the path to the certificate and key is always " "necessary, as the Gemini protocol requires TLS by default." msgstr "" #. type: deffn #: doc/guix.texi:30086 msgid "" "To obtain a certificate and a key, you could, for example, use OpenSSL, " "running a command similar to the following example:" msgstr "" #. type: example #: doc/guix.texi:30090 #, no-wrap msgid "" "openssl req -x509 -newkey rsa:4096 -keyout key.rsa -out cert.pem \\\n" " -days 3650 -nodes -subj \"/CN=example.com\"\n" msgstr "" #. type: deffn #: doc/guix.texi:30095 msgid "" "Of course, you'll have to replace @i{example.com} with your own domain name, " "and then point the Agate configuration towards the path of the generated key " "and certificate." msgstr "" #. type: deftp #: doc/guix.texi:30098 #, no-wrap msgid "{Data Type} agate-configuration" msgstr "" #. type: deftp #: doc/guix.texi:30100 msgid "Data type representing the configuration of Agate." msgstr "" #. type: item #: doc/guix.texi:30102 #, no-wrap msgid "@code{package} (default: @code{agate})" msgstr "" #. type: table #: doc/guix.texi:30104 msgid "The package object of the Agate server." msgstr "" #. type: item #: doc/guix.texi:30105 #, no-wrap msgid "@code{content} (default: @file{\"/srv/gemini\"})" msgstr "" #. type: table #: doc/guix.texi:30107 msgid "The directory from which Agate will serve files." msgstr "" #. type: item #: doc/guix.texi:30108 #, no-wrap msgid "@code{cert} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30111 msgid "" "The path to the TLS certificate PEM file to be used for encrypted " "connections. Must be filled in with a value from the user." msgstr "" #. type: item #: doc/guix.texi:30112 doc/guix.texi:30548 #, no-wrap msgid "@code{key} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30115 msgid "" "The path to the PKCS8 private key file to be used for encrypted " "connections. Must be filled in with a value from the user." msgstr "" #. type: item #: doc/guix.texi:30116 #, no-wrap msgid "@code{addr} (default: @code{'(\"0.0.0.0:1965\" \"[::]:1965\")})" msgstr "" #. type: table #: doc/guix.texi:30118 msgid "A list of the addresses to listen on." msgstr "" #. type: table #: doc/guix.texi:30121 msgid "The domain name of this Gemini server. Optional." msgstr "" #. type: item #: doc/guix.texi:30122 #, no-wrap msgid "@code{lang} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30124 msgid "RFC 4646 language code(s) for text/gemini documents. Optional." msgstr "" #. type: item #: doc/guix.texi:30125 #, no-wrap msgid "@code{silent?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30127 msgid "Set to @code{#t} to disable logging output." msgstr "" #. type: item #: doc/guix.texi:30128 #, no-wrap msgid "@code{serve-secret?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30131 msgid "" "Set to @code{#t} to serve secret files (files/directories starting with a " "dot)." msgstr "" #. type: item #: doc/guix.texi:30132 #, no-wrap msgid "@code{log-ip?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:30134 msgid "Whether or not to output IP addresses when logging." msgstr "" #. type: item #: doc/guix.texi:30135 #, no-wrap msgid "@code{user} (default: @code{\"agate\"})" msgstr "" #. type: table #: doc/guix.texi:30137 msgid "Owner of the @code{agate} process." msgstr "" #. type: item #: doc/guix.texi:30138 #, no-wrap msgid "@code{group} (default: @code{\"agate\"})" msgstr "" #. type: table #: doc/guix.texi:30140 msgid "Owner's group of the @code{agate} process." msgstr "" #. type: item #: doc/guix.texi:30141 #, no-wrap msgid "@code{log-file} (default: @file{\"/var/log/agate.log\"})" msgstr "" #. type: table #: doc/guix.texi:30143 msgid "The file which should store the logging output of Agate." msgstr "" #. type: cindex #: doc/guix.texi:30150 #, no-wrap msgid "Web" msgstr "" #. type: cindex #: doc/guix.texi:30151 #, no-wrap msgid "HTTP, HTTPS" msgstr "" #. type: cindex #: doc/guix.texi:30152 #, no-wrap msgid "Let's Encrypt" msgstr "" #. type: cindex #: doc/guix.texi:30153 #, no-wrap msgid "TLS certificates" msgstr "" #. type: Plain text #: doc/guix.texi:30160 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:30172 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:30179 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:30185 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:30189 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:30190 #, no-wrap msgid "{Scheme Variable} certbot-service-type" msgstr "" #. type: defvr #: doc/guix.texi:30193 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: lisp #: doc/guix.texi:30200 #, 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: lisp #: doc/guix.texi:30211 #, 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:30214 msgid "See below for details about @code{certbot-configuration}." msgstr "" #. type: deftp #: doc/guix.texi:30216 #, no-wrap msgid "{Data Type} certbot-configuration" msgstr "" #. type: deftp #: doc/guix.texi:30219 msgid "" "Data type representing the configuration of the @code{certbot} service. " "This type has the following parameters:" msgstr "" #. type: item #: doc/guix.texi:30221 #, no-wrap msgid "@code{package} (default: @code{certbot})" msgstr "" #. type: table #: doc/guix.texi:30223 msgid "The certbot package to use." msgstr "" #. type: item #: doc/guix.texi:30224 #, no-wrap msgid "@code{webroot} (default: @code{/var/www})" msgstr "" #. type: table #: doc/guix.texi:30227 msgid "" "The directory from which to serve the Let's Encrypt challenge/response files." msgstr "" #. type: item #: doc/guix.texi:30228 #, no-wrap msgid "@code{certificates} (default: @code{()})" msgstr "" #. type: table #: doc/guix.texi:30232 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: item #: doc/guix.texi:30233 #, no-wrap msgid "@code{email} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30237 msgid "" "Optional email address used for registration and recovery contact. Setting " "this is encouraged as it allows you to receive important notifications about " "the account and issued certificates." msgstr "" #. type: item #: doc/guix.texi:30238 doc/guix.texi:32140 #, no-wrap msgid "@code{server} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30241 msgid "" "Optional URL of ACME server. Setting this overrides certbot's default, " "which is the Let's Encrypt server." msgstr "" #. type: item #: doc/guix.texi:30242 #, no-wrap msgid "@code{rsa-key-size} (default: @code{2048})" msgstr "" #. type: table #: doc/guix.texi:30244 msgid "Size of the RSA key." msgstr "" #. type: item #: doc/guix.texi:30245 #, no-wrap msgid "@code{default-location} (default: @i{see below})" msgstr "" #. type: table #: doc/guix.texi:30254 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:30258 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:30262 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:30264 msgid "Pass @code{#f} to not issue a default location." msgstr "" #. type: deftp #: doc/guix.texi:30267 #, no-wrap msgid "{Data Type} certificate-configuration" msgstr "" #. type: deftp #: doc/guix.texi:30270 msgid "" "Data type representing the configuration of a certificate. This type has " "the following parameters:" msgstr "" #. type: item #: doc/guix.texi:30272 #, no-wrap msgid "@code{name} (default: @i{see below})" msgstr "" #. type: table #: doc/guix.texi:30276 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:30278 msgid "Its default is the first provided domain." msgstr "" #. type: item #: doc/guix.texi:30279 #, no-wrap msgid "@code{domains} (default: @code{()})" msgstr "" #. type: table #: doc/guix.texi:30282 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:30283 #, no-wrap msgid "@code{challenge} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30290 msgid "" "The challenge type that has to be run by certbot. If @code{#f} is " "specified, default to the HTTP challenge. If a value is specified, defaults " "to the manual plugin (see @code{authentication-hook}, @code{cleanup-hook} " "and the documentation at @url{https://certbot.eff.org/docs/using." "html#hooks}), and gives Let's Encrypt permission to log the public IP " "address of the requesting machine." msgstr "" #. type: item #: doc/guix.texi:30291 #, no-wrap msgid "@code{csr} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30298 msgid "" "File name of Certificate Signing Request (CSR) in DER or PEM format. If " "@code{#f} is specified, this argument will not be passed to certbot. If a " "value is specified, certbot will use it to obtain a certificate, instead of " "using a self-generated CSR. The domain-name(s) mentioned in @code{domains}, " "must be consistent with the domain-name(s) mentioned in CSR file." msgstr "" #. type: item #: doc/guix.texi:30299 #, no-wrap msgid "@code{authentication-hook} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30305 msgid "" "Command to be run in a shell once for each certificate challenge to be " "answered. For this command, the shell variable @code{$CERTBOT_DOMAIN} will " "contain the domain being authenticated, @code{$CERTBOT_VALIDATION} contains " "the validation string and @code{$CERTBOT_TOKEN} contains the file name of " "the resource requested when performing an HTTP-01 challenge." msgstr "" #. type: item #: doc/guix.texi:30306 #, no-wrap msgid "@code{cleanup-hook} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30312 msgid "" "Command to be run in a shell once for each certificate challenge that have " "been answered by the @code{auth-hook}. For this command, the shell " "variables available in the @code{auth-hook} script are still available, and " "additionally @code{$CERTBOT_AUTH_OUTPUT} will contain the standard output of " "the @code{auth-hook} script." msgstr "" #. type: item #: doc/guix.texi:30313 #, no-wrap msgid "@code{deploy-hook} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30321 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:30328 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:30330 #, no-wrap msgid "DNS (domain name system)" msgstr "" #. type: cindex #: doc/guix.texi:30331 #, no-wrap msgid "domain name system (DNS)" msgstr "" #. type: Plain text #: doc/guix.texi:30339 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:30340 #, no-wrap msgid "Knot Service" msgstr "" #. type: Plain text #: doc/guix.texi:30344 msgid "" "An example configuration of an authoritative server for two zones, one " "master and one slave, is:" msgstr "" #. type: lisp #: doc/guix.texi:30351 #, 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:30358 #, 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:30364 #, 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:30369 #, 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:30378 #, 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:30380 #, no-wrap msgid "{Scheme Variable} knot-service-type" msgstr "" #. type: deffn #: doc/guix.texi:30382 msgid "This is the type for the Knot DNS server." msgstr "" #. type: deffn #: doc/guix.texi:30390 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:30392 msgid "The following data types are used to configure the Knot DNS server:" msgstr "" #. type: deftp #: doc/guix.texi:30394 #, no-wrap msgid "{Data Type} knot-key-configuration" msgstr "" #. type: deftp #: doc/guix.texi:30397 msgid "Data type representing a key. This type has the following parameters:" msgstr "" #. type: item #: doc/guix.texi:30399 doc/guix.texi:30419 doc/guix.texi:30534 #: doc/guix.texi:30560 doc/guix.texi:30595 #, no-wrap msgid "@code{id} (default: @code{\"\"})" msgstr "" #. type: table #: doc/guix.texi:30402 doc/guix.texi:30422 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:30403 #, no-wrap msgid "@code{algorithm} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30407 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:30408 #, no-wrap msgid "@code{secret} (default: @code{\"\"})" msgstr "" #. type: table #: doc/guix.texi:30410 msgid "The secret key itself." msgstr "" #. type: deftp #: doc/guix.texi:30414 #, no-wrap msgid "{Data Type} knot-acl-configuration" msgstr "" #. type: deftp #: doc/guix.texi:30417 msgid "" "Data type representing an Access Control List (ACL) configuration. This " "type has the following parameters:" msgstr "" #. type: item #: doc/guix.texi:30423 doc/guix.texi:30538 #, no-wrap msgid "@code{address} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:30427 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:30428 #, no-wrap msgid "@code{key} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:30432 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:30433 #, no-wrap msgid "@code{action} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:30437 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:30438 #, no-wrap msgid "@code{deny?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30441 msgid "" "When true, the ACL defines restrictions. Listed actions are forbidden. " "When false, listed actions are allowed." msgstr "" #. type: deftp #: doc/guix.texi:30445 #, no-wrap msgid "{Data Type} zone-entry" msgstr "" #. type: deftp #: doc/guix.texi:30448 msgid "" "Data type representing a record entry in a zone file. This type has the " "following parameters:" msgstr "" #. type: item #: doc/guix.texi:30450 #, no-wrap msgid "@code{name} (default: @code{\"@@\"})" msgstr "" #. type: table #: doc/guix.texi:30456 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:30457 #, no-wrap msgid "@code{ttl} (default: @code{\"\"})" msgstr "" #. type: table #: doc/guix.texi:30459 msgid "" "The Time-To-Live (TTL) of this record. If not set, the default TTL is used." msgstr "" #. type: item #: doc/guix.texi:30460 #, no-wrap msgid "@code{class} (default: @code{\"IN\"})" msgstr "" #. type: table #: doc/guix.texi:30463 msgid "" "The class of the record. Knot currently supports only @code{\"IN\"} and " "partially @code{\"CH\"}." msgstr "" #. type: item #: doc/guix.texi:30464 #, no-wrap msgid "@code{type} (default: @code{\"A\"})" msgstr "" #. type: table #: doc/guix.texi:30468 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:30469 #, no-wrap msgid "@code{data} (default: @code{\"\"})" msgstr "" #. type: table #: doc/guix.texi:30473 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:30477 #, no-wrap msgid "{Data Type} zone-file" msgstr "" #. type: deftp #: doc/guix.texi:30480 msgid "" "Data type representing the content of a zone file. This type has the " "following parameters:" msgstr "" #. type: table #: doc/guix.texi:30489 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:30490 #, no-wrap msgid "@code{origin} (default: @code{\"\"})" msgstr "" #. type: table #: doc/guix.texi:30492 msgid "The name of your zone. This parameter cannot be empty." msgstr "" #. type: item #: doc/guix.texi:30493 #, no-wrap msgid "@code{ns} (default: @code{\"ns\"})" msgstr "" #. type: table #: doc/guix.texi:30498 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:30499 #, no-wrap msgid "@code{mail} (default: @code{\"hostmaster\"})" msgstr "" #. type: table #: doc/guix.texi:30502 msgid "" "An email address people can contact you at, as the owner of the zone. This " "is translated as @code{@@}." msgstr "" #. type: item #: doc/guix.texi:30503 #, no-wrap msgid "@code{serial} (default: @code{1})" msgstr "" #. type: table #: doc/guix.texi:30507 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:30508 #, no-wrap msgid "@code{refresh} (default: @code{(* 2 24 3600)})" msgstr "" #. type: table #: doc/guix.texi:30512 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:30513 #, no-wrap msgid "@code{retry} (default: @code{(* 15 60)})" msgstr "" #. type: table #: doc/guix.texi:30516 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:30517 #, no-wrap msgid "@code{expiry} (default: @code{(* 14 24 3600)})" msgstr "" #. type: table #: doc/guix.texi:30521 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:30522 #, no-wrap msgid "@code{nx} (default: @code{3600})" msgstr "" #. type: table #: doc/guix.texi:30525 msgid "" "Default TTL of inexistent records. This delay is usually short because you " "want your new domains to reach everyone quickly." msgstr "" #. type: deftp #: doc/guix.texi:30529 #, no-wrap msgid "{Data Type} knot-remote-configuration" msgstr "" #. type: deftp #: doc/guix.texi:30532 msgid "" "Data type representing a remote configuration. This type has the following " "parameters:" msgstr "" #. type: table #: doc/guix.texi:30537 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:30542 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:30543 #, no-wrap msgid "@code{via} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:30547 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: table #: doc/guix.texi:30551 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:30555 #, no-wrap msgid "{Data Type} knot-keystore-configuration" msgstr "" #. type: deftp #: doc/guix.texi:30558 msgid "" "Data type representing a keystore to hold dnssec keys. This type has the " "following parameters:" msgstr "" #. type: table #: doc/guix.texi:30562 msgid "The id of the keystore. It must not be empty." msgstr "" #. type: item #: doc/guix.texi:30563 #, no-wrap msgid "@code{backend} (default: @code{'pem})" msgstr "" #. type: table #: doc/guix.texi:30565 msgid "" "The backend to store the keys in. Can be @code{'pem} or @code{'pkcs11}." msgstr "" #. type: item #: doc/guix.texi:30566 #, no-wrap msgid "@code{config} (default: @code{\"/var/lib/knot/keys/keys\"})" msgstr "" #. type: table #: doc/guix.texi:30570 msgid "" "The configuration string of the backend. An example for the PKCS#11 is: " "@code{\"pkcs11:token=knot;pin-value=1234 /gnu/store/.../lib/pkcs11/" "libsofthsm2.so\"}. For the pem backend, the string represents a path in the " "file system." msgstr "" #. type: deftp #: doc/guix.texi:30574 #, no-wrap msgid "{Data Type} knot-policy-configuration" msgstr "" #. type: deftp #: doc/guix.texi:30578 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:30585 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:30591 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:30593 msgid "This type has the following parameters:" msgstr "" #. type: table #: doc/guix.texi:30597 msgid "The id of the policy. It must not be empty." msgstr "" #. type: item #: doc/guix.texi:30598 #, no-wrap msgid "@code{keystore} (default: @code{\"default\"})" msgstr "" #. type: table #: doc/guix.texi:30603 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:30604 #, no-wrap msgid "@code{manual?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30606 msgid "Whether the key management is manual or automatic." msgstr "" #. type: item #: doc/guix.texi:30607 #, no-wrap msgid "@code{single-type-signing?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30609 msgid "When @code{#t}, use the Single-Type Signing Scheme." msgstr "" #. type: item #: doc/guix.texi:30610 #, no-wrap msgid "@code{algorithm} (default: @code{\"ecdsap256sha256\"})" msgstr "" #. type: table #: doc/guix.texi:30612 msgid "An algorithm of signing keys and issued signatures." msgstr "" #. type: item #: doc/guix.texi:30613 #, no-wrap msgid "@code{ksk-size} (default: @code{256})" msgstr "" #. type: table #: doc/guix.texi:30616 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:30617 #, no-wrap msgid "@code{zsk-size} (default: @code{256})" msgstr "" #. type: table #: doc/guix.texi:30620 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:30621 #, no-wrap msgid "@code{dnskey-ttl} (default: @code{'default})" msgstr "" #. type: table #: doc/guix.texi:30624 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:30625 #, no-wrap msgid "@code{zsk-lifetime} (default: @code{(* 30 24 3600)})" msgstr "" #. type: table #: doc/guix.texi:30627 msgid "The period between ZSK publication and the next rollover initiation." msgstr "" #. type: item #: doc/guix.texi:30628 #, no-wrap msgid "@code{propagation-delay} (default: @code{(* 24 3600)})" msgstr "" #. type: table #: doc/guix.texi:30631 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:30632 #, no-wrap msgid "@code{rrsig-lifetime} (default: @code{(* 14 24 3600)})" msgstr "" #. type: table #: doc/guix.texi:30634 msgid "A validity period of newly issued signatures." msgstr "" #. type: item #: doc/guix.texi:30635 #, no-wrap msgid "@code{rrsig-refresh} (default: @code{(* 7 24 3600)})" msgstr "" #. type: table #: doc/guix.texi:30637 msgid "" "A period how long before a signature expiration the signature will be " "refreshed." msgstr "" #. type: item #: doc/guix.texi:30638 #, no-wrap msgid "@code{nsec3?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30640 msgid "When @code{#t}, NSEC3 will be used instead of NSEC." msgstr "" #. type: item #: doc/guix.texi:30641 #, no-wrap msgid "@code{nsec3-iterations} (default: @code{5})" msgstr "" #. type: table #: doc/guix.texi:30643 msgid "The number of additional times the hashing is performed." msgstr "" #. type: item #: doc/guix.texi:30644 #, no-wrap msgid "@code{nsec3-salt-length} (default: @code{8})" msgstr "" #. type: table #: doc/guix.texi:30647 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:30648 #, no-wrap msgid "@code{nsec3-salt-lifetime} (default: @code{(* 30 24 3600)})" msgstr "" #. type: table #: doc/guix.texi:30650 msgid "The validity period of newly issued salt field." msgstr "" #. type: deftp #: doc/guix.texi:30654 #, no-wrap msgid "{Data Type} knot-zone-configuration" msgstr "" #. type: deftp #: doc/guix.texi:30657 msgid "" "Data type representing a zone served by Knot. This type has the following " "parameters:" msgstr "" #. type: item #: doc/guix.texi:30659 #, no-wrap msgid "@code{domain} (default: @code{\"\"})" msgstr "" #. type: table #: doc/guix.texi:30661 msgid "The domain served by this configuration. It must not be empty." msgstr "" #. type: item #: doc/guix.texi:30662 #, no-wrap msgid "@code{file} (default: @code{\"\"})" msgstr "" #. type: table #: doc/guix.texi:30665 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:30666 #, no-wrap msgid "@code{zone} (default: @code{(zone-file)})" msgstr "" #. type: table #: doc/guix.texi:30669 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:30670 #, no-wrap msgid "@code{master} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:30673 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:30674 #, no-wrap msgid "@code{ddns-master} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30677 msgid "" "The main master. When empty, it defaults to the first master in the list of " "masters." msgstr "" #. type: item #: doc/guix.texi:30678 #, no-wrap msgid "@code{notify} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:30680 msgid "A list of slave remote identifiers." msgstr "" #. type: item #: doc/guix.texi:30681 #, no-wrap msgid "@code{acl} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:30683 msgid "A list of acl identifiers." msgstr "" #. type: item #: doc/guix.texi:30684 #, no-wrap msgid "@code{semantic-checks?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30686 msgid "When set, this adds more semantic checks to the zone." msgstr "" #. type: item #: doc/guix.texi:30687 #, no-wrap msgid "@code{zonefile-sync} (default: @code{0})" msgstr "" #. type: table #: doc/guix.texi:30690 msgid "" "The delay between a modification in memory and on disk. 0 means immediate " "synchronization." msgstr "" #. type: item #: doc/guix.texi:30691 #, no-wrap msgid "@code{zonefile-load} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30694 msgid "" "The way the zone file contents are applied during zone load. Possible " "values are:" msgstr "" #. type: item #: doc/guix.texi:30696 #, no-wrap msgid "@code{#f} for using the default value from Knot," msgstr "" #. type: item #: doc/guix.texi:30697 #, no-wrap msgid "@code{'none} for not using the zone file at all," msgstr "" #. type: item #: doc/guix.texi:30698 #, no-wrap msgid "@code{'difference} for computing the difference between already available" msgstr "" #. type: itemize #: doc/guix.texi:30700 msgid "" "contents and zone contents and applying it to the current zone contents," msgstr "" #. type: item #: doc/guix.texi:30700 #, no-wrap msgid "@code{'difference-no-serial} for the same as @code{'difference}, but" msgstr "" #. type: itemize #: doc/guix.texi:30703 msgid "" "ignoring the SOA serial in the zone file, while the server takes care of it " "automatically." msgstr "" #. type: item #: doc/guix.texi:30703 #, no-wrap msgid "@code{'whole} for loading zone contents from the zone file." msgstr "" #. type: item #: doc/guix.texi:30706 #, no-wrap msgid "@code{journal-content} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30711 msgid "" "The way the journal is used to store zone and its changes. Possible values " "are @code{'none} to not use it at all, @code{'changes} to store changes and " "@code{'all} to store contents. @code{#f} does not set this option, so the " "default value from Knot is used." msgstr "" #. type: item #: doc/guix.texi:30712 #, no-wrap msgid "@code{max-journal-usage} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30715 msgid "" "The maximum size for the journal on disk. @code{#f} does not set this " "option, so the default value from Knot is used." msgstr "" #. type: item #: doc/guix.texi:30716 #, no-wrap msgid "@code{max-journal-depth} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30719 msgid "" "The maximum size of the history. @code{#f} does not set this option, so the " "default value from Knot is used." msgstr "" #. type: item #: doc/guix.texi:30720 #, no-wrap msgid "@code{max-zone-size} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30724 msgid "" "The maximum size of the zone file. This limit is enforced for incoming " "transfer and updates. @code{#f} does not set this option, so the default " "value from Knot is used." msgstr "" #. type: item #: doc/guix.texi:30725 #, no-wrap msgid "@code{dnssec-policy} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30729 msgid "" "A reference to a @code{knot-policy-configuration} record, or the special " "name @code{\"default\"}. If the value is @code{#f}, there is no dnssec " "signing on this zone." msgstr "" #. type: item #: doc/guix.texi:30730 #, no-wrap msgid "@code{serial-policy} (default: @code{'increment})" msgstr "" #. type: table #: doc/guix.texi:30732 msgid "A policy between @code{'increment} and @code{'unixtime}." msgstr "" #. type: deftp #: doc/guix.texi:30736 #, no-wrap msgid "{Data Type} knot-configuration" msgstr "" #. type: deftp #: doc/guix.texi:30739 msgid "" "Data type representing the Knot configuration. This type has the following " "parameters:" msgstr "" #. type: item #: doc/guix.texi:30741 #, no-wrap msgid "@code{knot} (default: @code{knot})" msgstr "" #. type: table #: doc/guix.texi:30743 msgid "The Knot package." msgstr "" #. type: item #: doc/guix.texi:30744 #, no-wrap msgid "@code{run-directory} (default: @code{\"/var/run/knot\"})" msgstr "" #. type: table #: doc/guix.texi:30746 msgid "" "The run directory. This directory will be used for pid file and sockets." msgstr "" #. type: item #: doc/guix.texi:30747 #, no-wrap msgid "@code{includes} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:30750 msgid "" "A list of strings or file-like objects denoting other files that must be " "included at the top of the configuration file." msgstr "" #. type: cindex #: doc/guix.texi:30751 #, no-wrap msgid "secrets, Knot service" msgstr "" #. type: table #: doc/guix.texi:30757 msgid "" "This can be used to manage secrets out-of-band. For example, secret keys " "may be stored in an out-of-band file not managed by Guix, and thus not " "visible in @file{/gnu/store}---e.g., you could store secret key " "configuration in @file{/etc/knot/secrets.conf} and add this file to the " "@code{includes} list." msgstr "" #. type: table #: doc/guix.texi:30762 msgid "" "One can generate a secret tsig key (for nsupdate and zone transfers with the " "keymgr command from the knot package. Note that the package is not " "automatically installed by the service. The following example shows how to " "generate a new tsig key:" msgstr "" #. type: example #: doc/guix.texi:30766 #, no-wrap msgid "" "keymgr -t mysecret > /etc/knot/secrets.conf\n" "chmod 600 /etc/knot/secrets.conf\n" msgstr "" #. type: table #: doc/guix.texi:30772 msgid "" "Also note that the generated key will be named @var{mysecret}, so it is the " "name that needs to be used in the @var{key} field of the @code{knot-acl-" "configuration} record and in other places that need to refer to that key." msgstr "" #. type: table #: doc/guix.texi:30774 msgid "" "It can also be used to add configuration not supported by this interface." msgstr "" #. type: item #: doc/guix.texi:30775 #, no-wrap msgid "@code{listen-v4} (default: @code{\"0.0.0.0\"})" msgstr "" #. type: table #: doc/guix.texi:30777 doc/guix.texi:30780 msgid "An ip address on which to listen." msgstr "" #. type: item #: doc/guix.texi:30778 #, no-wrap msgid "@code{listen-v6} (default: @code{\"::\"})" msgstr "" #. type: item #: doc/guix.texi:30781 #, no-wrap msgid "@code{listen-port} (default: @code{53})" msgstr "" #. type: table #: doc/guix.texi:30783 msgid "A port on which to listen." msgstr "" #. type: item #: doc/guix.texi:30784 #, no-wrap msgid "@code{keys} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:30786 msgid "The list of knot-key-configuration used by this configuration." msgstr "" #. type: item #: doc/guix.texi:30787 #, no-wrap msgid "@code{acls} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:30789 msgid "The list of knot-acl-configuration used by this configuration." msgstr "" #. type: item #: doc/guix.texi:30790 #, no-wrap msgid "@code{remotes} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:30792 msgid "The list of knot-remote-configuration used by this configuration." msgstr "" #. type: item #: doc/guix.texi:30793 #, no-wrap msgid "@code{zones} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:30795 msgid "The list of knot-zone-configuration used by this configuration." msgstr "" #. type: subsubheading #: doc/guix.texi:30799 #, no-wrap msgid "Knot Resolver Service" msgstr "" #. type: deffn #: doc/guix.texi:30801 #, no-wrap msgid "{Scheme Variable} knot-resolver-service-type" msgstr "" #. type: deffn #: doc/guix.texi:30804 msgid "" "This is the type of the knot resolver service, whose value should be an " "@code{knot-resolver-configuration} object as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:30814 #, no-wrap msgid "" "(service knot-resolver-service-type\n" " (knot-resolver-configuration\n" " (kresd-config-file (plain-file \"kresd.conf\" \"\n" "net.listen('192.168.0.1', 5353)\n" "user('knot-resolver', 'knot-resolver')\n" "modules = @{ 'hints > iterate', 'stats', 'predict' @}\n" "cache.size = 100 * MB\n" "\"))))\n" msgstr "" #. type: deffn #: doc/guix.texi:30817 msgid "" "For more information, refer its @url{https://knot-resolver.readthedocs.org/" "en/stable/daemon.html#configuration, manual}." msgstr "" #. type: deftp #: doc/guix.texi:30819 #, no-wrap msgid "{Data Type} knot-resolver-configuration" msgstr "" #. type: deftp #: doc/guix.texi:30821 msgid "Data type representing the configuration of knot-resolver." msgstr "" #. type: item #: doc/guix.texi:30823 #, no-wrap msgid "@code{package} (default: @var{knot-resolver})" msgstr "" #. type: table #: doc/guix.texi:30825 msgid "Package object of the knot DNS resolver." msgstr "" #. type: item #: doc/guix.texi:30826 #, no-wrap msgid "@code{kresd-config-file} (default: %kresd.conf)" msgstr "" #. type: table #: doc/guix.texi:30829 msgid "" "File-like object of the kresd configuration file to use, by default it will " "listen on @code{127.0.0.1} and @code{::1}." msgstr "" #. type: item #: doc/guix.texi:30830 #, no-wrap msgid "@code{garbage-collection-interval} (default: 1000)" msgstr "" #. type: table #: doc/guix.texi:30832 msgid "" "Number of milliseconds for @code{kres-cache-gc} to periodically trim the " "cache." msgstr "" #. type: subsubheading #: doc/guix.texi:30837 #, no-wrap msgid "Dnsmasq Service" msgstr "" #. type: deffn #: doc/guix.texi:30839 #, no-wrap msgid "{Scheme Variable} dnsmasq-service-type" msgstr "" #. type: deffn #: doc/guix.texi:30842 msgid "" "This is the type of the dnsmasq service, whose value should be an " "@code{dnsmasq-configuration} object as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:30848 #, 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:30851 #, no-wrap msgid "{Data Type} dnsmasq-configuration" msgstr "" #. type: deftp #: doc/guix.texi:30853 msgid "Data type representing the configuration of dnsmasq." msgstr "" #. type: item #: doc/guix.texi:30855 #, no-wrap msgid "@code{package} (default: @var{dnsmasq})" msgstr "" #. type: table #: doc/guix.texi:30857 msgid "Package object of the dnsmasq server." msgstr "" #. type: item #: doc/guix.texi:30858 #, no-wrap msgid "@code{no-hosts?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30860 msgid "When true, don't read the hostnames in /etc/hosts." msgstr "" #. type: item #: doc/guix.texi:30861 #, no-wrap msgid "@code{port} (default: @code{53})" msgstr "" #. type: table #: doc/guix.texi:30864 msgid "" "The port to listen on. Setting this to zero completely disables DNS " "responses, leaving only DHCP and/or TFTP functions." msgstr "" #. type: item #: doc/guix.texi:30865 #, no-wrap msgid "@code{local-service?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:30868 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:30869 #, no-wrap msgid "@code{listen-addresses} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:30871 msgid "Listen on the given IP addresses." msgstr "" #. type: item #: doc/guix.texi:30872 #, no-wrap msgid "@code{resolv-file} (default: @code{\"/etc/resolv.conf\"})" msgstr "" #. type: table #: doc/guix.texi:30874 msgid "The file to read the IP address of the upstream nameservers from." msgstr "" #. type: item #: doc/guix.texi:30875 #, no-wrap msgid "@code{no-resolv?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30877 msgid "When true, don't read @var{resolv-file}." msgstr "" #. type: item #: doc/guix.texi:30878 #, no-wrap msgid "@code{forward-private-reverse-lookup?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:30881 msgid "" "When false, all reverse lookups for private IP ranges are answered with \"no " "such domain\" rather than being forwarded upstream." msgstr "" #. type: item #: doc/guix.texi:30882 #, no-wrap msgid "@code{query-servers-in-order?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30885 msgid "" "When true, dnsmasq queries the servers in the same order as they appear in " "@var{servers}." msgstr "" #. type: item #: doc/guix.texi:30886 #, no-wrap msgid "@code{servers} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:30888 msgid "Specify IP address of upstream servers directly." msgstr "" #. type: item #: doc/guix.texi:30889 #, no-wrap msgid "@code{addresses} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:30893 msgid "" "For each entry, specify an IP address to return for any host in the given " "domains. Queries in the domains are never forwarded and always replied to " "with the specified IP address." msgstr "" #. type: table #: doc/guix.texi:30895 msgid "This is useful for redirecting hosts locally, for example:" msgstr "" #. type: lisp #: doc/guix.texi:30904 #, no-wrap msgid "" "(service dnsmasq-service-type\n" " (dnsmasq-configuration\n" " (addresses\n" " '(; Redirect to a local web-server.\n" " \"/example.org/127.0.0.1\"\n" " ; Redirect subdomain to a specific IP.\n" " \"/subdomain.example.org/192.168.1.42\"))))\n" msgstr "" #. type: table #: doc/guix.texi:30907 msgid "Note that rules in @file{/etc/hosts} take precedence over this." msgstr "" #. type: item #: doc/guix.texi:30908 #, no-wrap msgid "@code{cache-size} (default: @code{150})" msgstr "" #. type: table #: doc/guix.texi:30911 msgid "" "Set the size of dnsmasq's cache. Setting the cache size to zero disables " "caching." msgstr "" #. type: item #: doc/guix.texi:30912 #, no-wrap msgid "@code{negative-cache?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:30914 msgid "When false, disable negative caching." msgstr "" #. type: item #: doc/guix.texi:30915 #, no-wrap msgid "@code{cpe-id} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30918 msgid "" "If set, add a CPE (Customer-Premises Equipment) identifier to DNS queries " "which are forwarded upstream." msgstr "" #. type: item #: doc/guix.texi:30919 #, no-wrap msgid "@code{tftp-enable?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30921 msgid "Whether to enable the built-in TFTP server." msgstr "" #. type: item #: doc/guix.texi:30922 #, no-wrap msgid "@code{tftp-no-fail?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30924 msgid "If true, does not fail dnsmasq if the TFTP server could not start up." msgstr "" #. type: item #: doc/guix.texi:30925 #, no-wrap msgid "@code{tftp-single-port?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30927 msgid "Whether to use only one single port for TFTP." msgstr "" #. type: item #: doc/guix.texi:30928 #, no-wrap msgid "@code{tftp-secure?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30930 msgid "" "If true, only files owned by the user running the dnsmasq process are " "accessible." msgstr "" #. type: table #: doc/guix.texi:30934 msgid "" "If dnsmasq is being run as root, different rules apply: @code{tftp-secure?} " "has no effect, but only files which have the world-readable bit set are " "accessible." msgstr "" #. type: item #: doc/guix.texi:30935 #, no-wrap msgid "@code{tftp-max} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30937 msgid "If set, sets the maximal number of concurrent connections allowed." msgstr "" #. type: item #: doc/guix.texi:30938 #, no-wrap msgid "@code{tftp-mtu} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30940 msgid "If set, sets the MTU for TFTP packets to that value." msgstr "" #. type: item #: doc/guix.texi:30941 #, no-wrap msgid "@code{tftp-no-blocksize?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30943 msgid "" "If true, stops the TFTP server from negotiating the blocksize with a client." msgstr "" #. type: item #: doc/guix.texi:30944 #, no-wrap msgid "@code{tftp-lowercase?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30946 msgid "Whether to convert all filenames in TFTP requests to lowercase." msgstr "" #. type: item #: doc/guix.texi:30947 #, no-wrap msgid "@code{tftp-port-range} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30950 msgid "" "If set, fixes the dynamical ports (one per client) to the given range " "(@code{\",\"})." msgstr "" #. type: item #: doc/guix.texi:30951 #, no-wrap msgid "@code{tftp-root} (default: @code{/var/empty,lo})" msgstr "" #. type: table #: doc/guix.texi:30958 msgid "" "Look for files to transfer using TFTP relative to the given directory. When " "this is set, TFTP paths which include @samp{..} are rejected, to stop " "clients getting outside the specified root. Absolute paths (starting with " "@samp{/}) are allowed, but they must be within the TFTP-root. If the " "optional interface argument is given, the directory is only used for TFTP " "requests via that interface." msgstr "" #. type: item #: doc/guix.texi:30959 #, no-wrap msgid "@code{tftp-unique-root} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:30964 msgid "" "If set, add the IP or hardware address of the TFTP client as a path " "component on the end of the TFTP-root. Only valid if a TFTP root is set and " "the directory exists. Defaults to adding IP address (in standard dotted-" "quad format)." msgstr "" #. type: table #: doc/guix.texi:30973 msgid "" "For instance, if @option{--tftp-root} is @samp{/tftp} and client " "@samp{1.2.3.4} requests file @file{myfile} then the effective path will be " "@file{/tftp/1.2.3.4/myfile} if @file{/tftp/1.2.3.4} exists or @file{/tftp/" "myfile} otherwise. When @samp{=mac} is specified it will append the MAC " "address instead, using lowercase zero padded digits separated by dashes, e." "g.: @samp{01-02-03-04-aa-bb}. Note that resolving MAC addresses is only " "possible if the client is in the local network or obtained a DHCP lease from " "dnsmasq." msgstr "" #. type: subsubheading #: doc/guix.texi:30977 #, no-wrap msgid "ddclient Service" msgstr "" #. type: cindex #: doc/guix.texi:30979 #, no-wrap msgid "ddclient" msgstr "" #. type: Plain text #: doc/guix.texi:30983 msgid "" "The ddclient service described below runs the ddclient daemon, which takes " "care of automatically updating DNS entries for service providers such as " "@uref{https://dyn.com/dns/, Dyn}." msgstr "" #. type: Plain text #: doc/guix.texi:30986 msgid "" "The following example show instantiates the service with its default " "configuration:" msgstr "" #. type: lisp #: doc/guix.texi:30989 #, no-wrap msgid "(service ddclient-service-type)\n" msgstr "" #. type: Plain text #: doc/guix.texi:30998 msgid "" "Note that ddclient needs to access credentials that are stored in a " "@dfn{secret file}, by default @file{/etc/ddclient/secrets} (see @code{secret-" "file} below). You are expected to create this file manually, in an ``out-of-" "band'' fashion (you @emph{could} make this file part of the service " "configuration, for instance by using @code{plain-file}, but it will be world-" "readable @i{via} @file{/gnu/store}). See the examples in the @file{share/" "ddclient} directory of the @code{ddclient} package." msgstr "" #. type: Plain text #: doc/guix.texi:31002 msgid "Available @code{ddclient-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:31003 #, no-wrap msgid "{@code{ddclient-configuration} parameter} package ddclient" msgstr "" #. type: deftypevr #: doc/guix.texi:31005 msgid "The ddclient package." msgstr "" #. type: deftypevr #: doc/guix.texi:31008 #, no-wrap msgid "{@code{ddclient-configuration} parameter} integer daemon" msgstr "" #. type: deftypevr #: doc/guix.texi:31010 msgid "The period after which ddclient will retry to check IP and domain name." msgstr "" #. type: deftypevr #: doc/guix.texi:31012 msgid "Defaults to @samp{300}." msgstr "" #. type: deftypevr #: doc/guix.texi:31015 #, no-wrap msgid "{@code{ddclient-configuration} parameter} boolean syslog" msgstr "" #. type: deftypevr #: doc/guix.texi:31017 msgid "Use syslog for the output." msgstr "" #. type: deftypevr #: doc/guix.texi:31022 #, no-wrap msgid "{@code{ddclient-configuration} parameter} string mail" msgstr "" #. type: deftypevr #: doc/guix.texi:31024 msgid "Mail to user." msgstr "" #. type: deftypevr #: doc/guix.texi:31026 doc/guix.texi:31033 doc/guix.texi:33010 msgid "Defaults to @samp{\"root\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:31029 #, no-wrap msgid "{@code{ddclient-configuration} parameter} string mail-failure" msgstr "" #. type: deftypevr #: doc/guix.texi:31031 msgid "Mail failed update to user." msgstr "" #. type: deftypevr #: doc/guix.texi:31036 #, no-wrap msgid "{@code{ddclient-configuration} parameter} string pid" msgstr "" #. type: deftypevr #: doc/guix.texi:31038 msgid "The ddclient PID file." msgstr "" #. type: deftypevr #: doc/guix.texi:31040 msgid "Defaults to @samp{\"/var/run/ddclient/ddclient.pid\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:31043 #, no-wrap msgid "{@code{ddclient-configuration} parameter} boolean ssl" msgstr "" #. type: deftypevr #: doc/guix.texi:31045 msgid "Enable SSL support." msgstr "" #. type: deftypevr #: doc/guix.texi:31050 #, no-wrap msgid "{@code{ddclient-configuration} parameter} string user" msgstr "" #. type: deftypevr #: doc/guix.texi:31053 msgid "" "Specifies the user name or ID that is used when running ddclient program." msgstr "" #. type: deftypevr #: doc/guix.texi:31055 doc/guix.texi:31062 msgid "Defaults to @samp{\"ddclient\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:31058 #, no-wrap msgid "{@code{ddclient-configuration} parameter} string group" msgstr "" #. type: deftypevr #: doc/guix.texi:31060 msgid "Group of the user who will run the ddclient program." msgstr "" #. type: deftypevr #: doc/guix.texi:31065 #, no-wrap msgid "{@code{ddclient-configuration} parameter} string secret-file" msgstr "" #. type: deftypevr #: doc/guix.texi:31069 msgid "" "Secret file which will be appended to @file{ddclient.conf} file. This file " "contains credentials for use by ddclient. You are expected to create it " "manually." msgstr "" #. type: deftypevr #: doc/guix.texi:31071 msgid "Defaults to @samp{\"/etc/ddclient/secrets.conf\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:31074 #, no-wrap msgid "{@code{ddclient-configuration} parameter} list extra-options" msgstr "" #. type: deftypevr #: doc/guix.texi:31076 msgid "Extra options will be appended to @file{ddclient.conf} file." msgstr "" #. type: cindex #: doc/guix.texi:31086 #, no-wrap msgid "VNC (virtual network computing)" msgstr "" #. type: cindex #: doc/guix.texi:31087 #, no-wrap msgid "XDMCP (x display manager control protocol)" msgstr "" #. type: Plain text #: doc/guix.texi:31096 msgid "" "The @code{(gnu services vnc)} module provides services related to " "@dfn{Virtual Network Computing} (VNC), which makes it possible to locally " "use graphical Xorg applications running on a remote machine. Combined with " "a graphical manager that supports the @dfn{X Display Manager Control " "Protocol}, such as GDM (@pxref{gdm}) or LightDM (@pxref{lightdm}), it is " "possible to remote an entire desktop for a multi-user environment." msgstr "" #. type: subsubheading #: doc/guix.texi:31097 #, no-wrap msgid "Xvnc" msgstr "" #. type: Plain text #: doc/guix.texi:31102 msgid "" "Xvnc is a VNC server that spawns its own X window server; which means it can " "run on headless servers. The Xvnc implementations provided by the " "@code{tigervnc-server} and @code{turbovnc} aim to be fast and efficient." msgstr "" #. type: defvar #: doc/guix.texi:31103 #, no-wrap msgid "{Scheme Variable} xvnc-service-type" msgstr "" #. type: defvar #: doc/guix.texi:31109 msgid "" "The @code{xvnc-server-type} service can be configured via the @code{xvnc-" "configuration} record, documented below. A second virtual display could be " "made available on a remote machine via the following configuration:" msgstr "" #. type: lisp #: doc/guix.texi:31114 #, no-wrap msgid "" "(service xvnc-service-type\n" " (xvnc-configuration (display-number 10)))\n" msgstr "" #. type: Plain text #: doc/guix.texi:31119 msgid "" "As a demonstration, the @command{xclock} command could then be started on " "the remote machine on display number 10, and it could be displayed locally " "via the @command{vncviewer} command:" msgstr "" #. type: example #: doc/guix.texi:31124 #, no-wrap msgid "" "# Start xclock on the remote machine.\n" "ssh -L5910:localhost:5910 -- guix shell xclock -- env DISPLAY=:10 xclock\n" "# Access it via VNC.\n" "guix shell tigervnc-client -- vncviewer localhost:5910\n" msgstr "" #. type: Plain text #: doc/guix.texi:31129 msgid "" "The following configuration combines XDMCP and Inetd to allow multiple users " "to concurrently use the remote system, login in graphically via the GDM " "display manager:" msgstr "" #. type: lisp #: doc/guix.texi:31145 #, no-wrap msgid "" "(operating-system\n" " [...]\n" " (services (cons*\n" " [...]\n" " (service xvnc-service-type (xvnc-configuration\n" " (display-number 5)\n" " (localhost? #f)\n" " (xdmcp? #t)\n" " (inetd? #t)))\n" " (modify-services %desktop-services\n" " (gdm-service-type config => (gdm-configuration\n" " (inherit config)\n" " (auto-suspend? #f)\n" " (xdmcp? #t)))))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:31150 msgid "" "A remote user could then connect to it by using the @command{vncviewer} " "command or a compatible VNC client and start a desktop session of their " "choosing:" msgstr "" #. type: example #: doc/guix.texi:31152 #, no-wrap msgid "vncviewer remote-host:5905\n" msgstr "" #. type: quotation #: doc/guix.texi:31162 msgid "" "Unless your machine is in a controlled environment, for security reasons, " "the @code{localhost?} configuration of the @code{xvnc-configuration} record " "should be left to its default @code{#t} value and exposed via a secure means " "such as an SSH port forward. The XDMCP port, UDP 177 should also be blocked " "from the outside by a firewall, as it is not a secure protocol and can " "expose login credentials in clear." msgstr "" #. type: deftp #: doc/guix.texi:31167 #, no-wrap msgid "{Data Type} xvnc-configuration" msgstr "" #. type: deftp #: doc/guix.texi:31169 msgid "Available @code{xvnc-configuration} fields are:" msgstr "" #. type: item #: doc/guix.texi:31171 #, no-wrap msgid "@code{xvnc} (default: @code{tigervnc-server}) (type: file-like)" msgstr "" #. type: table #: doc/guix.texi:31173 msgid "The package that provides the Xvnc binary." msgstr "" #. type: item #: doc/guix.texi:31174 #, no-wrap msgid "@code{display-number} (default: @code{0}) (type: number)" msgstr "" #. type: table #: doc/guix.texi:31177 msgid "" "The display number used by Xvnc. You should set this to a number not " "already used a Xorg server." msgstr "" #. type: item #: doc/guix.texi:31178 #, no-wrap msgid "@code{geometry} (default: @code{\"1024x768\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:31180 msgid "The size of the desktop to be created." msgstr "" #. type: item #: doc/guix.texi:31181 #, no-wrap msgid "@code{depth} (default: @code{24}) (type: color-depth)" msgstr "" #. type: table #: doc/guix.texi:31184 msgid "" "The pixel depth in bits of the desktop to be created. Accepted values are " "16, 24 or 32." msgstr "" #. type: item #: doc/guix.texi:31185 #, no-wrap msgid "@code{port} (type: maybe-port)" msgstr "" #. type: table #: doc/guix.texi:31188 msgid "" "The port on which to listen for connections from viewers. When left " "unspecified, it defaults to 5900 plus the display number." msgstr "" #. type: item #: doc/guix.texi:31189 #, no-wrap msgid "@code{ipv4?} (default: @code{#t}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:31191 msgid "Use IPv4 for incoming and outgoing connections." msgstr "" #. type: item #: doc/guix.texi:31192 #, no-wrap msgid "@code{ipv6?} (default: @code{#t}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:31194 msgid "Use IPv6 for incoming and outgoing connections." msgstr "" #. type: item #: doc/guix.texi:31195 #, no-wrap msgid "@code{password-file} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:31198 msgid "" "The password file to use, if any. Refer to vncpasswd(1) to learn how to " "generate such a file." msgstr "" #. type: table #: doc/guix.texi:31205 msgid "" "Query the XDMCP server for a session. This enables users to log in a " "desktop session from the login manager screen. For a multiple users " "scenario, you'll want to enable the @code{inetd?} option as well, so that " "each connection to the VNC server is handled separately rather than shared." msgstr "" #. type: item #: doc/guix.texi:31206 #, no-wrap msgid "@code{inetd?} (default: @code{#f}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:31208 msgid "Use an Inetd-style service, which runs the Xvnc server on demand." msgstr "" #. type: item #: doc/guix.texi:31209 #, no-wrap msgid "@code{frame-rate} (default: @code{60}) (type: number)" msgstr "" #. type: table #: doc/guix.texi:31211 msgid "The maximum number of updates per second sent to each client." msgstr "" #. type: item #: doc/guix.texi:31212 #, no-wrap msgid "@code{security-types} (default: @code{(\"None\")}) (type: security-types)" msgstr "" #. type: table #: doc/guix.texi:31218 msgid "" "The allowed security schemes to use for incoming connections. The default " "is \"None\", which is safe given that Xvnc is configured to authenticate the " "user via the display manager, and only for local connections. Accepted " "values are any of the following: (\"None\" \"VncAuth\" \"Plain\" \"TLSNone\" " "\"TLSVnc\" \"TLSPlain\" \"X509None\" \"X509Vnc\")" msgstr "" #. type: item #: doc/guix.texi:31219 #, no-wrap msgid "@code{localhost?} (default: @code{#t}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:31223 msgid "" "Only allow connections from the same machine. It is set to #true by default " "for security, which means SSH or another secure means should be used to " "expose the remote port." msgstr "" #. type: item #: doc/guix.texi:31224 #, no-wrap msgid "@code{log-level} (default: @code{30}) (type: log-level)" msgstr "" #. type: table #: doc/guix.texi:31227 msgid "" "The log level, a number between 0 and 100, 100 meaning most verbose output. " "The log messages are output to syslog." msgstr "" #. type: item #: doc/guix.texi:31228 #, no-wrap msgid "@code{extra-options} (default: @code{()}) (type: strings)" msgstr "" #. type: table #: doc/guix.texi:31231 msgid "" "This can be used to provide extra Xvnc options not exposed via this record." msgstr "" #. type: cindex #: doc/guix.texi:31239 #, no-wrap msgid "VPN (virtual private network)" msgstr "" #. type: cindex #: doc/guix.texi:31240 #, no-wrap msgid "virtual private network (VPN)" msgstr "" #. type: Plain text #: doc/guix.texi:31244 msgid "" "The @code{(gnu services vpn)} module provides services related to " "@dfn{virtual private networks} (VPNs)." msgstr "" #. type: subsubheading #: doc/guix.texi:31245 #, no-wrap msgid "Bitmask" msgstr "" #. type: defvr #: doc/guix.texi:31247 #, no-wrap msgid "{Scheme Variable} bitmask-service-type" msgstr "" #. type: defvr #: doc/guix.texi:31252 msgid "" "A service type for the @uref{https://bitmask.net, Bitmask} VPN client. It " "makes the client available in the system and loads its polkit policy. " "Please note that the client expects an active polkit-agent, which is either " "run by your desktop-environment or should be run manually." msgstr "" #. type: subsubheading #: doc/guix.texi:31254 #, no-wrap msgid "OpenVPN" msgstr "" #. type: Plain text #: doc/guix.texi:31258 msgid "" "It provides a @emph{client} service for your machine to connect to a VPN, " "and a @emph{server} service for your machine to host a VPN@." msgstr "" #. type: deffn #: doc/guix.texi:31259 #, no-wrap msgid "{Scheme Procedure} openvpn-client-service @" msgstr "" #. type: deffn #: doc/guix.texi:31261 msgid "[#:config (openvpn-client-configuration)]" msgstr "" #. type: deffn #: doc/guix.texi:31263 msgid "" "Return a service that runs @command{openvpn}, a VPN daemon, as a client." msgstr "" #. type: deffn #: doc/guix.texi:31265 #, no-wrap msgid "{Scheme Procedure} openvpn-server-service @" msgstr "" #. type: deffn #: doc/guix.texi:31267 msgid "[#:config (openvpn-server-configuration)]" msgstr "" #. type: deffn #: doc/guix.texi:31269 msgid "" "Return a service that runs @command{openvpn}, a VPN daemon, as a server." msgstr "" #. type: deffn #: doc/guix.texi:31271 msgid "Both can be run simultaneously." msgstr "" #. type: deftp #: doc/guix.texi:31275 #, no-wrap msgid "{Data Type} openvpn-client-configuration" msgstr "" #. type: deftp #: doc/guix.texi:31277 msgid "Available @code{openvpn-client-configuration} fields are:" msgstr "" #. type: item #: doc/guix.texi:31279 doc/guix.texi:31367 #, no-wrap msgid "@code{openvpn} (default: @code{openvpn}) (type: file-like)" msgstr "" #. type: table #: doc/guix.texi:31281 doc/guix.texi:31369 msgid "The OpenVPN package." msgstr "" #. type: item #: doc/guix.texi:31282 doc/guix.texi:31370 #, no-wrap msgid "@code{pid-file} (default: @code{\"/var/run/openvpn/openvpn.pid\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:31284 doc/guix.texi:31372 msgid "The OpenVPN pid file." msgstr "" #. type: item #: doc/guix.texi:31285 doc/guix.texi:31373 #, no-wrap msgid "@code{proto} (default: @code{udp}) (type: proto)" msgstr "" #. type: table #: doc/guix.texi:31288 doc/guix.texi:31376 msgid "" "The protocol (UDP or TCP) used to open a channel between clients and servers." msgstr "" #. type: item #: doc/guix.texi:31289 doc/guix.texi:31377 #, no-wrap msgid "@code{dev} (default: @code{tun}) (type: dev)" msgstr "" #. type: table #: doc/guix.texi:31291 doc/guix.texi:31379 msgid "The device type used to represent the VPN connection." msgstr "" #. type: item #: doc/guix.texi:31292 doc/guix.texi:31380 #, no-wrap msgid "@code{ca} (default: @code{\"/etc/openvpn/ca.crt\"}) (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:31294 doc/guix.texi:31382 msgid "The certificate authority to check connections against." msgstr "" #. type: item #: doc/guix.texi:31295 doc/guix.texi:31383 #, no-wrap msgid "@code{cert} (default: @code{\"/etc/openvpn/client.crt\"}) (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:31298 doc/guix.texi:31386 msgid "" "The certificate of the machine the daemon is running on. It should be " "signed by the authority given in @code{ca}." msgstr "" #. type: item #: doc/guix.texi:31299 doc/guix.texi:31387 #, no-wrap msgid "@code{key} (default: @code{\"/etc/openvpn/client.key\"}) (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:31302 doc/guix.texi:31390 msgid "" "The key of the machine the daemon is running on. It must be the key whose " "certificate is @code{cert}." msgstr "" #. type: item #: doc/guix.texi:31303 doc/guix.texi:31391 #, no-wrap msgid "@code{comp-lzo?} (default: @code{#t}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:31305 doc/guix.texi:31393 msgid "Whether to use the lzo compression algorithm." msgstr "" #. type: item #: doc/guix.texi:31306 doc/guix.texi:31394 #, no-wrap msgid "@code{persist-key?} (default: @code{#t}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:31308 doc/guix.texi:31396 msgid "Don't re-read key files across SIGUSR1 or --ping-restart." msgstr "" #. type: item #: doc/guix.texi:31309 doc/guix.texi:31397 #, no-wrap msgid "@code{persist-tun?} (default: @code{#t}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:31312 doc/guix.texi:31400 msgid "" "Don't close and reopen TUN/TAP device or run up/down scripts across SIGUSR1 " "or --ping-restart restarts." msgstr "" #. type: item #: doc/guix.texi:31313 doc/guix.texi:31401 #, no-wrap msgid "@code{fast-io?} (default: @code{#f}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:31316 doc/guix.texi:31404 msgid "" "(Experimental) Optimize TUN/TAP/UDP I/O writes by avoiding a call to poll/" "epoll/select prior to the write operation." msgstr "" #. type: item #: doc/guix.texi:31317 doc/guix.texi:31405 #, no-wrap msgid "@code{verbosity} (default: @code{3}) (type: number)" msgstr "" #. type: table #: doc/guix.texi:31319 doc/guix.texi:31407 msgid "Verbosity level." msgstr "" #. type: item #: doc/guix.texi:31320 #, no-wrap msgid "@code{tls-auth} (default: @code{#f}) (type: tls-auth-client)" msgstr "" #. type: table #: doc/guix.texi:31323 doc/guix.texi:31411 msgid "" "Add an additional layer of HMAC authentication on top of the TLS control " "channel to protect against DoS attacks." msgstr "" #. type: item #: doc/guix.texi:31324 #, no-wrap msgid "@code{auth-user-pass} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:31328 msgid "" "Authenticate with server using username/password. The option is a file " "containing username/password on 2 lines. Do not use a file-like object as " "it would be added to the store and readable by any user." msgstr "" #. type: item #: doc/guix.texi:31329 #, no-wrap msgid "@code{verify-key-usage?} (default: @code{#t}) (type: key-usage)" msgstr "" #. type: table #: doc/guix.texi:31331 msgid "Whether to check the server certificate has server usage extension." msgstr "" #. type: item #: doc/guix.texi:31332 #, no-wrap msgid "@code{bind?} (default: @code{#f}) (type: bind)" msgstr "" #. type: table #: doc/guix.texi:31334 msgid "Bind to a specific local port number." msgstr "" #. type: item #: doc/guix.texi:31335 #, no-wrap msgid "@code{resolv-retry?} (default: @code{#t}) (type: resolv-retry)" msgstr "" #. type: table #: doc/guix.texi:31337 msgid "Retry resolving server address." msgstr "" #. type: item #: doc/guix.texi:31338 #, no-wrap msgid "@code{remote} (default: @code{()}) (type: openvpn-remote-list)" msgstr "" #. type: table #: doc/guix.texi:31340 msgid "A list of remote servers to connect to." msgstr "" #. type: deftp #: doc/guix.texi:31341 #, no-wrap msgid "{Data Type} openvpn-remote-configuration" msgstr "" #. type: deftp #: doc/guix.texi:31343 msgid "Available @code{openvpn-remote-configuration} fields are:" msgstr "" #. type: item #: doc/guix.texi:31345 #, no-wrap msgid "@code{name} (default: @code{\"my-server\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:31347 msgid "Server name." msgstr "" #. type: item #: doc/guix.texi:31348 doc/guix.texi:31412 #, no-wrap msgid "@code{port} (default: @code{1194}) (type: number)" msgstr "" #. type: table #: doc/guix.texi:31350 msgid "Port number the server listens to." msgstr "" #. type: deftp #: doc/guix.texi:31363 #, no-wrap msgid "{Data Type} openvpn-server-configuration" msgstr "" #. type: deftp #: doc/guix.texi:31365 msgid "Available @code{openvpn-server-configuration} fields are:" msgstr "" #. type: item #: doc/guix.texi:31408 #, no-wrap msgid "@code{tls-auth} (default: @code{#f}) (type: tls-auth-server)" msgstr "" #. type: table #: doc/guix.texi:31414 msgid "Specifies the port number on which the server listens." msgstr "" #. type: item #: doc/guix.texi:31415 #, no-wrap msgid "@code{server} (default: @code{\"10.8.0.0 255.255.255.0\"}) (type: ip-mask)" msgstr "" #. type: table #: doc/guix.texi:31417 msgid "An ip and mask specifying the subnet inside the virtual network." msgstr "" #. type: item #: doc/guix.texi:31418 #, no-wrap msgid "@code{server-ipv6} (default: @code{#f}) (type: cidr6)" msgstr "" #. type: table #: doc/guix.texi:31420 msgid "A CIDR notation specifying the IPv6 subnet inside the virtual network." msgstr "" #. type: item #: doc/guix.texi:31421 #, no-wrap msgid "@code{dh} (default: @code{\"/etc/openvpn/dh2048.pem\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:31423 msgid "The Diffie-Hellman parameters file." msgstr "" #. type: item #: doc/guix.texi:31424 #, no-wrap msgid "@code{ifconfig-pool-persist} (default: @code{\"/etc/openvpn/ipp.txt\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:31426 msgid "The file that records client IPs." msgstr "" #. type: item #: doc/guix.texi:31427 #, no-wrap msgid "@code{redirect-gateway?} (default: @code{#f}) (type: gateway)" msgstr "" #. type: table #: doc/guix.texi:31429 msgid "When true, the server will act as a gateway for its clients." msgstr "" #. type: item #: doc/guix.texi:31430 #, no-wrap msgid "@code{client-to-client?} (default: @code{#f}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:31432 msgid "When true, clients are allowed to talk to each other inside the VPN." msgstr "" #. type: item #: doc/guix.texi:31433 #, no-wrap msgid "@code{keepalive} (default: @code{(10 120)}) (type: keepalive)" msgstr "" #. type: table #: doc/guix.texi:31439 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: item #: doc/guix.texi:31440 #, no-wrap msgid "@code{max-clients} (default: @code{100}) (type: number)" msgstr "" #. type: table #: doc/guix.texi:31442 msgid "The maximum number of clients." msgstr "" #. type: item #: doc/guix.texi:31443 #, no-wrap msgid "@code{status} (default: @code{\"/var/run/openvpn/status\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:31446 msgid "" "The status file. This file shows a small report on current connection. It " "is truncated and rewritten every minute." msgstr "" #. type: item #: doc/guix.texi:31447 #, no-wrap msgid "@code{client-config-dir} (default: @code{()}) (type: openvpn-ccd-list)" msgstr "" #. type: table #: doc/guix.texi:31449 msgid "The list of configuration for some clients." msgstr "" #. type: subheading #: doc/guix.texi:31456 #, no-wrap msgid "strongSwan" msgstr "" #. type: Plain text #: doc/guix.texi:31460 msgid "" "Currently, the strongSwan service only provides legacy-style configuration " "with @file{ipsec.conf} and @file{ipsec.secrets} files." msgstr "" #. type: defvr #: doc/guix.texi:31461 #, no-wrap msgid "{Scheme Variable} strongswan-service-type" msgstr "" #. type: defvr #: doc/guix.texi:31465 msgid "" "A service type for configuring strongSwan for IPsec @acronym{VPN, Virtual " "Private Networking}. Its value must be a @code{strongswan-configuration} " "record as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:31471 #, no-wrap msgid "" "(service strongswan-service-type\n" " (strongswan-configuration\n" " (ipsec-conf \"/etc/ipsec.conf\")\n" " (ipsec-secrets \"/etc/ipsec.secrets\")))\n" msgstr "" #. type: deftp #: doc/guix.texi:31475 #, no-wrap msgid "{Data Type} strongswan-configuration" msgstr "" #. type: deftp #: doc/guix.texi:31477 msgid "Data type representing the configuration of the StrongSwan service." msgstr "" #. type: code{#1} #: doc/guix.texi:31479 #, no-wrap msgid "strongswan" msgstr "" #. type: table #: doc/guix.texi:31481 msgid "The strongSwan package to use for this service." msgstr "" #. type: item #: doc/guix.texi:31482 #, no-wrap msgid "@code{ipsec-conf} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:31485 msgid "" "The file name of your @file{ipsec.conf}. If not @code{#f}, then this and " "@code{ipsec-secrets} must both be strings." msgstr "" #. type: item #: doc/guix.texi:31486 #, no-wrap msgid "@code{ipsec-secrets} (default @code{#f})" msgstr "" #. type: table #: doc/guix.texi:31489 msgid "" "The file name of your @file{ipsec.secrets}. If not @code{#f}, then this and " "@code{ipsec-conf} must both be strings." msgstr "" #. type: subsubheading #: doc/guix.texi:31493 #, no-wrap msgid "Wireguard" msgstr "" #. type: defvr #: doc/guix.texi:31495 #, no-wrap msgid "{Scheme Variable} wireguard-service-type" msgstr "" #. type: defvr #: doc/guix.texi:31498 msgid "" "A service type for a Wireguard tunnel interface. Its value must be a " "@code{wireguard-configuration} record as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:31509 #, no-wrap msgid "" "(service wireguard-service-type\n" " (wireguard-configuration\n" " (peers\n" " (list\n" " (wireguard-peer\n" " (name \"my-peer\")\n" " (endpoint \"my.wireguard.com:51820\")\n" " (public-key \"hzpKg9X1yqu1axN6iJp0mWf6BZGo8m1wteKwtTmDGF4=\")\n" " (allowed-ips '(\"10.0.0.2/32\")))))))\n" msgstr "" #. type: deftp #: doc/guix.texi:31513 #, no-wrap msgid "{Data Type} wireguard-configuration" msgstr "" #. type: deftp #: doc/guix.texi:31515 msgid "Data type representing the configuration of the Wireguard service." msgstr "" #. type: code{#1} #: doc/guix.texi:31517 #, no-wrap msgid "wireguard" msgstr "" #. type: table #: doc/guix.texi:31519 msgid "The wireguard package to use for this service." msgstr "" #. type: item #: doc/guix.texi:31520 #, no-wrap msgid "@code{interface} (default: @code{\"wg0\"})" msgstr "" #. type: table #: doc/guix.texi:31522 msgid "The interface name for the VPN." msgstr "" #. type: item #: doc/guix.texi:31523 #, no-wrap msgid "@code{addresses} (default: @code{'(\"10.0.0.1/32\")})" msgstr "" #. type: table #: doc/guix.texi:31525 msgid "The IP addresses to be assigned to the above interface." msgstr "" #. type: item #: doc/guix.texi:31526 #, no-wrap msgid "@code{port} (default: @code{51820})" msgstr "" #. type: table #: doc/guix.texi:31528 msgid "The port on which to listen for incoming connections." msgstr "" #. type: item #: doc/guix.texi:31529 #, no-wrap msgid "@code{dns} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:31531 msgid "The DNS server(s) to announce to VPN clients via DHCP." msgstr "" #. type: item #: doc/guix.texi:31532 #, no-wrap msgid "@code{private-key} (default: @code{\"/etc/wireguard/private.key\"})" msgstr "" #. type: table #: doc/guix.texi:31535 msgid "" "The private key file for the interface. It is automatically generated if " "the file does not exist." msgstr "" #. type: item #: doc/guix.texi:31536 #, no-wrap msgid "@code{peers} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:31539 msgid "" "The authorized peers on this interface. This is a list of @var{wireguard-" "peer} records." msgstr "" #. type: item #: doc/guix.texi:31540 #, no-wrap msgid "@code{pre-up} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:31542 msgid "The script commands to be run before setting up the interface." msgstr "" #. type: item #: doc/guix.texi:31543 #, no-wrap msgid "@code{post-up} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:31545 msgid "The script commands to be run after setting up the interface." msgstr "" #. type: item #: doc/guix.texi:31546 #, no-wrap msgid "@code{pre-down} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:31548 msgid "The script commands to be run before tearing down the interface." msgstr "" #. type: item #: doc/guix.texi:31549 #, no-wrap msgid "@code{post-down} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:31551 msgid "The script commands to be run after tearing down the interface." msgstr "" #. type: item #: doc/guix.texi:31552 #, no-wrap msgid "@code{table} (default: @code{\"auto\"})" msgstr "" #. type: table #: doc/guix.texi:31557 msgid "" "The routing table to which routes are added, as a string. There are two " "special values: @code{\"off\"} that disables the creation of routes " "altogether, and @code{\"auto\"} (the default) that adds routes to the " "default table and enables special handling of default routes." msgstr "" #. type: deftp #: doc/guix.texi:31561 #, no-wrap msgid "{Data Type} wireguard-peer" msgstr "" #. type: deftp #: doc/guix.texi:31563 msgid "Data type representing a Wireguard peer attached to a given interface." msgstr "" #. type: table #: doc/guix.texi:31567 msgid "The peer name." msgstr "" #. type: item #: doc/guix.texi:31568 #, no-wrap msgid "@code{endpoint} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:31571 msgid "" "The optional endpoint for the peer, such as @code{\"demo.wireguard." "com:51820\"}." msgstr "" #. type: itemx #: doc/guix.texi:31572 doc/guix.texi:32119 doc/guix.texi:32156 #: doc/guix.texi:37722 #, no-wrap msgid "public-key" msgstr "" #. type: table #: doc/guix.texi:31574 msgid "The peer public-key represented as a base64 string." msgstr "" #. type: code{#1} #: doc/guix.texi:31575 #, no-wrap msgid "allowed-ips" msgstr "" #. type: table #: doc/guix.texi:31578 msgid "" "A list of IP addresses from which incoming traffic for this peer is allowed " "and to which incoming traffic for this peer is directed." msgstr "" #. type: item #: doc/guix.texi:31579 #, no-wrap msgid "@code{keep-alive} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:31584 msgid "" "An optional time interval in seconds. A packet will be sent to the server " "endpoint once per time interval. This helps receiving incoming connections " "from this peer when you are behind a NAT or a firewall." msgstr "" #. type: cindex #: doc/guix.texi:31590 #, no-wrap msgid "NFS" msgstr "" #. type: Plain text #: doc/guix.texi:31595 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: Plain text #: doc/guix.texi:31599 msgid "" "While it is possible to use the individual components that together make up " "a Network File System service, we recommended to configure an NFS server " "with the @code{nfs-service-type}." msgstr "" #. type: subsubheading #: doc/guix.texi:31600 #, no-wrap msgid "NFS Service" msgstr "" #. type: cindex #: doc/guix.texi:31601 #, no-wrap msgid "NFS, server" msgstr "" #. type: Plain text #: doc/guix.texi:31606 msgid "" "The NFS service takes care of setting up all NFS component services, kernel " "configuration file systems, and installs configuration files in the " "locations that NFS expects." msgstr "" #. type: defvr #: doc/guix.texi:31607 #, no-wrap msgid "{Scheme Variable} nfs-service-type" msgstr "" #. type: defvr #: doc/guix.texi:31609 msgid "A service type for a complete NFS server." msgstr "" #. type: deftp #: doc/guix.texi:31611 #, no-wrap msgid "{Data Type} nfs-configuration" msgstr "" #. type: deftp #: doc/guix.texi:31614 msgid "" "This data type represents the configuration of the NFS service and all of " "its subsystems." msgstr "" #. type: deftp #: doc/guix.texi:31616 msgid "It has the following parameters:" msgstr "" #. type: item #: doc/guix.texi:31617 doc/guix.texi:31742 doc/guix.texi:31767 #, no-wrap msgid "@code{nfs-utils} (default: @code{nfs-utils})" msgstr "" #. type: table #: doc/guix.texi:31619 msgid "The nfs-utils package to use." msgstr "" #. type: item #: doc/guix.texi:31620 #, no-wrap msgid "@code{nfs-versions} (default: @code{'(\"4.2\" \"4.1\" \"4.0\")})" msgstr "" #. type: table #: doc/guix.texi:31623 msgid "" "If a list of string values is provided, the @command{rpc.nfsd} daemon will " "be limited to supporting the given versions of the NFS protocol." msgstr "" #. type: item #: doc/guix.texi:31624 #, no-wrap msgid "@code{exports} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:31629 msgid "" "This is a list of directories the NFS server should export. Each entry is a " "list consisting of two elements: a directory name and a string containing " "all options. This is an example in which the directory @file{/export} is " "served to all NFS clients as a read-only share:" msgstr "" #. type: lisp #: doc/guix.texi:31635 #, no-wrap msgid "" "(nfs-configuration\n" " (exports\n" " '((\"/export\"\n" " \"*(ro,insecure,no_subtree_check,crossmnt,fsid=0)\"))))\n" msgstr "" #. type: item #: doc/guix.texi:31637 #, no-wrap msgid "@code{rpcmountd-port} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:31639 msgid "The network port that the @command{rpc.mountd} daemon should use." msgstr "" #. type: item #: doc/guix.texi:31640 #, no-wrap msgid "@code{rpcstatd-port} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:31642 msgid "The network port that the @command{rpc.statd} daemon should use." msgstr "" #. type: item #: doc/guix.texi:31643 doc/guix.texi:31691 #, no-wrap msgid "@code{rpcbind} (default: @code{rpcbind})" msgstr "" #. type: table #: doc/guix.texi:31645 doc/guix.texi:31693 msgid "The rpcbind package to use." msgstr "" #. type: item #: doc/guix.texi:31646 #, no-wrap msgid "@code{idmap-domain} (default: @code{\"localdomain\"})" msgstr "" #. type: table #: doc/guix.texi:31648 msgid "The local NFSv4 domain name." msgstr "" #. type: item #: doc/guix.texi:31649 #, no-wrap msgid "@code{nfsd-port} (default: @code{2049})" msgstr "" #. type: table #: doc/guix.texi:31651 msgid "The network port that the @command{nfsd} daemon should use." msgstr "" #. type: item #: doc/guix.texi:31652 #, no-wrap msgid "@code{nfsd-threads} (default: @code{8})" msgstr "" #. type: table #: doc/guix.texi:31654 msgid "The number of threads used by the @command{nfsd} daemon." msgstr "" #. type: item #: doc/guix.texi:31655 #, no-wrap msgid "@code{nfsd-tcp?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:31657 msgid "Whether the @command{nfsd} daemon should listen on a TCP socket." msgstr "" #. type: item #: doc/guix.texi:31658 #, no-wrap msgid "@code{nfsd-udp?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:31660 msgid "Whether the @command{nfsd} daemon should listen on a UDP socket." msgstr "" #. type: item #: doc/guix.texi:31661 doc/guix.texi:31745 doc/guix.texi:31770 #, no-wrap msgid "@code{pipefs-directory} (default: @code{\"/var/lib/nfs/rpc_pipefs\"})" msgstr "" #. type: table #: doc/guix.texi:31663 doc/guix.texi:31747 doc/guix.texi:31772 msgid "The directory where the pipefs file system is mounted." msgstr "" #. type: item #: doc/guix.texi:31664 #, no-wrap msgid "@code{debug} (default: @code{'()\"})" msgstr "" #. type: table #: doc/guix.texi:31668 msgid "" "A list of subsystems for which debugging output should be enabled. This is " "a list of symbols. Any of these symbols are valid: @code{nfsd}, @code{nfs}, " "@code{rpc}, @code{idmap}, @code{statd}, or @code{mountd}." msgstr "" #. type: Plain text #: doc/guix.texi:31673 msgid "" "If you don't need a complete NFS service or prefer to build it yourself you " "can use the individual component services that are documented below." msgstr "" #. type: subsubheading #: doc/guix.texi:31674 #, no-wrap msgid "RPC Bind Service" msgstr "" #. type: cindex #: doc/guix.texi:31675 #, no-wrap msgid "rpcbind" msgstr "" #. type: Plain text #: doc/guix.texi:31681 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:31682 #, no-wrap msgid "{Scheme Variable} rpcbind-service-type" msgstr "" #. type: defvr #: doc/guix.texi:31684 msgid "A service type for the RPC portmapper daemon." msgstr "" #. type: deftp #: doc/guix.texi:31687 #, no-wrap msgid "{Data Type} rpcbind-configuration" msgstr "" #. type: deftp #: doc/guix.texi:31690 msgid "" "Data type representing the configuration of the RPC Bind Service. This type " "has the following parameters:" msgstr "" #. type: item #: doc/guix.texi:31694 #, no-wrap msgid "@code{warm-start?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:31698 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:31702 #, no-wrap msgid "Pipefs Pseudo File System" msgstr "" #. type: cindex #: doc/guix.texi:31703 #, no-wrap msgid "pipefs" msgstr "" #. type: cindex #: doc/guix.texi:31704 #, no-wrap msgid "rpc_pipefs" msgstr "" #. type: Plain text #: doc/guix.texi:31708 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:31709 #, no-wrap msgid "{Scheme Variable} pipefs-service-type" msgstr "" #. type: defvr #: doc/guix.texi:31711 msgid "A service type for the pipefs pseudo file system." msgstr "" #. type: deftp #: doc/guix.texi:31713 #, no-wrap msgid "{Data Type} pipefs-configuration" msgstr "" #. type: deftp #: doc/guix.texi:31716 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:31717 #, no-wrap msgid "@code{mount-point} (default: @code{\"/var/lib/nfs/rpc_pipefs\"})" msgstr "" #. type: table #: doc/guix.texi:31719 msgid "The directory to which the file system is to be attached." msgstr "" #. type: subsubheading #: doc/guix.texi:31723 #, no-wrap msgid "GSS Daemon Service" msgstr "" #. type: cindex #: doc/guix.texi:31724 #, no-wrap msgid "GSSD" msgstr "" #. type: cindex #: doc/guix.texi:31725 #, no-wrap msgid "GSS" msgstr "" #. type: cindex #: doc/guix.texi:31726 #, no-wrap msgid "global security system" msgstr "" #. type: Plain text #: doc/guix.texi:31733 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:31734 #, no-wrap msgid "{Scheme Variable} gss-service-type" msgstr "" #. type: defvr #: doc/guix.texi:31736 msgid "A service type for the Global Security System (GSS) daemon." msgstr "" #. type: deftp #: doc/guix.texi:31738 #, no-wrap msgid "{Data Type} gss-configuration" msgstr "" #. type: deftp #: doc/guix.texi:31741 msgid "" "Data type representing the configuration of the GSS daemon service. This " "type has the following parameters:" msgstr "" #. type: table #: doc/guix.texi:31744 msgid "The package in which the @command{rpc.gssd} command is to be found." msgstr "" #. type: subsubheading #: doc/guix.texi:31752 #, no-wrap msgid "IDMAP Daemon Service" msgstr "" #. type: cindex #: doc/guix.texi:31753 #, no-wrap msgid "idmapd" msgstr "" #. type: cindex #: doc/guix.texi:31754 #, no-wrap msgid "name mapper" msgstr "" #. type: Plain text #: doc/guix.texi:31758 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:31759 #, no-wrap msgid "{Scheme Variable} idmap-service-type" msgstr "" #. type: defvr #: doc/guix.texi:31761 msgid "A service type for the Identity Mapper (IDMAP) daemon." msgstr "" #. type: deftp #: doc/guix.texi:31763 #, no-wrap msgid "{Data Type} idmap-configuration" msgstr "" #. type: deftp #: doc/guix.texi:31766 msgid "" "Data type representing the configuration of the IDMAP daemon service. This " "type has the following parameters:" msgstr "" #. type: table #: doc/guix.texi:31769 msgid "The package in which the @command{rpc.idmapd} command is to be found." msgstr "" #. type: item #: doc/guix.texi:31773 doc/guix.texi:31916 #, no-wrap msgid "@code{domain} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:31777 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: item #: doc/guix.texi:31778 #, no-wrap msgid "@code{verbosity} (default: @code{0})" msgstr "" #. type: table #: doc/guix.texi:31780 msgid "The verbosity level of the daemon." msgstr "" #. type: subsubheading #: doc/guix.texi:31787 doc/guix.texi:31793 #, no-wrap msgid "Samba" msgstr "" #. type: cindex #: doc/guix.texi:31788 #, no-wrap msgid "SMB" msgstr "" #. type: Plain text #: doc/guix.texi:31792 msgid "" "The @code{(gnu services samba)} module provides service definitions for " "Samba as well as additional helper services. Currently it provides the " "following services." msgstr "" #. type: Plain text #: doc/guix.texi:31800 msgid "" "@uref{https://www.samba.org, Samba} provides network shares for folders and " "printers using the SMB/CIFS protocol commonly used on Windows. It can also " "act as an Active Directory Domain Controller (AD DC) for other hosts in an " "heterougenious network with different types of Computer systems." msgstr "" #. type: defvar #: doc/guix.texi:31801 #, no-wrap msgid "{Scheme variable} samba-service-type" msgstr "" #. type: defvar #: doc/guix.texi:31806 msgid "" "The service type to enable the samba services @code{samba}, @code{nmbd}, " "@code{smbd} and @code{winbindd}. By default this service type does not run " "any of the Samba daemons; they must be enabled individually." msgstr "" #. type: defvar #: doc/guix.texi:31810 msgid "" "Below is a basic example that configures a simple, anonymous " "(unauthenticated) Samba file share exposing the @file{/public} directory." msgstr "" #. type: quotation #: doc/guix.texi:31815 msgid "" "The @file{/public} directory and its contents must be world readable/" "writable, so you'll want to run @samp{chmod -R 777 /public} on it." msgstr "" #. type: quotation #: doc/guix.texi:31817 #, no-wrap msgid "Caution" msgstr "" #. type: quotation #: doc/guix.texi:31821 msgid "" "Such a Samba configuration should only be used in controlled environments, " "and you should not share any private files using it, as anyone connecting to " "your network would be able to access them." msgstr "" #. type: lisp #: doc/guix.texi:31830 #, no-wrap msgid "" "(service samba-service-type (samba-configuration\n" " (enable-smbd? #t)\n" " (config-file (plain-file \"smb.conf\" \"\\\n" "[global]\n" "map to guest = Bad User\n" "logging = syslog@@1\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:31837 #, no-wrap msgid "" "[public]\n" "browsable = yes\n" "path = /public\n" "read only = no\n" "guest ok = yes\n" "guest only = yes\\n\"))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:31843 msgid "" "@deftp{Data Type} samba-service-configuration Configuration record for the " "Samba suite." msgstr "" #. type: item #: doc/guix.texi:31845 #, no-wrap msgid "@code{package} (default: @code{samba})" msgstr "" #. type: table #: doc/guix.texi:31847 msgid "The samba package to use." msgstr "" #. type: table #: doc/guix.texi:31851 msgid "" "The config file to use. To learn about its syntax, run @samp{man smb.conf}." msgstr "" #. type: item #: doc/guix.texi:31852 #, no-wrap msgid "@code{enable-samba?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:31854 msgid "Enable the @code{samba} daemon." msgstr "" #. type: item #: doc/guix.texi:31855 #, no-wrap msgid "@code{enable-smbd?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:31857 msgid "Enable the @code{smbd} daemon." msgstr "" #. type: item #: doc/guix.texi:31858 #, no-wrap msgid "@code{enable-nmbd?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:31860 msgid "Enable the @code{nmbd} daemon." msgstr "" #. type: item #: doc/guix.texi:31861 #, no-wrap msgid "@code{enable-winbindd?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:31863 msgid "Enable the @code{winbindd} daemon." msgstr "" #. type: cindex #: doc/guix.texi:31867 #, no-wrap msgid "wsdd, Web service discovery daemon" msgstr "" #. type: subsubheading #: doc/guix.texi:31868 #, no-wrap msgid "Web Service Discovery Daemon" msgstr "" #. type: Plain text #: doc/guix.texi:31876 msgid "" "The @acronym{WSDD, Web Service Discovery daemon} implements the @uref{http://" "docs.oasis-open.org/ws-dd/discovery/1.1/os/wsdd-discovery-1.1-spec-os.html, " "Web Services Dynamic Discovery} protocol that enables host discovery over " "Multicast DNS, similar to what Avahi does. It is a drop-in replacement for " "SMB hosts that have had SMBv1 disabled for security reasons." msgstr "" #. type: defvr #: doc/guix.texi:31877 #, no-wrap msgid "{Scheme Variable} wsdd-service-type" msgstr "" #. type: defvr #: doc/guix.texi:31881 msgid "" "Service type for the WSD host daemon. The value for this service type is a " "@code{wsdd-configuration} record. The details for the @code{wsdd-" "configuration} record type are given below." msgstr "" #. type: deftp #: doc/guix.texi:31883 #, no-wrap msgid "{Data Type} wsdd-configuration" msgstr "" #. type: deftp #: doc/guix.texi:31885 msgid "This data type represents the configuration for the wsdd service." msgstr "" #. type: item #: doc/guix.texi:31888 #, no-wrap msgid "@code{package} (default: @code{wsdd})" msgstr "" #. type: table #: doc/guix.texi:31890 msgid "The wsdd package to use." msgstr "" #. type: item #: doc/guix.texi:31891 #, no-wrap msgid "@code{ipv4only?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:31893 msgid "Only listen to IPv4 addresses." msgstr "" #. type: item #: doc/guix.texi:31894 #, no-wrap msgid "@code{ipv6only} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:31897 msgid "" "Only listen to IPv6 addresses. Please note: Activating both options is not " "possible, since there would be no IP versions to listen to." msgstr "" #. type: table #: doc/guix.texi:31902 msgid "" "Chroot into a separate directory to prevent access to other directories. " "This is to increase security in case there is a vulnerability in " "@command{wsdd}." msgstr "" #. type: item #: doc/guix.texi:31903 #, no-wrap msgid "@code{hop-limit} (default: @code{1})" msgstr "" #. type: table #: doc/guix.texi:31906 msgid "" "Limit to the level of hops for multicast packets. The default is @var{1} " "which should prevent packets from leaving the local network." msgstr "" #. type: item #: doc/guix.texi:31907 #, no-wrap msgid "@code{interface} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:31911 msgid "" "Limit to the given list of interfaces to listen to. By default wsdd will " "listen to all interfaces. Except the loopback interface is never used." msgstr "" #. type: item #: doc/guix.texi:31912 #, no-wrap msgid "@code{uuid-device} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:31915 msgid "" "The WSD protocol requires a device to have a UUID. Set this to manually " "assign the service a UUID." msgstr "" #. type: table #: doc/guix.texi:31918 msgid "Notify this host is a member of an Active Directory." msgstr "" #. type: table #: doc/guix.texi:31923 msgid "" "Manually set the hostname rather than letting @command{wsdd} inherit this " "host's hostname. Only the host name part of a possible FQDN will be used in " "the default case." msgstr "" #. type: item #: doc/guix.texi:31924 #, no-wrap msgid "@code{preserve-case?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:31928 msgid "" "By default @command{wsdd} will convert the hostname in workgroup to all " "uppercase. The opposite is true for hostnames in domains. Setting this " "parameter will preserve case." msgstr "" #. type: item #: doc/guix.texi:31929 #, no-wrap msgid "@code{workgroup} (default: @var{\"WORKGROUP\"})" msgstr "" #. type: table #: doc/guix.texi:31932 msgid "" "Change the name of the workgroup. By default @command{wsdd} reports this " "host being member of a workgroup." msgstr "" #. type: Plain text #: doc/guix.texi:31943 msgid "" "@uref{https://guix.gnu.org/cuirass/, Cuirass} is a continuous integration " "tool for Guix. It can be used both for development and for providing " "substitutes to others (@pxref{Substitutes})." msgstr "" #. type: Plain text #: doc/guix.texi:31945 msgid "" "The @code{(gnu services cuirass)} module provides the following service." msgstr "" #. type: defvr #: doc/guix.texi:31946 #, no-wrap msgid "{Scheme Procedure} cuirass-service-type" msgstr "" #. type: defvr #: doc/guix.texi:31949 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:31954 msgid "" "To add build jobs, you have to set the @code{specifications} field of the " "configuration. For instance, the following example will build all the " "packages provided by the @code{my-channel} channel." msgstr "" #. type: lisp #: doc/guix.texi:31965 #, no-wrap msgid "" "(define %cuirass-specs\n" " #~(list (specification\n" " (name \"my-channel\")\n" " (build '(channels my-channel))\n" " (channels\n" " (cons (channel\n" " (name 'my-channel)\n" " (url \"https://my-channel.git\"))\n" " %default-channels)))))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:31969 doc/guix.texi:31983 #, no-wrap msgid "" "(service cuirass-service-type\n" " (cuirass-configuration\n" " (specifications %cuirass-specs)))\n" msgstr "" #. type: Plain text #: doc/guix.texi:31973 msgid "" "To build the @code{linux-libre} package defined by the default Guix channel, " "one can use the following configuration." msgstr "" #. type: lisp #: doc/guix.texi:31979 #, no-wrap msgid "" "(define %cuirass-specs\n" " #~(list (specification\n" " (name \"my-linux\")\n" " (build '(packages \"linux-libre\")))))\n" "\n" msgstr "" #. type: Plain text #: doc/guix.texi:31988 msgid "" "The other configuration possibilities, as well as the specification record " "itself are described in the Cuirass manual (@pxref{Specifications,,, " "cuirass, Cuirass})." msgstr "" #. type: Plain text #: doc/guix.texi:31992 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:31993 #, no-wrap msgid "{Data Type} cuirass-configuration" msgstr "" #. type: deftp #: doc/guix.texi:31995 msgid "Data type representing the configuration of Cuirass." msgstr "" #. type: item #: doc/guix.texi:31997 doc/guix.texi:32134 #, no-wrap msgid "@code{cuirass} (default: @code{cuirass})" msgstr "" #. type: table #: doc/guix.texi:31999 doc/guix.texi:32136 msgid "The Cuirass package to use." msgstr "" #. type: item #: doc/guix.texi:32000 #, no-wrap msgid "@code{log-file} (default: @code{\"/var/log/cuirass.log\"})" msgstr "" #. type: table #: doc/guix.texi:32002 doc/guix.texi:32106 doc/guix.texi:32149 msgid "Location of the log file." msgstr "" #. type: item #: doc/guix.texi:32003 #, no-wrap msgid "@code{web-log-file} (default: @code{\"/var/log/cuirass-web.log\"})" msgstr "" #. type: table #: doc/guix.texi:32005 msgid "Location of the log file used by the web interface." msgstr "" #. type: item #: doc/guix.texi:32006 #, no-wrap msgid "@code{cache-directory} (default: @code{\"/var/cache/cuirass\"})" msgstr "" #. type: table #: doc/guix.texi:32008 msgid "Location of the repository cache." msgstr "" #. type: item #: doc/guix.texi:32009 #, no-wrap msgid "@code{user} (default: @code{\"cuirass\"})" msgstr "" #. type: table #: doc/guix.texi:32011 msgid "Owner of the @code{cuirass} process." msgstr "" #. type: item #: doc/guix.texi:32012 #, no-wrap msgid "@code{group} (default: @code{\"cuirass\"})" msgstr "" #. type: table #: doc/guix.texi:32014 msgid "Owner's group of the @code{cuirass} process." msgstr "" #. type: item #: doc/guix.texi:32015 #, no-wrap msgid "@code{interval} (default: @code{60})" msgstr "" #. type: table #: doc/guix.texi:32018 msgid "" "Number of seconds between the poll of the repositories followed by the " "Cuirass jobs." msgstr "" #. type: item #: doc/guix.texi:32019 #, no-wrap msgid "@code{parameters} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:32022 msgid "" "Read parameters from the given @var{parameters} file. The supported " "parameters are described here (@pxref{Parameters,,, cuirass, Cuirass})." msgstr "" #. type: item #: doc/guix.texi:32023 #, no-wrap msgid "@code{remote-server} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:32026 msgid "" "A @code{cuirass-remote-server-configuration} record to use the build remote " "mechanism or @code{#f} to use the default build mechanism." msgstr "" #. type: item #: doc/guix.texi:32027 #, no-wrap msgid "@code{database} (default: @code{\"dbname=cuirass host=/var/run/postgresql\"})" msgstr "" #. type: table #: doc/guix.texi:32032 msgid "" "Use @var{database} as the database containing the jobs and the past build " "results. Since Cuirass uses PostgreSQL as a database engine, @var{database} " "must be a string such as @code{\"dbname=cuirass host=localhost\"}." msgstr "" #. type: item #: doc/guix.texi:32033 #, no-wrap msgid "@code{port} (default: @code{8081})" msgstr "" #. type: table #: doc/guix.texi:32035 msgid "Port number used by the HTTP server." msgstr "" #. type: table #: doc/guix.texi:32039 msgid "" "Listen on the network interface for @var{host}. The default is to accept " "connections from localhost." msgstr "" #. type: item #: doc/guix.texi:32040 #, no-wrap msgid "@code{specifications} (default: @code{#~'()})" msgstr "" #. type: table #: doc/guix.texi:32044 msgid "" "A gexp (@pxref{G-Expressions}) that evaluates to a list of specifications " "records. The specification record is described in the Cuirass manual " "(@pxref{Specifications,,, cuirass, Cuirass})." msgstr "" #. type: item #: doc/guix.texi:32045 #, no-wrap msgid "@code{use-substitutes?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:32048 msgid "" "This allows using substitutes to avoid building every dependencies of a job " "from source." msgstr "" #. type: item #: doc/guix.texi:32049 doc/guix.texi:39899 #, no-wrap msgid "@code{one-shot?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:32051 msgid "Only evaluate specifications and build derivations once." msgstr "" #. type: item #: doc/guix.texi:32052 #, no-wrap msgid "@code{fallback?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:32055 msgid "" "When substituting a pre-built binary fails, fall back to building packages " "locally." msgstr "" #. type: table #: doc/guix.texi:32058 msgid "Extra options to pass when running the Cuirass processes." msgstr "" #. type: cindex #: doc/guix.texi:32062 #, no-wrap msgid "remote build" msgstr "" #. type: subsubheading #: doc/guix.texi:32063 #, no-wrap msgid "Cuirass remote building" msgstr "" #. type: Plain text #: doc/guix.texi:32066 msgid "Cuirass supports two mechanisms to build derivations." msgstr "" #. type: item #: doc/guix.texi:32068 #, no-wrap msgid "Using the local Guix daemon." msgstr "" #. type: itemize #: doc/guix.texi:32072 msgid "" "This is the default build mechanism. Once the build jobs are evaluated, " "they are sent to the local Guix daemon. Cuirass then listens to the Guix " "daemon output to detect the various build events." msgstr "" #. type: item #: doc/guix.texi:32073 #, no-wrap msgid "Using the remote build mechanism." msgstr "" #. type: itemize #: doc/guix.texi:32077 msgid "" "The build jobs are not submitted to the local Guix daemon. Instead, a " "remote server dispatches build requests to the connect remote workers, " "according to the build priorities." msgstr "" #. type: Plain text #: doc/guix.texi:32084 msgid "" "To enable this build mode a @code{cuirass-remote-server-configuration} " "record must be passed as @code{remote-server} argument of the @code{cuirass-" "configuration} record. The @code{cuirass-remote-server-configuration} " "record is described below." msgstr "" #. type: Plain text #: doc/guix.texi:32089 msgid "" "This build mode scales way better than the default build mode. This is the " "build mode that is used on the GNU Guix build farm at @url{https://ci.guix." "gnu.org}. It should be preferred when using Cuirass to build large amount " "of packages." msgstr "" #. type: deftp #: doc/guix.texi:32090 #, no-wrap msgid "{Data Type} cuirass-remote-server-configuration" msgstr "" #. type: deftp #: doc/guix.texi:32092 msgid "Data type representing the configuration of the Cuirass remote-server." msgstr "" #. type: item #: doc/guix.texi:32094 #, no-wrap msgid "@code{backend-port} (default: @code{5555})" msgstr "" #. type: table #: doc/guix.texi:32097 msgid "" "The TCP port for communicating with @code{remote-worker} processes using " "ZMQ. It defaults to @code{5555}." msgstr "" #. type: item #: doc/guix.texi:32098 #, no-wrap msgid "@code{log-port} (default: @code{5556})" msgstr "" #. type: table #: doc/guix.texi:32100 msgid "The TCP port of the log server. It defaults to @code{5556}." msgstr "" #. type: item #: doc/guix.texi:32101 #, no-wrap msgid "@code{publish-port} (default: @code{5557})" msgstr "" #. type: table #: doc/guix.texi:32103 msgid "The TCP port of the publish server. It defaults to @code{5557}." msgstr "" #. type: item #: doc/guix.texi:32104 #, no-wrap msgid "@code{log-file} (default: @code{\"/var/log/cuirass-remote-server.log\"})" msgstr "" #. type: item #: doc/guix.texi:32107 #, no-wrap msgid "@code{cache} (default: @code{\"/var/cache/cuirass/remote\"})" msgstr "" #. type: table #: doc/guix.texi:32109 msgid "Use @var{cache} directory to cache build log files." msgstr "" #. type: item #: doc/guix.texi:32110 #, no-wrap msgid "@code{trigger-url} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:32113 msgid "" "Once a substitute is successfully fetched, trigger substitute baking at " "@var{trigger-url}." msgstr "" #. type: table #: doc/guix.texi:32118 msgid "" "If set to false, do not start a publish server and ignore the @code{publish-" "port} argument. This can be useful if there is already a standalone publish " "server standing next to the remote server." msgstr "" #. type: code{#1} #: doc/guix.texi:32120 doc/guix.texi:32157 #, no-wrap msgid "private-key" msgstr "" #. type: Plain text #: doc/guix.texi:32129 msgid "" "At least one remote worker must also be started on any machine of the local " "network to actually perform the builds and report their status." msgstr "" #. type: deftp #: doc/guix.texi:32130 #, no-wrap msgid "{Data Type} cuirass-remote-worker-configuration" msgstr "" #. type: deftp #: doc/guix.texi:32132 msgid "Data type representing the configuration of the Cuirass remote-worker." msgstr "" #. type: item #: doc/guix.texi:32137 #, no-wrap msgid "@code{workers} (default: @code{1})" msgstr "" #. type: table #: doc/guix.texi:32139 msgid "Start @var{workers} parallel workers." msgstr "" #. type: table #: doc/guix.texi:32143 msgid "" "Do not use Avahi discovery and connect to the given @code{server} IP address " "instead." msgstr "" #. type: item #: doc/guix.texi:32144 #, no-wrap msgid "@code{systems} (default: @code{(list (%current-system))})" msgstr "" #. type: table #: doc/guix.texi:32146 msgid "Only request builds for the given @var{systems}." msgstr "" #. type: item #: doc/guix.texi:32147 #, no-wrap msgid "@code{log-file} (default: @code{\"/var/log/cuirass-remote-worker.log\"})" msgstr "" #. type: item #: doc/guix.texi:32150 #, no-wrap msgid "@code{publish-port} (default: @code{5558})" msgstr "" #. type: table #: doc/guix.texi:32152 msgid "The TCP port of the publish server. It defaults to @code{5558}." msgstr "" #. type: subsubheading #: doc/guix.texi:32164 #, no-wrap msgid "Laminar" msgstr "" #. type: Plain text #: doc/guix.texi:32169 msgid "" "@uref{https://laminar.ohwg.net/, Laminar} is a lightweight and modular " "Continuous Integration service. It doesn't have a configuration web UI " "instead uses version-controllable configuration files and scripts." msgstr "" #. type: Plain text #: doc/guix.texi:32172 msgid "" "Laminar encourages the use of existing tools such as bash and cron instead " "of reinventing them." msgstr "" #. type: defvr #: doc/guix.texi:32173 #, no-wrap msgid "{Scheme Procedure} laminar-service-type" msgstr "" #. type: defvr #: doc/guix.texi:32176 msgid "" "The type of the Laminar service. Its value must be a @code{laminar-" "configuration} object, as described below." msgstr "" #. type: defvr #: doc/guix.texi:32180 msgid "" "All configuration values have defaults, a minimal configuration to get " "Laminar running is shown below. By default, the web interface is available " "on port 8080." msgstr "" #. type: lisp #: doc/guix.texi:32183 #, no-wrap msgid "(service laminar-service-type)\n" msgstr "" #. type: deftp #: doc/guix.texi:32186 #, no-wrap msgid "{Data Type} laminar-configuration" msgstr "" #. type: deftp #: doc/guix.texi:32188 msgid "Data type representing the configuration of Laminar." msgstr "" #. type: item #: doc/guix.texi:32190 #, no-wrap msgid "@code{laminar} (default: @code{laminar})" msgstr "" #. type: table #: doc/guix.texi:32192 msgid "The Laminar package to use." msgstr "" #. type: item #: doc/guix.texi:32193 #, no-wrap msgid "@code{home-directory} (default: @code{\"/var/lib/laminar\"})" msgstr "" #. type: table #: doc/guix.texi:32195 msgid "The directory for job configurations and run directories." msgstr "" #. type: item #: doc/guix.texi:32196 #, no-wrap msgid "@code{bind-http} (default: @code{\"*:8080\"})" msgstr "" #. type: table #: doc/guix.texi:32199 msgid "" "The interface/port or unix socket on which laminard should listen for " "incoming connections to the web frontend." msgstr "" #. type: item #: doc/guix.texi:32200 #, no-wrap msgid "@code{bind-rpc} (default: @code{\"unix-abstract:laminar\"})" msgstr "" #. type: table #: doc/guix.texi:32203 msgid "" "The interface/port or unix socket on which laminard should listen for " "incoming commands such as build triggers." msgstr "" #. type: item #: doc/guix.texi:32204 #, no-wrap msgid "@code{title} (default: @code{\"Laminar\"})" msgstr "" #. type: table #: doc/guix.texi:32206 msgid "The page title to show in the web frontend." msgstr "" #. type: item #: doc/guix.texi:32207 #, no-wrap msgid "@code{keep-rundirs} (default: @code{0})" msgstr "" #. type: table #: doc/guix.texi:32211 msgid "" "Set to an integer defining how many rundirs to keep per job. The lowest-" "numbered ones will be deleted. The default is 0, meaning all run dirs will " "be immediately deleted." msgstr "" #. type: item #: doc/guix.texi:32212 #, no-wrap msgid "@code{archive-url} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:32215 msgid "" "The web frontend served by laminard will use this URL to form links to " "artefacts archived jobs." msgstr "" #. type: item #: doc/guix.texi:32216 #, no-wrap msgid "@code{base-url} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:32218 msgid "Base URL to use for links to laminar itself." msgstr "" #. type: cindex #: doc/guix.texi:32225 #, no-wrap msgid "tlp" msgstr "" #. type: cindex #: doc/guix.texi:32226 #, no-wrap msgid "power management with TLP" msgstr "" #. type: subsubheading #: doc/guix.texi:32227 #, no-wrap msgid "TLP daemon" msgstr "" #. type: Plain text #: doc/guix.texi:32231 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:32237 msgid "" "TLP enables various powersaving modes in userspace and kernel. Contrary to " "@code{upower-service}, it is not a passive, monitoring tool, as it will " "apply custom settings each time a new power source is detected. More " "information can be found at @uref{https://linrunner.de/en/tlp/tlp.html, TLP " "home page}." msgstr "" #. type: deffn #: doc/guix.texi:32238 #, no-wrap msgid "{Scheme Variable} tlp-service-type" msgstr "" #. type: deffn #: doc/guix.texi:32242 msgid "" "The service type for the TLP tool. The default settings are optimised for " "battery life on most systems, but you can tweak them to your heart's content " "by adding a valid @code{tlp-configuration}:" msgstr "" #. type: lisp #: doc/guix.texi:32247 #, no-wrap msgid "" "(service tlp-service-type\n" " (tlp-configuration\n" " (cpu-scaling-governor-on-ac (list \"performance\"))\n" " (sched-powersave-on-bat? #t)))\n" msgstr "" #. type: Plain text #: doc/guix.texi:32255 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 left unset, or is " "explicitly set to the @code{%unset-value} value." msgstr "" #. type: Plain text #: doc/guix.texi:32265 msgid "Available @code{tlp-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:32266 #, no-wrap msgid "{@code{tlp-configuration} parameter} package tlp" msgstr "" #. type: deftypevr #: doc/guix.texi:32268 msgid "The TLP package." msgstr "" #. type: deftypevr #: doc/guix.texi:32271 #, no-wrap msgid "{@code{tlp-configuration} parameter} boolean tlp-enable?" msgstr "" #. type: deftypevr #: doc/guix.texi:32273 msgid "Set to true if you wish to enable TLP." msgstr "" #. type: deftypevr #: doc/guix.texi:32278 #, no-wrap msgid "{@code{tlp-configuration} parameter} string tlp-default-mode" msgstr "" #. type: deftypevr #: doc/guix.texi:32281 msgid "" "Default mode when no power supply can be detected. Alternatives are AC and " "BAT." msgstr "" #. type: deftypevr #: doc/guix.texi:32283 msgid "Defaults to @samp{\"AC\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:32286 #, no-wrap msgid "{@code{tlp-configuration} parameter} non-negative-integer disk-idle-secs-on-ac" msgstr "" #. type: deftypevr #: doc/guix.texi:32289 msgid "" "Number of seconds Linux kernel has to wait after the disk goes idle, before " "syncing on AC." msgstr "" #. type: deftypevr #: doc/guix.texi:32294 #, no-wrap msgid "{@code{tlp-configuration} parameter} non-negative-integer disk-idle-secs-on-bat" msgstr "" #. type: deftypevr #: doc/guix.texi:32296 msgid "Same as @code{disk-idle-ac} but on BAT mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32298 msgid "Defaults to @samp{2}." msgstr "" #. type: deftypevr #: doc/guix.texi:32301 #, no-wrap msgid "{@code{tlp-configuration} parameter} non-negative-integer max-lost-work-secs-on-ac" msgstr "" #. type: deftypevr #: doc/guix.texi:32303 msgid "Dirty pages flushing periodicity, expressed in seconds." msgstr "" #. type: deftypevr #: doc/guix.texi:32305 doc/guix.texi:32528 doc/guix.texi:34850 #: doc/guix.texi:34858 msgid "Defaults to @samp{15}." msgstr "" #. type: deftypevr #: doc/guix.texi:32308 #, no-wrap msgid "{@code{tlp-configuration} parameter} non-negative-integer max-lost-work-secs-on-bat" msgstr "" #. type: deftypevr #: doc/guix.texi:32310 msgid "Same as @code{max-lost-work-secs-on-ac} but on BAT mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32312 msgid "Defaults to @samp{60}." msgstr "" #. type: deftypevr #: doc/guix.texi:32315 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list cpu-scaling-governor-on-ac" msgstr "" #. type: deftypevr #: doc/guix.texi:32319 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:32324 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list cpu-scaling-governor-on-bat" msgstr "" #. type: deftypevr #: doc/guix.texi:32326 msgid "Same as @code{cpu-scaling-governor-on-ac} but on BAT mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32331 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-min-freq-on-ac" msgstr "" #. type: deftypevr #: doc/guix.texi:32333 msgid "Set the min available frequency for the scaling governor on AC." msgstr "" #. type: deftypevr #: doc/guix.texi:32338 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-max-freq-on-ac" msgstr "" #. type: deftypevr #: doc/guix.texi:32340 msgid "Set the max available frequency for the scaling governor on AC." msgstr "" #. type: deftypevr #: doc/guix.texi:32345 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-min-freq-on-bat" msgstr "" #. type: deftypevr #: doc/guix.texi:32347 msgid "Set the min available frequency for the scaling governor on BAT." msgstr "" #. type: deftypevr #: doc/guix.texi:32352 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-max-freq-on-bat" msgstr "" #. type: deftypevr #: doc/guix.texi:32354 msgid "Set the max available frequency for the scaling governor on BAT." msgstr "" #. type: deftypevr #: doc/guix.texi:32359 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-min-perf-on-ac" msgstr "" #. type: deftypevr #: doc/guix.texi:32362 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:32367 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-max-perf-on-ac" msgstr "" #. type: deftypevr #: doc/guix.texi:32370 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:32375 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-min-perf-on-bat" msgstr "" #. type: deftypevr #: doc/guix.texi:32377 msgid "Same as @code{cpu-min-perf-on-ac} on BAT mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32382 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-max-perf-on-bat" msgstr "" #. type: deftypevr #: doc/guix.texi:32384 msgid "Same as @code{cpu-max-perf-on-ac} on BAT mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32389 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-boolean cpu-boost-on-ac?" msgstr "" #. type: deftypevr #: doc/guix.texi:32391 msgid "Enable CPU turbo boost feature on AC mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32396 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-boolean cpu-boost-on-bat?" msgstr "" #. type: deftypevr #: doc/guix.texi:32398 msgid "Same as @code{cpu-boost-on-ac?} on BAT mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32403 #, no-wrap msgid "{@code{tlp-configuration} parameter} boolean sched-powersave-on-ac?" msgstr "" #. type: deftypevr #: doc/guix.texi:32406 msgid "" "Allow Linux kernel to minimize the number of CPU cores/hyper-threads used " "under light load conditions." msgstr "" #. type: deftypevr #: doc/guix.texi:32411 #, no-wrap msgid "{@code{tlp-configuration} parameter} boolean sched-powersave-on-bat?" msgstr "" #. type: deftypevr #: doc/guix.texi:32413 msgid "Same as @code{sched-powersave-on-ac?} but on BAT mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32418 #, no-wrap msgid "{@code{tlp-configuration} parameter} boolean nmi-watchdog?" msgstr "" #. type: deftypevr #: doc/guix.texi:32420 msgid "Enable Linux kernel NMI watchdog." msgstr "" #. type: deftypevr #: doc/guix.texi:32425 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-string phc-controls" msgstr "" #. type: deftypevr #: doc/guix.texi:32428 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:32433 #, no-wrap msgid "{@code{tlp-configuration} parameter} string energy-perf-policy-on-ac" msgstr "" #. type: deftypevr #: doc/guix.texi:32436 msgid "" "Set CPU performance versus energy saving policy on AC@. Alternatives are " "performance, normal, powersave." msgstr "" #. type: deftypevr #: doc/guix.texi:32438 doc/guix.texi:32536 doc/guix.texi:32594 msgid "Defaults to @samp{\"performance\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:32441 #, no-wrap msgid "{@code{tlp-configuration} parameter} string energy-perf-policy-on-bat" msgstr "" #. type: deftypevr #: doc/guix.texi:32443 msgid "Same as @code{energy-perf-policy-ac} but on BAT mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32445 doc/guix.texi:32543 msgid "Defaults to @samp{\"powersave\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:32448 #, no-wrap msgid "{@code{tlp-configuration} parameter} space-separated-string-list disks-devices" msgstr "" #. type: deftypevr #: doc/guix.texi:32450 msgid "Hard disk devices." msgstr "" #. type: deftypevr #: doc/guix.texi:32453 #, no-wrap msgid "{@code{tlp-configuration} parameter} space-separated-string-list disk-apm-level-on-ac" msgstr "" #. type: deftypevr #: doc/guix.texi:32455 msgid "Hard disk advanced power management level." msgstr "" #. type: deftypevr #: doc/guix.texi:32458 #, no-wrap msgid "{@code{tlp-configuration} parameter} space-separated-string-list disk-apm-level-on-bat" msgstr "" #. type: deftypevr #: doc/guix.texi:32460 msgid "Same as @code{disk-apm-bat} but on BAT mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32463 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-spindown-timeout-on-ac" msgstr "" #. type: deftypevr #: doc/guix.texi:32466 msgid "" "Hard disk spin down timeout. One value has to be specified for each " "declared hard disk." msgstr "" #. type: deftypevr #: doc/guix.texi:32471 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-spindown-timeout-on-bat" msgstr "" #. type: deftypevr #: doc/guix.texi:32473 msgid "Same as @code{disk-spindown-timeout-on-ac} but on BAT mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32478 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-iosched" msgstr "" #. type: deftypevr #: doc/guix.texi:32482 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:32487 #, no-wrap msgid "{@code{tlp-configuration} parameter} string sata-linkpwr-on-ac" msgstr "" #. type: deftypevr #: doc/guix.texi:32490 msgid "" "SATA aggressive link power management (ALPM) level. Alternatives are " "min_power, medium_power, max_performance." msgstr "" #. type: deftypevr #: doc/guix.texi:32492 msgid "Defaults to @samp{\"max_performance\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:32495 #, no-wrap msgid "{@code{tlp-configuration} parameter} string sata-linkpwr-on-bat" msgstr "" #. type: deftypevr #: doc/guix.texi:32497 msgid "Same as @code{sata-linkpwr-ac} but on BAT mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32499 msgid "Defaults to @samp{\"min_power\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:32502 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-string sata-linkpwr-blacklist" msgstr "" #. type: deftypevr #: doc/guix.texi:32504 msgid "Exclude specified SATA host devices for link power management." msgstr "" #. type: deftypevr #: doc/guix.texi:32509 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-on-off-boolean ahci-runtime-pm-on-ac?" msgstr "" #. type: deftypevr #: doc/guix.texi:32512 msgid "" "Enable Runtime Power Management for AHCI controller and disks on AC mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32517 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-on-off-boolean ahci-runtime-pm-on-bat?" msgstr "" #. type: deftypevr #: doc/guix.texi:32519 msgid "Same as @code{ahci-runtime-pm-on-ac} on BAT mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32524 #, no-wrap msgid "{@code{tlp-configuration} parameter} non-negative-integer ahci-runtime-pm-timeout" msgstr "" #. type: deftypevr #: doc/guix.texi:32526 msgid "Seconds of inactivity before disk is suspended." msgstr "" #. type: deftypevr #: doc/guix.texi:32531 #, no-wrap msgid "{@code{tlp-configuration} parameter} string pcie-aspm-on-ac" msgstr "" #. type: deftypevr #: doc/guix.texi:32534 msgid "" "PCI Express Active State Power Management level. Alternatives are default, " "performance, powersave." msgstr "" #. type: deftypevr #: doc/guix.texi:32539 #, no-wrap msgid "{@code{tlp-configuration} parameter} string pcie-aspm-on-bat" msgstr "" #. type: deftypevr #: doc/guix.texi:32541 msgid "Same as @code{pcie-aspm-ac} but on BAT mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32546 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer start-charge-thresh-bat0" msgstr "" #. type: deftypevr #: doc/guix.texi:32548 msgid "" "Percentage when battery 0 should begin charging. Only supported on some " "laptops." msgstr "" #. type: deftypevr #: doc/guix.texi:32553 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer stop-charge-thresh-bat0" msgstr "" #. type: deftypevr #: doc/guix.texi:32555 msgid "" "Percentage when battery 0 should stop charging. Only supported on some " "laptops." msgstr "" #. type: deftypevr #: doc/guix.texi:32560 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer start-charge-thresh-bat1" msgstr "" #. type: deftypevr #: doc/guix.texi:32562 msgid "" "Percentage when battery 1 should begin charging. Only supported on some " "laptops." msgstr "" #. type: deftypevr #: doc/guix.texi:32567 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer stop-charge-thresh-bat1" msgstr "" #. type: deftypevr #: doc/guix.texi:32569 msgid "" "Percentage when battery 1 should stop charging. Only supported on some " "laptops." msgstr "" #. type: deftypevr #: doc/guix.texi:32574 #, no-wrap msgid "{@code{tlp-configuration} parameter} string radeon-power-profile-on-ac" msgstr "" #. type: deftypevr #: doc/guix.texi:32577 msgid "" "Radeon graphics clock speed level. Alternatives are low, mid, high, auto, " "default." msgstr "" #. type: deftypevr #: doc/guix.texi:32579 msgid "Defaults to @samp{\"high\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:32582 #, no-wrap msgid "{@code{tlp-configuration} parameter} string radeon-power-profile-on-bat" msgstr "" #. type: deftypevr #: doc/guix.texi:32584 msgid "Same as @code{radeon-power-ac} but on BAT mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32586 msgid "Defaults to @samp{\"low\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:32589 #, no-wrap msgid "{@code{tlp-configuration} parameter} string radeon-dpm-state-on-ac" msgstr "" #. type: deftypevr #: doc/guix.texi:32592 msgid "" "Radeon dynamic power management method (DPM). Alternatives are battery, " "performance." msgstr "" #. type: deftypevr #: doc/guix.texi:32597 #, no-wrap msgid "{@code{tlp-configuration} parameter} string radeon-dpm-state-on-bat" msgstr "" #. type: deftypevr #: doc/guix.texi:32599 msgid "Same as @code{radeon-dpm-state-ac} but on BAT mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32601 msgid "Defaults to @samp{\"battery\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:32604 #, no-wrap msgid "{@code{tlp-configuration} parameter} string radeon-dpm-perf-level-on-ac" msgstr "" #. type: deftypevr #: doc/guix.texi:32606 msgid "Radeon DPM performance level. Alternatives are auto, low, high." msgstr "" #. type: deftypevr #: doc/guix.texi:32608 doc/guix.texi:32615 doc/guix.texi:32689 msgid "Defaults to @samp{\"auto\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:32611 #, no-wrap msgid "{@code{tlp-configuration} parameter} string radeon-dpm-perf-level-on-bat" msgstr "" #. type: deftypevr #: doc/guix.texi:32613 msgid "Same as @code{radeon-dpm-perf-ac} but on BAT mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32618 #, no-wrap msgid "{@code{tlp-configuration} parameter} on-off-boolean wifi-pwr-on-ac?" msgstr "" #. type: deftypevr #: doc/guix.texi:32620 msgid "Wifi power saving mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32625 #, no-wrap msgid "{@code{tlp-configuration} parameter} on-off-boolean wifi-pwr-on-bat?" msgstr "" #. type: deftypevr #: doc/guix.texi:32627 msgid "Same as @code{wifi-power-ac?} but on BAT mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32632 #, no-wrap msgid "{@code{tlp-configuration} parameter} y-n-boolean wol-disable?" msgstr "" #. type: deftypevr #: doc/guix.texi:32634 msgid "Disable wake on LAN." msgstr "" #. type: deftypevr #: doc/guix.texi:32639 #, no-wrap msgid "{@code{tlp-configuration} parameter} non-negative-integer sound-power-save-on-ac" msgstr "" #. type: deftypevr #: doc/guix.texi:32642 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:32647 #, no-wrap msgid "{@code{tlp-configuration} parameter} non-negative-integer sound-power-save-on-bat" msgstr "" #. type: deftypevr #: doc/guix.texi:32649 msgid "Same as @code{sound-powersave-ac} but on BAT mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32654 #, no-wrap msgid "{@code{tlp-configuration} parameter} y-n-boolean sound-power-save-controller?" msgstr "" #. type: deftypevr #: doc/guix.texi:32656 msgid "Disable controller in powersaving mode on Intel HDA devices." msgstr "" #. type: deftypevr #: doc/guix.texi:32661 #, no-wrap msgid "{@code{tlp-configuration} parameter} boolean bay-poweroff-on-bat?" msgstr "" #. type: deftypevr #: doc/guix.texi:32665 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:32670 #, no-wrap msgid "{@code{tlp-configuration} parameter} string bay-device" msgstr "" #. type: deftypevr #: doc/guix.texi:32672 msgid "Name of the optical drive device to power off." msgstr "" #. type: deftypevr #: doc/guix.texi:32674 msgid "Defaults to @samp{\"sr0\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:32677 #, no-wrap msgid "{@code{tlp-configuration} parameter} string runtime-pm-on-ac" msgstr "" #. type: deftypevr #: doc/guix.texi:32680 msgid "" "Runtime Power Management for PCI(e) bus devices. Alternatives are on and " "auto." msgstr "" #. type: deftypevr #: doc/guix.texi:32682 msgid "Defaults to @samp{\"on\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:32685 #, no-wrap msgid "{@code{tlp-configuration} parameter} string runtime-pm-on-bat" msgstr "" #. type: deftypevr #: doc/guix.texi:32687 msgid "Same as @code{runtime-pm-ac} but on BAT mode." msgstr "" #. type: deftypevr #: doc/guix.texi:32692 #, no-wrap msgid "{@code{tlp-configuration} parameter} boolean runtime-pm-all?" msgstr "" #. type: deftypevr #: doc/guix.texi:32695 msgid "" "Runtime Power Management for all PCI(e) bus devices, except blacklisted ones." msgstr "" #. type: deftypevr #: doc/guix.texi:32700 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list runtime-pm-blacklist" msgstr "" #. type: deftypevr #: doc/guix.texi:32702 msgid "" "Exclude specified PCI(e) device addresses from Runtime Power Management." msgstr "" #. type: deftypevr #: doc/guix.texi:32707 #, no-wrap msgid "{@code{tlp-configuration} parameter} space-separated-string-list runtime-pm-driver-blacklist" msgstr "" #. type: deftypevr #: doc/guix.texi:32710 msgid "" "Exclude PCI(e) devices assigned to the specified drivers from Runtime Power " "Management." msgstr "" #. type: deftypevr #: doc/guix.texi:32713 #, no-wrap msgid "{@code{tlp-configuration} parameter} boolean usb-autosuspend?" msgstr "" #. type: deftypevr #: doc/guix.texi:32715 msgid "Enable USB autosuspend feature." msgstr "" #. type: deftypevr #: doc/guix.texi:32720 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-string usb-blacklist" msgstr "" #. type: deftypevr #: doc/guix.texi:32722 msgid "Exclude specified devices from USB autosuspend." msgstr "" #. type: deftypevr #: doc/guix.texi:32727 #, no-wrap msgid "{@code{tlp-configuration} parameter} boolean usb-blacklist-wwan?" msgstr "" #. type: deftypevr #: doc/guix.texi:32729 msgid "Exclude WWAN devices from USB autosuspend." msgstr "" #. type: deftypevr #: doc/guix.texi:32734 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-string usb-whitelist" msgstr "" #. type: deftypevr #: doc/guix.texi:32737 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:32742 #, no-wrap msgid "{@code{tlp-configuration} parameter} maybe-boolean usb-autosuspend-disable-on-shutdown?" msgstr "" #. type: deftypevr #: doc/guix.texi:32744 msgid "Enable USB autosuspend before shutdown." msgstr "" #. type: deftypevr #: doc/guix.texi:32749 #, no-wrap msgid "{@code{tlp-configuration} parameter} boolean restore-device-state-on-startup?" msgstr "" #. type: deftypevr #: doc/guix.texi:32752 msgid "" "Restore radio device state (bluetooth, wifi, wwan) from previous shutdown on " "system startup." msgstr "" #. type: cindex #: doc/guix.texi:32757 #, no-wrap msgid "thermald" msgstr "" #. type: cindex #: doc/guix.texi:32758 #, no-wrap msgid "CPU frequency scaling with thermald" msgstr "" #. type: subsubheading #: doc/guix.texi:32759 #, no-wrap msgid "Thermald daemon" msgstr "" #. type: Plain text #: doc/guix.texi:32763 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:32764 #, no-wrap msgid "{Scheme Variable} thermald-service-type" msgstr "" #. type: defvr #: doc/guix.texi:32769 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:32771 #, no-wrap msgid "{Data Type} thermald-configuration" msgstr "" #. type: deftp #: doc/guix.texi:32773 msgid "" "Data type representing the configuration of @code{thermald-service-type}." msgstr "" #. type: item #: doc/guix.texi:32775 #, no-wrap msgid "@code{adaptive?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:32778 msgid "" "Use @acronym{DPTF, Dynamic Power and Thermal Framework} adaptive tables when " "present." msgstr "" #. type: item #: doc/guix.texi:32779 #, no-wrap msgid "@code{ignore-cpuid-check?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:32781 msgid "Ignore cpuid check for supported CPU models." msgstr "" #. type: item #: doc/guix.texi:32782 #, no-wrap msgid "@code{thermald} (default: @var{thermald})" msgstr "" #. type: table #: doc/guix.texi:32784 msgid "Package object of thermald." msgstr "" #. type: Plain text #: doc/guix.texi:32793 msgid "" "The @code{(gnu services audio)} module provides a service to start MPD (the " "Music Player Daemon)." msgstr "" #. type: cindex #: doc/guix.texi:32794 #, no-wrap msgid "mpd" msgstr "" #. type: subsubheading #: doc/guix.texi:32795 #, no-wrap msgid "Music Player Daemon" msgstr "" #. type: Plain text #: doc/guix.texi:32800 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:32803 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: lisp #: doc/guix.texi:32809 #, no-wrap msgid "" "(service mpd-service-type\n" " (mpd-configuration\n" " (user \"bob\")\n" " (port \"6666\")))\n" msgstr "" #. type: defvr #: doc/guix.texi:32811 #, no-wrap msgid "{Scheme Variable} mpd-service-type" msgstr "" #. type: defvr #: doc/guix.texi:32813 msgid "The service type for @command{mpd}" msgstr "" #. type: deftp #: doc/guix.texi:32815 #, no-wrap msgid "{Data Type} mpd-configuration" msgstr "" #. type: deftp #: doc/guix.texi:32817 msgid "Data type representing the configuration of @command{mpd}." msgstr "" #. type: item #: doc/guix.texi:32819 #, no-wrap msgid "@code{user} (default: @code{\"mpd\"})" msgstr "" #. type: table #: doc/guix.texi:32821 msgid "The user to run mpd as." msgstr "" #. type: item #: doc/guix.texi:32822 #, no-wrap msgid "@code{music-dir} (default: @code{\"~/Music\"})" msgstr "" #. type: table #: doc/guix.texi:32824 msgid "The directory to scan for music files." msgstr "" #. type: item #: doc/guix.texi:32825 #, no-wrap msgid "@code{playlist-dir} (default: @code{\"~/.mpd/playlists\"})" msgstr "" #. type: table #: doc/guix.texi:32827 msgid "The directory to store playlists." msgstr "" #. type: item #: doc/guix.texi:32828 #, no-wrap msgid "@code{db-file} (default: @code{\"~/.mpd/tag_cache\"})" msgstr "" #. type: table #: doc/guix.texi:32830 msgid "The location of the music database." msgstr "" #. type: item #: doc/guix.texi:32831 #, no-wrap msgid "@code{state-file} (default: @code{\"~/.mpd/state\"})" msgstr "" #. type: table #: doc/guix.texi:32833 msgid "The location of the file that stores current MPD's state." msgstr "" #. type: item #: doc/guix.texi:32834 #, no-wrap msgid "@code{sticker-file} (default: @code{\"~/.mpd/sticker.sql\"})" msgstr "" #. type: table #: doc/guix.texi:32836 msgid "The location of the sticker database." msgstr "" #. type: item #: doc/guix.texi:32837 #, no-wrap msgid "@code{port} (default: @code{\"6600\"})" msgstr "" #. type: table #: doc/guix.texi:32839 msgid "The port to run mpd on." msgstr "" #. type: item #: doc/guix.texi:32840 #, no-wrap msgid "@code{address} (default: @code{\"any\"})" msgstr "" #. type: table #: doc/guix.texi:32843 msgid "" "The address that mpd will bind to. To use a Unix domain socket, an absolute " "path can be specified here." msgstr "" #. type: item #: doc/guix.texi:32844 #, no-wrap msgid "@code{outputs} (default: @code{\"(list (mpd-output))\"})" msgstr "" #. type: table #: doc/guix.texi:32846 msgid "" "The audio outputs that MPD can use. By default this is a single output " "using pulseaudio." msgstr "" #. type: deftp #: doc/guix.texi:32850 #, no-wrap msgid "{Data Type} mpd-output" msgstr "" #. type: deftp #: doc/guix.texi:32852 msgid "Data type representing an @command{mpd} audio output." msgstr "" #. type: item #: doc/guix.texi:32854 #, no-wrap msgid "@code{name} (default: @code{\"MPD\"})" msgstr "" #. type: table #: doc/guix.texi:32856 msgid "The name of the audio output." msgstr "" #. type: item #: doc/guix.texi:32857 #, no-wrap msgid "@code{type} (default: @code{\"pulse\"})" msgstr "" #. type: table #: doc/guix.texi:32859 msgid "The type of audio output." msgstr "" #. type: item #: doc/guix.texi:32860 #, no-wrap msgid "@code{enabled?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:32865 msgid "" "Specifies whether this audio output is enabled when MPD is started. By " "default, all audio outputs are enabled. This is just the default setting " "when there is no state file; with a state file, the previous state is " "restored." msgstr "" #. type: item #: doc/guix.texi:32866 #, no-wrap msgid "@code{tags?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:32870 msgid "" "If set to @code{#f}, then MPD will not send tags to this output. This is " "only useful for output plugins that can receive tags, for example the " "@code{httpd} output plugin." msgstr "" #. type: item #: doc/guix.texi:32871 #, no-wrap msgid "@code{always-on?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:32875 msgid "" "If set to @code{#t}, then MPD attempts to keep this audio output always " "open. This may be useful for streaming servers, when you don’t want to " "disconnect all listeners even when playback is accidentally stopped." msgstr "" #. type: code{#1} #: doc/guix.texi:32876 #, no-wrap msgid "mixer-type" msgstr "" #. type: table #: doc/guix.texi:32882 msgid "" "This field accepts a symbol that specifies which mixer should be used for " "this audio output: the @code{hardware} mixer, the @code{software} mixer, the " "@code{null} mixer (allows setting the volume, but with no effect; this can " "be used as a trick to implement an external mixer External Mixer) or no " "mixer (@code{none})." msgstr "" #. type: table #: doc/guix.texi:32886 msgid "" "An association list of option symbols to string values to be appended to the " "audio output configuration." msgstr "" #. type: Plain text #: doc/guix.texi:32892 msgid "" "The following example shows a configuration of @code{mpd} that provides an " "HTTP audio streaming output." msgstr "" #. type: lisp #: doc/guix.texi:32904 #, no-wrap msgid "" "(service mpd-service-type\n" " (mpd-configuration\n" " (outputs\n" " (list (mpd-output\n" " (name \"streaming\")\n" " (type \"httpd\")\n" " (mixer-type 'null)\n" " (extra-options\n" " `((encoder . \"vorbis\")\n" " (port . \"8080\"))))))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:32913 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:32914 #, no-wrap msgid "Libvirt daemon" msgstr "" #. type: Plain text #: doc/guix.texi:32919 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:32920 #, no-wrap msgid "{Scheme Variable} libvirt-service-type" msgstr "" #. type: deffn #: doc/guix.texi:32923 msgid "" "This is the type of the @uref{https://libvirt.org, libvirt daemon}. Its " "value must be a @code{libvirt-configuration}." msgstr "" #. type: lisp #: doc/guix.texi:32929 #, 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:32934 msgid "Available @code{libvirt-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:32935 #, no-wrap msgid "{@code{libvirt-configuration} parameter} package libvirt" msgstr "" #. type: deftypevar #: doc/guix.texi:32937 doc/guix.texi:33500 msgid "Libvirt package." msgstr "" #. type: deftypevr #: doc/guix.texi:32940 #, no-wrap msgid "{@code{libvirt-configuration} parameter} boolean listen-tls?" msgstr "" #. type: deftypevr #: doc/guix.texi:32943 msgid "" "Flag listening for secure TLS connections on the public TCP/IP port. You " "must set @code{listen} for this to have any effect." msgstr "" #. type: deftypevr #: doc/guix.texi:32946 msgid "" "It is necessary to setup a CA and issue server certificates before using " "this capability." msgstr "" #. type: deftypevr #: doc/guix.texi:32951 #, no-wrap msgid "{@code{libvirt-configuration} parameter} boolean listen-tcp?" msgstr "" #. type: deftypevr #: doc/guix.texi:32954 msgid "" "Listen for unencrypted TCP connections on the public TCP/IP port. You must " "set @code{listen} for this to have any effect." msgstr "" #. type: deftypevr #: doc/guix.texi:32958 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:32963 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string tls-port" msgstr "" #. type: deftypevr #: doc/guix.texi:32966 msgid "" "Port for accepting secure TLS connections. This can be a port number, or " "service name." msgstr "" #. type: deftypevr #: doc/guix.texi:32968 msgid "Defaults to @samp{\"16514\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:32971 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string tcp-port" msgstr "" #. type: deftypevr #: doc/guix.texi:32974 msgid "" "Port for accepting insecure TCP connections. This can be a port number, or " "service name." msgstr "" #. type: deftypevr #: doc/guix.texi:32976 msgid "Defaults to @samp{\"16509\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:32979 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string listen-addr" msgstr "" #. type: deftypevr #: doc/guix.texi:32981 msgid "IP address or hostname used for client connections." msgstr "" #. type: deftypevr #: doc/guix.texi:32986 #, no-wrap msgid "{@code{libvirt-configuration} parameter} boolean mdns-adv?" msgstr "" #. type: deftypevr #: doc/guix.texi:32988 msgid "Flag toggling mDNS advertisement of the libvirt service." msgstr "" #. type: deftypevr #: doc/guix.texi:32991 msgid "" "Alternatively can disable for all services on a host by stopping the Avahi " "daemon." msgstr "" #. type: deftypevr #: doc/guix.texi:32996 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string mdns-name" msgstr "" #. type: deftypevr #: doc/guix.texi:32999 msgid "" "Default mDNS advertisement name. This must be unique on the immediate " "broadcast network." msgstr "" #. type: deftypevr #: doc/guix.texi:33001 msgid "Defaults to @samp{\"Virtualization Host \"}." msgstr "" #. type: deftypevr #: doc/guix.texi:33004 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string unix-sock-group" msgstr "" #. type: deftypevr #: doc/guix.texi:33008 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:33013 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string unix-sock-ro-perms" msgstr "" #. type: deftypevr #: doc/guix.texi:33016 msgid "" "UNIX socket permissions for the R/O socket. This is used for monitoring VM " "status only." msgstr "" #. type: deftypevr #: doc/guix.texi:33018 doc/guix.texi:33036 msgid "Defaults to @samp{\"0777\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:33021 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string unix-sock-rw-perms" msgstr "" #. type: deftypevr #: doc/guix.texi:33025 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:33027 msgid "Defaults to @samp{\"0770\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:33030 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string unix-sock-admin-perms" msgstr "" #. type: deftypevr #: doc/guix.texi:33034 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:33039 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string unix-sock-dir" msgstr "" #. type: deftypevr #: doc/guix.texi:33041 msgid "The directory in which sockets will be found/created." msgstr "" #. type: deftypevr #: doc/guix.texi:33043 msgid "Defaults to @samp{\"/var/run/libvirt\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:33046 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string auth-unix-ro" msgstr "" #. type: deftypevr #: doc/guix.texi:33049 msgid "" "Authentication scheme for UNIX read-only sockets. By default socket " "permissions allow anyone to connect" msgstr "" #. type: deftypevr #: doc/guix.texi:33051 doc/guix.texi:33060 msgid "Defaults to @samp{\"polkit\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:33054 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string auth-unix-rw" msgstr "" #. type: deftypevr #: doc/guix.texi:33058 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:33063 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string auth-tcp" msgstr "" #. type: deftypevr #: doc/guix.texi:33067 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:33069 msgid "Defaults to @samp{\"sasl\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:33072 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string auth-tls" msgstr "" #. type: deftypevr #: doc/guix.texi:33076 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:33079 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:33081 msgid "Defaults to @samp{\"none\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:33084 #, no-wrap msgid "{@code{libvirt-configuration} parameter} optional-list access-drivers" msgstr "" #. type: deftypevr #: doc/guix.texi:33086 msgid "API access control scheme." msgstr "" #. type: deftypevr #: doc/guix.texi:33089 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:33094 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string key-file" msgstr "" #. type: deftypevr #: doc/guix.texi:33097 msgid "" "Server key file path. If set to an empty string, then no private key is " "loaded." msgstr "" #. type: deftypevr #: doc/guix.texi:33102 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string cert-file" msgstr "" #. type: deftypevr #: doc/guix.texi:33105 msgid "" "Server key file path. If set to an empty string, then no certificate is " "loaded." msgstr "" #. type: deftypevr #: doc/guix.texi:33110 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string ca-file" msgstr "" #. type: deftypevr #: doc/guix.texi:33113 msgid "" "Server key file path. If set to an empty string, then no CA certificate is " "loaded." msgstr "" #. type: deftypevr #: doc/guix.texi:33118 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string crl-file" msgstr "" #. type: deftypevr #: doc/guix.texi:33121 msgid "" "Certificate revocation list path. If set to an empty string, then no CRL is " "loaded." msgstr "" #. type: deftypevr #: doc/guix.texi:33126 #, no-wrap msgid "{@code{libvirt-configuration} parameter} boolean tls-no-sanity-cert" msgstr "" #. type: deftypevr #: doc/guix.texi:33128 msgid "Disable verification of our own server certificates." msgstr "" #. type: deftypevr #: doc/guix.texi:33131 msgid "" "When libvirtd starts it performs some sanity checks against its own " "certificates." msgstr "" #. type: deftypevr #: doc/guix.texi:33136 #, no-wrap msgid "{@code{libvirt-configuration} parameter} boolean tls-no-verify-cert" msgstr "" #. type: deftypevr #: doc/guix.texi:33138 msgid "Disable verification of client certificates." msgstr "" #. type: deftypevr #: doc/guix.texi:33142 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:33147 #, no-wrap msgid "{@code{libvirt-configuration} parameter} optional-list tls-allowed-dn-list" msgstr "" #. type: deftypevr #: doc/guix.texi:33149 msgid "Whitelist of allowed x509 Distinguished Name." msgstr "" #. type: deftypevr #: doc/guix.texi:33154 #, no-wrap msgid "{@code{libvirt-configuration} parameter} optional-list sasl-allowed-usernames" msgstr "" #. type: deftypevr #: doc/guix.texi:33157 msgid "" "Whitelist of allowed SASL usernames. The format for username depends on the " "SASL authentication mechanism." msgstr "" #. type: deftypevr #: doc/guix.texi:33162 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string tls-priority" msgstr "" #. type: deftypevr #: doc/guix.texi:33166 msgid "" "Override the compile time default TLS priority string. The default is " "usually @samp{\"NORMAL\"} unless overridden at build time. Only set this is " "it is desired for libvirt to deviate from the global default settings." msgstr "" #. type: deftypevr #: doc/guix.texi:33168 msgid "Defaults to @samp{\"NORMAL\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:33171 #, no-wrap msgid "{@code{libvirt-configuration} parameter} integer max-clients" msgstr "" #. type: deftypevr #: doc/guix.texi:33174 doc/guix.texi:33602 msgid "" "Maximum number of concurrent client connections to allow over all sockets " "combined." msgstr "" #. type: deftypevr #: doc/guix.texi:33176 msgid "Defaults to @samp{5000}." msgstr "" #. type: deftypevr #: doc/guix.texi:33179 #, no-wrap msgid "{@code{libvirt-configuration} parameter} integer max-queued-clients" msgstr "" #. type: deftypevr #: doc/guix.texi:33183 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:33188 #, no-wrap msgid "{@code{libvirt-configuration} parameter} integer max-anonymous-clients" msgstr "" #. type: deftypevr #: doc/guix.texi:33191 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:33193 doc/guix.texi:33211 doc/guix.texi:33227 msgid "Defaults to @samp{20}." msgstr "" #. type: deftypevr #: doc/guix.texi:33196 #, no-wrap msgid "{@code{libvirt-configuration} parameter} integer min-workers" msgstr "" #. type: deftypevr #: doc/guix.texi:33198 msgid "Number of workers to start up initially." msgstr "" #. type: deftypevr #: doc/guix.texi:33203 #, no-wrap msgid "{@code{libvirt-configuration} parameter} integer max-workers" msgstr "" #. type: deftypevr #: doc/guix.texi:33205 msgid "Maximum number of worker threads." msgstr "" #. type: deftypevr #: doc/guix.texi:33209 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:33214 #, no-wrap msgid "{@code{libvirt-configuration} parameter} integer prio-workers" msgstr "" #. type: deftypevr #: doc/guix.texi:33218 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:33223 #, no-wrap msgid "{@code{libvirt-configuration} parameter} integer max-requests" msgstr "" #. type: deftypevr #: doc/guix.texi:33225 msgid "Total global limit on concurrent RPC calls." msgstr "" #. type: deftypevr #: doc/guix.texi:33230 #, no-wrap msgid "{@code{libvirt-configuration} parameter} integer max-client-requests" msgstr "" #. type: deftypevr #: doc/guix.texi:33234 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:33239 #, no-wrap msgid "{@code{libvirt-configuration} parameter} integer admin-min-workers" msgstr "" #. type: deftypevr #: doc/guix.texi:33241 msgid "Same as @code{min-workers} but for the admin interface." msgstr "" #. type: deftypevr #: doc/guix.texi:33246 #, no-wrap msgid "{@code{libvirt-configuration} parameter} integer admin-max-workers" msgstr "" #. type: deftypevr #: doc/guix.texi:33248 msgid "Same as @code{max-workers} but for the admin interface." msgstr "" #. type: deftypevr #: doc/guix.texi:33253 #, no-wrap msgid "{@code{libvirt-configuration} parameter} integer admin-max-clients" msgstr "" #. type: deftypevr #: doc/guix.texi:33255 msgid "Same as @code{max-clients} but for the admin interface." msgstr "" #. type: deftypevr #: doc/guix.texi:33260 #, no-wrap msgid "{@code{libvirt-configuration} parameter} integer admin-max-queued-clients" msgstr "" #. type: deftypevr #: doc/guix.texi:33262 msgid "Same as @code{max-queued-clients} but for the admin interface." msgstr "" #. type: deftypevr #: doc/guix.texi:33267 #, no-wrap msgid "{@code{libvirt-configuration} parameter} integer admin-max-client-requests" msgstr "" #. type: deftypevr #: doc/guix.texi:33269 msgid "Same as @code{max-client-requests} but for the admin interface." msgstr "" #. type: deftypevr #: doc/guix.texi:33274 #, no-wrap msgid "{@code{libvirt-configuration} parameter} integer log-level" msgstr "" #. type: deftypevr #: doc/guix.texi:33276 doc/guix.texi:33504 msgid "Logging level. 4 errors, 3 warnings, 2 information, 1 debug." msgstr "" #. type: deftypevr #: doc/guix.texi:33278 doc/guix.texi:33506 msgid "Defaults to @samp{3}." msgstr "" #. type: deftypevr #: doc/guix.texi:33281 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string log-filters" msgstr "" #. type: deftypevr #: doc/guix.texi:33283 doc/guix.texi:33511 msgid "Logging filters." msgstr "" #. type: deftypevr #: doc/guix.texi:33286 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:33290 doc/guix.texi:33518 msgid "x:name" msgstr "" #. type: itemize #: doc/guix.texi:33293 doc/guix.texi:33521 msgid "x:+name" msgstr "" #. type: deftypevr #: doc/guix.texi:33304 msgid "" "where @code{name} is a string which is matched against the category given in " "the @code{VIR_LOG_INIT()} at the top of each libvirt source file, e.g., " "@samp{\"remote\"}, @samp{\"qemu\"}, or @samp{\"util.json\"} (the name in the " "filter can be a substring of the full category name, in order to match " "multiple similar categories), the optional @samp{\"+\"} prefix tells libvirt " "to log stack trace for each message matching name, and @code{x} is the " "minimal level where matching messages should be logged:" msgstr "" #. type: itemize #: doc/guix.texi:33308 doc/guix.texi:33353 doc/guix.texi:33535 #: doc/guix.texi:33580 msgid "1: DEBUG" msgstr "" #. type: itemize #: doc/guix.texi:33311 doc/guix.texi:33356 doc/guix.texi:33538 #: doc/guix.texi:33583 msgid "2: INFO" msgstr "" #. type: itemize #: doc/guix.texi:33314 doc/guix.texi:33359 doc/guix.texi:33541 #: doc/guix.texi:33586 msgid "3: WARNING" msgstr "" #. type: itemize #: doc/guix.texi:33317 doc/guix.texi:33362 doc/guix.texi:33544 #: doc/guix.texi:33589 msgid "4: ERROR" msgstr "" #. type: deftypevr #: doc/guix.texi:33322 doc/guix.texi:33549 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:33324 doc/guix.texi:33551 msgid "Defaults to @samp{\"3:remote 4:event\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:33327 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string log-outputs" msgstr "" #. type: deftypevr #: doc/guix.texi:33329 doc/guix.texi:33556 msgid "Logging outputs." msgstr "" #. type: deftypevr #: doc/guix.texi:33332 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:33334 doc/guix.texi:33561 #, no-wrap msgid "x:stderr" msgstr "" #. type: table #: doc/guix.texi:33336 doc/guix.texi:33563 msgid "output goes to stderr" msgstr "" #. type: item #: doc/guix.texi:33337 doc/guix.texi:33564 #, no-wrap msgid "x:syslog:name" msgstr "" #. type: table #: doc/guix.texi:33339 doc/guix.texi:33566 msgid "use syslog for the output and use the given name as the ident" msgstr "" #. type: item #: doc/guix.texi:33340 doc/guix.texi:33567 #, no-wrap msgid "x:file:file_path" msgstr "" #. type: table #: doc/guix.texi:33342 doc/guix.texi:33569 msgid "output to a file, with the given filepath" msgstr "" #. type: item #: doc/guix.texi:33343 doc/guix.texi:33570 #, no-wrap msgid "x:journald" msgstr "" #. type: table #: doc/guix.texi:33345 doc/guix.texi:33572 msgid "output to journald logging system" msgstr "" #. type: deftypevr #: doc/guix.texi:33349 doc/guix.texi:33576 msgid "In all case the x prefix is the minimal level, acting as a filter" msgstr "" #. type: deftypevr #: doc/guix.texi:33367 doc/guix.texi:33594 msgid "" "Multiple outputs can be defined, they just need to be separated by spaces." msgstr "" #. type: deftypevr #: doc/guix.texi:33369 doc/guix.texi:33596 msgid "Defaults to @samp{\"3:stderr\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:33372 #, no-wrap msgid "{@code{libvirt-configuration} parameter} integer audit-level" msgstr "" #. type: deftypevr #: doc/guix.texi:33374 msgid "Allows usage of the auditing subsystem to be altered" msgstr "" #. type: itemize #: doc/guix.texi:33378 msgid "0: disable all auditing" msgstr "" #. type: itemize #: doc/guix.texi:33381 msgid "1: enable auditing, only if enabled on host" msgstr "" #. type: itemize #: doc/guix.texi:33384 msgid "2: enable auditing, and exit if disabled on host." msgstr "" #. type: deftypevr #: doc/guix.texi:33391 #, no-wrap msgid "{@code{libvirt-configuration} parameter} boolean audit-logging" msgstr "" #. type: deftypevr #: doc/guix.texi:33393 msgid "Send audit messages via libvirt logging infrastructure." msgstr "" #. type: deftypevr #: doc/guix.texi:33398 #, no-wrap msgid "{@code{libvirt-configuration} parameter} optional-string host-uuid" msgstr "" #. type: deftypevr #: doc/guix.texi:33400 msgid "Host UUID@. UUID must not have all digits be the same." msgstr "" #. type: deftypevr #: doc/guix.texi:33405 #, no-wrap msgid "{@code{libvirt-configuration} parameter} string host-uuid-source" msgstr "" #. type: deftypevr #: doc/guix.texi:33407 msgid "Source to read host UUID." msgstr "" #. type: itemize #: doc/guix.texi:33411 msgid "@code{smbios}: fetch the UUID from @code{dmidecode -s system-uuid}" msgstr "" #. type: itemize #: doc/guix.texi:33414 msgid "@code{machine-id}: fetch the UUID from @code{/etc/machine-id}" msgstr "" #. type: deftypevr #: doc/guix.texi:33419 msgid "" "If @code{dmidecode} does not provide a valid UUID a temporary UUID will be " "generated." msgstr "" #. type: deftypevr #: doc/guix.texi:33421 msgid "Defaults to @samp{\"smbios\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:33424 #, no-wrap msgid "{@code{libvirt-configuration} parameter} integer keepalive-interval" msgstr "" #. type: deftypevr #: doc/guix.texi:33429 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:33434 #, no-wrap msgid "{@code{libvirt-configuration} parameter} integer keepalive-count" msgstr "" #. type: deftypevr #: doc/guix.texi:33438 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:33445 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:33450 #, no-wrap msgid "{@code{libvirt-configuration} parameter} integer admin-keepalive-interval" msgstr "" #. type: deftypevr #: doc/guix.texi:33452 doc/guix.texi:33459 msgid "Same as above but for admin interface." msgstr "" #. type: deftypevr #: doc/guix.texi:33457 #, no-wrap msgid "{@code{libvirt-configuration} parameter} integer admin-keepalive-count" msgstr "" #. type: deftypevr #: doc/guix.texi:33464 #, no-wrap msgid "{@code{libvirt-configuration} parameter} integer ovs-timeout" msgstr "" #. type: deftypevr #: doc/guix.texi:33466 msgid "Timeout for Open vSwitch calls." msgstr "" #. type: deftypevr #: doc/guix.texi:33470 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:33477 #, no-wrap msgid "Virtlog daemon" msgstr "" #. type: Plain text #: doc/guix.texi:33480 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:33486 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:33487 #, no-wrap msgid "{Scheme Variable} virtlog-service-type" msgstr "" #. type: deffn #: doc/guix.texi:33490 msgid "" "This is the type of the virtlog daemon. Its value must be a @code{virtlog-" "configuration}." msgstr "" #. type: lisp #: doc/guix.texi:33495 #, no-wrap msgid "" "(service virtlog-service-type\n" " (virtlog-configuration\n" " (max-clients 1000)))\n" msgstr "" #. type: deftypevar #: doc/guix.texi:33498 #, no-wrap msgid "{@code{libvirt} parameter} package libvirt" msgstr "" #. type: deftypevr #: doc/guix.texi:33502 #, no-wrap msgid "{@code{virtlog-configuration} parameter} integer log-level" msgstr "" #. type: deftypevr #: doc/guix.texi:33509 #, no-wrap msgid "{@code{virtlog-configuration} parameter} string log-filters" msgstr "" #. type: deftypevr #: doc/guix.texi:33514 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: deftypevr #: doc/guix.texi:33531 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: deftypevr #: doc/guix.texi:33554 #, no-wrap msgid "{@code{virtlog-configuration} parameter} string log-outputs" msgstr "" #. type: deftypevr #: doc/guix.texi:33559 msgid "" "An output is one of the places to save logging information The format for an " "output can be:" msgstr "" #. type: deftypevr #: doc/guix.texi:33599 #, no-wrap msgid "{@code{virtlog-configuration} parameter} integer max-clients" msgstr "" #. type: deftypevr #: doc/guix.texi:33604 msgid "Defaults to @samp{1024}." msgstr "" #. type: deftypevr #: doc/guix.texi:33607 #, no-wrap msgid "{@code{virtlog-configuration} parameter} integer max-size" msgstr "" #. type: deftypevr #: doc/guix.texi:33609 msgid "Maximum file size before rolling over." msgstr "" #. type: deftypevr #: doc/guix.texi:33611 msgid "Defaults to @samp{2MB}" msgstr "" #. type: deftypevr #: doc/guix.texi:33614 #, no-wrap msgid "{@code{virtlog-configuration} parameter} integer max-backups" msgstr "" #. type: deftypevr #: doc/guix.texi:33616 msgid "Maximum number of backup files to keep." msgstr "" #. type: deftypevr #: doc/guix.texi:33618 msgid "Defaults to @samp{3}" msgstr "" #. type: anchor{#1} #: doc/guix.texi:33622 msgid "transparent-emulation-qemu" msgstr "" #. type: subsubheading #: doc/guix.texi:33622 #, no-wrap msgid "Transparent Emulation with QEMU" msgstr "" #. type: cindex #: doc/guix.texi:33624 doc/guix.texi:33704 #, no-wrap msgid "emulation" msgstr "" #. type: code{#1} #: doc/guix.texi:33625 #, no-wrap msgid "binfmt_misc" msgstr "" #. type: Plain text #: doc/guix.texi:33633 msgid "" "@code{qemu-binfmt-service-type} provides support for transparent emulation " "of program binaries built for different architectures---e.g., it allows you " "to transparently execute an ARMv7 program on an x86_64 machine. It achieves " "this by combining the @uref{https://www.qemu.org, QEMU} emulator and the " "@code{binfmt_misc} feature of the kernel Linux. This feature only allows " "you to emulate GNU/Linux on a different architecture, but see below for GNU/" "Hurd support." msgstr "" #. type: defvr #: doc/guix.texi:33634 #, no-wrap msgid "{Scheme Variable} qemu-binfmt-service-type" msgstr "" #. type: defvr #: doc/guix.texi:33639 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: lisp #: doc/guix.texi:33644 #, no-wrap msgid "" "(service qemu-binfmt-service-type\n" " (qemu-binfmt-configuration\n" " (platforms (lookup-qemu-platforms \"arm\" \"aarch64\"))))\n" msgstr "" #. type: defvr #: doc/guix.texi:33650 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:33652 #, no-wrap msgid "{Data Type} qemu-binfmt-configuration" msgstr "" #. type: deftp #: doc/guix.texi:33654 msgid "This is the configuration for the @code{qemu-binfmt} service." msgstr "" #. type: item #: doc/guix.texi:33656 #, no-wrap msgid "@code{platforms} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:33659 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: table #: doc/guix.texi:33662 msgid "" "For example, let's suppose you're on an x86_64 machine and you have this " "service:" msgstr "" #. type: lisp #: doc/guix.texi:33667 #, no-wrap msgid "" "(service qemu-binfmt-service-type\n" " (qemu-binfmt-configuration\n" " (platforms (lookup-qemu-platforms \"arm\"))))\n" msgstr "" #. type: table #: doc/guix.texi:33670 msgid "You can run:" msgstr "" #. type: example #: doc/guix.texi:33673 #, no-wrap msgid "guix build -s armhf-linux inkscape\n" msgstr "" #. type: table #: doc/guix.texi:33680 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:33681 #, no-wrap msgid "@code{qemu} (default: @code{qemu})" msgstr "" #. type: table #: doc/guix.texi:33683 doc/guix.texi:33741 doc/guix.texi:33823 msgid "The QEMU package to use." msgstr "" #. type: deffn #: doc/guix.texi:33686 #, no-wrap msgid "{Scheme Procedure} lookup-qemu-platforms @var{platforms}@dots{}" msgstr "" #. type: deffn #: doc/guix.texi:33691 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:33693 #, no-wrap msgid "{Scheme Procedure} qemu-platform? @var{obj}" msgstr "" #. type: deffn #: doc/guix.texi:33695 msgid "Return true if @var{obj} is a platform object." msgstr "" #. type: deffn #: doc/guix.texi:33697 #, no-wrap msgid "{Scheme Procedure} qemu-platform-name @var{platform}" msgstr "" #. type: deffn #: doc/guix.texi:33699 msgid "Return the name of @var{platform}---a string such as @code{\"arm\"}." msgstr "" #. type: subsubheading #: doc/guix.texi:33702 #, no-wrap msgid "QEMU Guest Agent" msgstr "" #. type: Plain text #: doc/guix.texi:33710 msgid "" "The QEMU guest agent provides control over the emulated system to the host. " "The @code{qemu-guest-agent} service runs the agent on Guix guests. To " "control the agent from the host, open a socket by invoking QEMU with the " "following arguments:" msgstr "" #. type: example #: doc/guix.texi:33717 #, no-wrap msgid "" "qemu-system-x86_64 \\\n" "\t-chardev socket,path=/tmp/qga.sock,server=on,wait=off,id=qga0 \\\n" "\t-device virtio-serial \\\n" "\t-device virtserialport,chardev=qga0,name=org.qemu.guest_agent.0 \\\n" "\t...\n" msgstr "" #. type: Plain text #: doc/guix.texi:33721 msgid "" "This creates a socket at @file{/tmp/qga.sock} on the host. Once the guest " "agent is running, you can issue commands with @code{socat}:" msgstr "" #. type: example #: doc/guix.texi:33726 #, no-wrap msgid "" "$ guix shell socat -- socat unix-connect:/tmp/qga.sock stdio\n" "@{\"execute\": \"guest-get-host-name\"@}\n" "@{\"return\": @{\"host-name\": \"guix\"@}@}\n" msgstr "" #. type: Plain text #: doc/guix.texi:33730 msgid "" "See @url{https://wiki.qemu.org/Features/GuestAgent,QEMU guest agent " "documentation} for more options and commands." msgstr "" #. type: defvr #: doc/guix.texi:33731 #, no-wrap msgid "{Scheme Variable} qemu-guest-agent-service-type" msgstr "" #. type: defvr #: doc/guix.texi:33733 msgid "Service type for the QEMU guest agent service." msgstr "" #. type: deftp #: doc/guix.texi:33735 #, no-wrap msgid "{Data Type} qemu-guest-agent-configuration" msgstr "" #. type: deftp #: doc/guix.texi:33737 msgid "Configuration for the @code{qemu-guest-agent} service." msgstr "" #. type: item #: doc/guix.texi:33739 doc/guix.texi:33821 #, no-wrap msgid "@code{qemu} (default: @code{qemu-minimal})" msgstr "" #. type: item #: doc/guix.texi:33742 #, no-wrap msgid "@code{device} (default: @code{\"\"})" msgstr "" #. type: table #: doc/guix.texi:33745 msgid "" "File name of the device or socket the agent uses to communicate with the " "host. If empty, QEMU uses a default file name." msgstr "" #. type: subsubheading #: doc/guix.texi:33749 #, no-wrap msgid "The Hurd in a Virtual Machine" msgstr "" #. type: cindex #: doc/guix.texi:33752 #, no-wrap msgid "the Hurd" msgstr "" #. type: cindex #: doc/guix.texi:33753 #, no-wrap msgid "childhurd" msgstr "" #. type: Plain text #: doc/guix.texi:33761 msgid "" "Service @code{hurd-vm} provides support for running GNU/Hurd in a virtual " "machine (VM), a so-called @dfn{childhurd}. This service is meant to be used " "on GNU/Linux and the given GNU/Hurd operating system configuration is cross-" "compiled. The virtual machine is a Shepherd service that can be referred to " "by the names @code{hurd-vm} and @code{childhurd} and be controlled with " "commands such as:" msgstr "" #. type: example #: doc/guix.texi:33765 #, no-wrap msgid "" "herd start hurd-vm\n" "herd stop childhurd\n" msgstr "" #. type: Plain text #: doc/guix.texi:33769 msgid "" "When the service is running, you can view its console by connecting to it " "with a VNC client, for example with:" msgstr "" #. type: example #: doc/guix.texi:33772 #, no-wrap msgid "guix shell tigervnc-client -- vncviewer localhost:5900\n" msgstr "" #. type: Plain text #: doc/guix.texi:33778 msgid "" "The default configuration (see @code{hurd-vm-configuration} below) spawns a " "secure shell (SSH) server in your GNU/Hurd system, which QEMU (the virtual " "machine emulator) redirects to port 10222 on the host. Thus, you can " "connect over SSH to the childhurd with:" msgstr "" #. type: example #: doc/guix.texi:33781 #, no-wrap msgid "ssh root@@localhost -p 10022\n" msgstr "" #. type: Plain text #: doc/guix.texi:33790 msgid "" "The childhurd is volatile and stateless: it starts with a fresh root file " "system every time you restart it. By default though, all the files under " "@file{/etc/childhurd} on the host are copied as is to the root file system " "of the childhurd when it boots. This allows you to initialize ``secrets'' " "inside the VM: SSH host keys, authorized substitute keys, and so on---see " "the explanation of @code{secret-root} below." msgstr "" #. type: defvr #: doc/guix.texi:33791 #, no-wrap msgid "{Scheme Variable} hurd-vm-service-type" msgstr "" #. type: defvr #: doc/guix.texi:33797 msgid "" "This is the type of the Hurd in a Virtual Machine service. Its value must " "be a @code{hurd-vm-configuration} object, which specifies the operating " "system (@pxref{operating-system Reference}) and the disk size for the Hurd " "Virtual Machine, the QEMU package to use as well as the options for running " "it." msgstr "" #. type: deffn #: doc/guix.texi:33799 doc/guix.texi:37274 doc/contributing.texi:979 msgid "For example:" msgstr "" #. type: lisp #: doc/guix.texi:33805 #, no-wrap msgid "" "(service hurd-vm-service-type\n" " (hurd-vm-configuration\n" " (disk-size (* 5000 (expt 2 20))) ;5G\n" " (memory-size 1024))) ;1024MiB\n" msgstr "" #. type: defvr #: doc/guix.texi:33809 msgid "" "would create a disk image big enough to build GNU@tie{}Hello, with some " "extra memory." msgstr "" #. type: deftp #: doc/guix.texi:33811 #, no-wrap msgid "{Data Type} hurd-vm-configuration" msgstr "" #. type: deftp #: doc/guix.texi:33814 msgid "" "The data type representing the configuration for @code{hurd-vm-service-type}." msgstr "" #. type: item #: doc/guix.texi:33816 #, no-wrap msgid "@code{os} (default: @var{%hurd-vm-operating-system})" msgstr "" #. type: table #: doc/guix.texi:33820 msgid "" "The operating system to instantiate. This default is bare-bones with a " "permissive OpenSSH secure shell daemon listening on port 2222 " "(@pxref{Networking Services, @code{openssh-service-type}})." msgstr "" #. type: item #: doc/guix.texi:33824 #, no-wrap msgid "@code{image} (default: @var{hurd-vm-disk-image})" msgstr "" #. type: table #: doc/guix.texi:33827 msgid "" "The procedure used to build the disk-image built from this configuration." msgstr "" #. type: item #: doc/guix.texi:33828 #, no-wrap msgid "@code{disk-size} (default: @code{'guess})" msgstr "" #. type: table #: doc/guix.texi:33830 msgid "The size of the disk image." msgstr "" #. type: item #: doc/guix.texi:33831 #, no-wrap msgid "@code{memory-size} (default: @code{512})" msgstr "" #. type: table #: doc/guix.texi:33833 msgid "The memory size of the Virtual Machine in mebibytes." msgstr "" #. type: item #: doc/guix.texi:33834 #, no-wrap msgid "@code{options} (default: @code{'(\"--snapshot\")})" msgstr "" #. type: table #: doc/guix.texi:33836 msgid "The extra options for running QEMU." msgstr "" #. type: table #: doc/guix.texi:33841 msgid "" "If set, a non-zero positive integer used to parameterize Childhurd " "instances. It is appended to the service's name, e.g. @code{childhurd1}." msgstr "" #. type: item #: doc/guix.texi:33842 #, no-wrap msgid "@code{net-options} (default: @var{hurd-vm-net-options})" msgstr "" #. type: table #: doc/guix.texi:33844 msgid "The procedure used to produce the list of QEMU networking options." msgstr "" #. type: table #: doc/guix.texi:33846 msgid "By default, it produces" msgstr "" #. type: lisp #: doc/guix.texi:33854 #, no-wrap msgid "" "'(\"--device\" \"rtl8139,netdev=net0\"\n" " \"--netdev\" (string-append\n" " \"user,id=net0,\"\n" " \"hostfwd=tcp:127.0.0.1:@var{secrets-port}-:1004,\"\n" " \"hostfwd=tcp:127.0.0.1:@var{ssh-port}-:2222,\"\n" " \"hostfwd=tcp:127.0.0.1:@var{vnc-port}-:5900\"))\n" msgstr "" #. type: table #: doc/guix.texi:33857 msgid "with forwarded ports:" msgstr "" #. type: example #: doc/guix.texi:33862 #, no-wrap msgid "" "@var{secrets-port}: @code{(+ 11004 (* 1000 @var{ID}))}\n" "@var{ssh-port}: @code{(+ 10022 (* 1000 @var{ID}))}\n" "@var{vnc-port}: @code{(+ 15900 (* 1000 @var{ID}))}\n" msgstr "" #. type: item #: doc/guix.texi:33864 #, no-wrap msgid "@code{secret-root} (default: @file{/etc/childhurd})" msgstr "" #. type: table #: doc/guix.texi:33869 msgid "" "The root directory with out-of-band secrets to be installed into the " "childhurd once it runs. Childhurds are volatile which means that on every " "startup, secrets such as the SSH host keys and Guix signing key are " "recreated." msgstr "" #. type: table #: doc/guix.texi:33873 msgid "" "If the @file{/etc/childhurd} directory does not exist, the @code{secret-" "service} running in the Childhurd will be sent an empty list of secrets." msgstr "" #. type: table #: doc/guix.texi:33876 msgid "" "By default, the service automatically populates @file{/etc/childhurd} with " "the following non-volatile secrets, unless they already exist:" msgstr "" #. type: example #: doc/guix.texi:33885 #, no-wrap msgid "" "/etc/childhurd/etc/guix/acl\n" "/etc/childhurd/etc/guix/signing-key.pub\n" "/etc/childhurd/etc/guix/signing-key.sec\n" "/etc/childhurd/etc/ssh/ssh_host_ed25519_key\n" "/etc/childhurd/etc/ssh/ssh_host_ecdsa_key\n" "/etc/childhurd/etc/ssh/ssh_host_ed25519_key.pub\n" "/etc/childhurd/etc/ssh/ssh_host_ecdsa_key.pub\n" msgstr "" #. type: table #: doc/guix.texi:33889 msgid "" "These files are automatically sent to the guest Hurd VM when it boots, " "including permissions." msgstr "" #. type: cindex #: doc/guix.texi:33890 #, no-wrap msgid "childhurd, offloading" msgstr "" #. type: cindex #: doc/guix.texi:33891 #, no-wrap msgid "Hurd, offloading" msgstr "" #. type: table #: doc/guix.texi:33895 msgid "" "Having these files in place means that only a couple of things are missing " "to allow the host to offload @code{i586-gnu} builds to the childhurd:" msgstr "" #. type: enumerate #: doc/guix.texi:33900 msgid "" "Authorizing the childhurd's key on the host so that the host accepts build " "results coming from the childhurd, which can be done like so:" msgstr "" #. type: example #: doc/guix.texi:33904 #, no-wrap msgid "" "guix archive --authorize < \\\n" " /etc/childhurd/etc/guix/signing-key.pub\n" msgstr "" #. type: enumerate #: doc/guix.texi:33909 msgid "" "Adding the childhurd to @file{/etc/guix/machines.scm} (@pxref{Daemon Offload " "Setup})." msgstr "" #. type: table #: doc/guix.texi:33913 msgid "" "We're working towards making that happen automatically---get in touch with " "us at @email{guix-devel@@gnu.org} to discuss it!" msgstr "" #. type: Plain text #: doc/guix.texi:33920 msgid "" "Note that by default the VM image is volatile, i.e., once stopped the " "contents are lost. If you want a stateful image instead, override the " "configuration's @code{image} and @code{options} without the @code{--" "snapshot} flag using something along these lines:" msgstr "" #. type: lisp #: doc/guix.texi:33926 #, no-wrap msgid "" "(service hurd-vm-service-type\n" " (hurd-vm-configuration\n" " (image (const \"/out/of/store/writable/hurd.img\"))\n" " (options '())))\n" msgstr "" #. type: subsubheading #: doc/guix.texi:33928 #, no-wrap msgid "Ganeti" msgstr "" #. type: cindex #: doc/guix.texi:33930 #, no-wrap msgid "ganeti" msgstr "" #. type: quotation #: doc/guix.texi:33937 msgid "" "This service is considered experimental. Configuration options may be " "changed in a backwards-incompatible manner, and not all features have been " "thorougly tested. Users of this service are encouraged to share their " "experience at @email{guix-devel@@gnu.org}." msgstr "" #. type: Plain text #: doc/guix.texi:33947 msgid "" "Ganeti is a virtual machine management system. It is designed to keep " "virtual machines running on a cluster of servers even in the event of " "hardware failures, and to make maintenance and recovery tasks easy. It " "consists of multiple services which are described later in this section. In " "addition to the Ganeti service, you will need the OpenSSH service " "(@pxref{Networking Services, @code{openssh-service-type}}), and update the " "@file{/etc/hosts} file (@pxref{operating-system Reference, @code{hosts-" "file}}) with the cluster name and address (or use a DNS server)." msgstr "" #. type: Plain text #: doc/guix.texi:33952 msgid "" "All nodes participating in a Ganeti cluster should have the same Ganeti and " "@file{/etc/hosts} configuration. Here is an example configuration for a " "Ganeti cluster node that supports multiple storage backends, and installs " "the @code{debootstrap} and @code{guix} @dfn{OS providers}:" msgstr "" #. type: lisp #: doc/guix.texi:33962 #, no-wrap msgid "" "(use-package-modules virtualization)\n" "(use-service-modules base ganeti networking ssh)\n" "(operating-system\n" " ;; @dots{}\n" " (host-name \"node1\")\n" " (hosts-file (plain-file \"hosts\" (format #f \"\n" "127.0.0.1 localhost\n" "::1 localhost\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:33967 #, no-wrap msgid "" "192.168.1.200 ganeti.example.com\n" "192.168.1.201 node1.example.com node1\n" "192.168.1.202 node2.example.com node2\n" "\")))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:33988 #, no-wrap msgid "" " ;; Install QEMU so we can use KVM-based instances, and LVM, DRBD and Ceph\n" " ;; in order to use the \"plain\", \"drbd\" and \"rbd\" storage backends.\n" " (packages (append (map specification->package\n" " '(\"qemu\" \"lvm2\" \"drbd-utils\" \"ceph\"\n" " ;; Add the debootstrap and guix OS providers.\n" " \"ganeti-instance-guix\" \"ganeti-instance-debootstrap\"))\n" " %base-packages))\n" " (services\n" " (append (list (service static-networking-service-type\n" " (list (static-networking\n" " (addresses\n" " (list (network-address\n" " (device \"eth0\")\n" " (value \"192.168.1.201/24\"))))\n" " (routes\n" " (list (network-route\n" " (destination \"default\")\n" " (gateway \"192.168.1.254\"))))\n" " (name-servers '(\"192.168.1.252\"\n" " \"192.168.1.253\")))))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:33993 #, no-wrap msgid "" " ;; Ganeti uses SSH to communicate between nodes.\n" " (service openssh-service-type\n" " (openssh-configuration\n" " (permit-root-login 'prohibit-password)))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:34003 #, no-wrap msgid "" " (service ganeti-service-type\n" " (ganeti-configuration\n" " ;; This list specifies allowed file system paths\n" " ;; for storing virtual machine images.\n" " (file-storage-paths '(\"/srv/ganeti/file-storage\"))\n" " ;; This variable configures a single \"variant\" for\n" " ;; both Debootstrap and Guix that works with KVM.\n" " (os %default-ganeti-os))))\n" " %base-services)))\n" msgstr "" #. type: Plain text #: doc/guix.texi:34011 msgid "" "Users are advised to read the @url{https://docs.ganeti.org/docs/ganeti/3.0/" "html/admin.html,Ganeti administrators guide} to learn about the various " "cluster options and day-to-day operations. There is also a @url{https://" "guix.gnu.org/blog/2020/running-a-ganeti-cluster-on-guix/,blog post} " "describing how to configure and initialize a small cluster." msgstr "" #. type: defvr #: doc/guix.texi:34012 #, no-wrap msgid "{Scheme Variable} ganeti-service-type" msgstr "" #. type: defvr #: doc/guix.texi:34015 msgid "" "This is a service type that includes all the various services that Ganeti " "nodes should run." msgstr "" #. type: defvr #: doc/guix.texi:34020 msgid "" "Its value is a @code{ganeti-configuration} object that defines the package " "to use for CLI operations, as well as configuration for the various " "daemons. Allowed file storage paths and available guest operating systems " "are also configured through this data type." msgstr "" #. type: deftp #: doc/guix.texi:34022 #, no-wrap msgid "{Data Type} ganeti-configuration" msgstr "" #. type: deftp #: doc/guix.texi:34024 msgid "The @code{ganeti} service takes the following configuration options:" msgstr "" #. type: item #: doc/guix.texi:34026 doc/guix.texi:34272 doc/guix.texi:34322 #: doc/guix.texi:34352 doc/guix.texi:34379 doc/guix.texi:34411 #: doc/guix.texi:34464 doc/guix.texi:34484 doc/guix.texi:34510 #: doc/guix.texi:34543 doc/guix.texi:34583 #, no-wrap msgid "@code{ganeti} (default: @code{ganeti})" msgstr "" #. type: table #: doc/guix.texi:34031 msgid "" "The @code{ganeti} package to use. It will be installed to the system " "profile and make @command{gnt-cluster}, @command{gnt-instance}, etc " "available. Note that the value specified here does not affect the other " "services as each refer to a specific @code{ganeti} package (see below)." msgstr "" #. type: item #: doc/guix.texi:34032 #, no-wrap msgid "@code{noded-configuration} (default: @code{(ganeti-noded-configuration)})" msgstr "" #. type: itemx #: doc/guix.texi:34033 #, no-wrap msgid "@code{confd-configuration} (default: @code{(ganeti-confd-configuration)})" msgstr "" #. type: itemx #: doc/guix.texi:34034 #, no-wrap msgid "@code{wconfd-configuration} (default: @code{(ganeti-wconfd-configuration)})" msgstr "" #. type: itemx #: doc/guix.texi:34035 #, no-wrap msgid "@code{luxid-configuration} (default: @code{(ganeti-luxid-configuration)})" msgstr "" #. type: itemx #: doc/guix.texi:34036 #, no-wrap msgid "@code{rapi-configuration} (default: @code{(ganeti-rapi-configuration)})" msgstr "" #. type: itemx #: doc/guix.texi:34037 #, no-wrap msgid "@code{kvmd-configuration} (default: @code{(ganeti-kvmd-configuration)})" msgstr "" #. type: itemx #: doc/guix.texi:34038 #, no-wrap msgid "@code{mond-configuration} (default: @code{(ganeti-mond-configuration)})" msgstr "" #. type: itemx #: doc/guix.texi:34039 #, no-wrap msgid "@code{metad-configuration} (default: @code{(ganeti-metad-configuration)})" msgstr "" #. type: itemx #: doc/guix.texi:34040 #, no-wrap msgid "@code{watcher-configuration} (default: @code{(ganeti-watcher-configuration)})" msgstr "" #. type: itemx #: doc/guix.texi:34041 #, no-wrap msgid "@code{cleaner-configuration} (default: @code{(ganeti-cleaner-configuration)})" msgstr "" #. type: table #: doc/guix.texi:34046 msgid "" "These options control the various daemons and cron jobs that are distributed " "with Ganeti. The possible values for these are described in detail below. " "To override a setting, you must use the configuration type for that service:" msgstr "" #. type: lisp #: doc/guix.texi:34056 #, no-wrap msgid "" "(service ganeti-service-type\n" " (ganeti-configuration\n" " (rapi-configuration\n" " (ganeti-rapi-configuration\n" " (interface \"eth1\"))))\n" " (watcher-configuration\n" " (ganeti-watcher-configuration\n" " (rapi-ip \"10.0.0.1\"))))\n" msgstr "" #. type: item #: doc/guix.texi:34058 #, no-wrap msgid "@code{file-storage-paths} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:34060 msgid "List of allowed directories for file storage backend." msgstr "" #. type: item #: doc/guix.texi:34061 #, no-wrap msgid "@code{os} (default: @code{%default-ganeti-os})" msgstr "" #. type: table #: doc/guix.texi:34063 msgid "List of @code{} records." msgstr "" #. type: deftp #: doc/guix.texi:34067 msgid "" "In essence @code{ganeti-service-type} is shorthand for declaring each " "service individually:" msgstr "" #. type: lisp #: doc/guix.texi:34078 #, no-wrap msgid "" "(service ganeti-noded-service-type)\n" "(service ganeti-confd-service-type)\n" "(service ganeti-wconfd-service-type)\n" "(service ganeti-luxid-service-type)\n" "(service ganeti-kvmd-service-type)\n" "(service ganeti-mond-service-type)\n" "(service ganeti-metad-service-type)\n" "(service ganeti-watcher-service-type)\n" "(service ganeti-cleaner-service-type)\n" msgstr "" #. type: deftp #: doc/guix.texi:34082 msgid "" "Plus a service extension for @code{etc-service-type} that configures the " "file storage backend and OS variants." msgstr "" #. type: deftp #: doc/guix.texi:34085 #, no-wrap msgid "{Data Type} ganeti-os" msgstr "" #. type: deftp #: doc/guix.texi:34088 msgid "" "This data type is suitable for passing to the @code{os} parameter of " "@code{ganeti-configuration}. It takes the following parameters:" msgstr "" #. type: table #: doc/guix.texi:34094 msgid "" "The name for this OS provider. It is only used to specify where the " "configuration ends up. Setting it to ``debootstrap'' will create @file{/etc/" "ganeti/instance-debootstrap}." msgstr "" #. type: item #: doc/guix.texi:34095 #, no-wrap msgid "@code{extension} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:34098 msgid "" "The file extension for variants of this OS type. For example @file{.conf} " "or @file{.scm}. It will be appended to the variant file name if set." msgstr "" #. type: item #: doc/guix.texi:34099 #, no-wrap msgid "@code{variants} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:34103 msgid "" "This must be either a list of @code{ganeti-os-variant} objects for this OS, " "or a ``file-like'' object (@pxref{G-Expressions, file-like objects}) " "representing the variants directory." msgstr "" #. type: table #: doc/guix.texi:34107 msgid "" "To use the Guix OS provider with variant definitions residing in a local " "directory instead of declaring individual variants (see @var{guix-variants} " "below), you can do:" msgstr "" #. type: lisp #: doc/guix.texi:34113 #, no-wrap msgid "" "(ganeti-os\n" " (name \"guix\")\n" " (variants (local-file \"ganeti-guix-variants\"\n" " #:recursive? #true)))\n" msgstr "" #. type: table #: doc/guix.texi:34119 msgid "" "Note that you will need to maintain the @file{variants.list} file (see " "@code{@url{https://docs.ganeti.org/docs/ganeti/3.0/man/ganeti-os-interface." "html, ganeti-os-interface(7)}}) manually in this case." msgstr "" #. type: deftp #: doc/guix.texi:34123 #, no-wrap msgid "{Data Type} ganeti-os-variant" msgstr "" #. type: deftp #: doc/guix.texi:34126 msgid "" "This is the data type for a Ganeti OS variant. It takes the following " "parameters:" msgstr "" #. type: table #: doc/guix.texi:34130 msgid "The name of this variant." msgstr "" #. type: code{#1} #: doc/guix.texi:34131 #, no-wrap msgid "configuration" msgstr "" #. type: table #: doc/guix.texi:34133 msgid "A configuration file for this variant." msgstr "" #. type: defvr #: doc/guix.texi:34136 #, no-wrap msgid "{Scheme Variable} %default-debootstrap-hooks" msgstr "" #. type: defvr #: doc/guix.texi:34138 msgid "" "This variable contains hooks to configure networking and the GRUB bootloader." msgstr "" #. type: defvr #: doc/guix.texi:34140 #, no-wrap msgid "{Scheme Variable} %default-debootstrap-extra-pkgs" msgstr "" #. type: defvr #: doc/guix.texi:34142 msgid "" "This variable contains a list of packages suitable for a fully-virtualized " "guest." msgstr "" #. type: deftp #: doc/guix.texi:34144 #, no-wrap msgid "{Data Type} debootstrap-configuration" msgstr "" #. type: deftp #: doc/guix.texi:34147 msgid "" "This data type creates configuration files suitable for the debootstrap OS " "provider." msgstr "" #. type: item #: doc/guix.texi:34149 #, no-wrap msgid "@code{hooks} (default: @code{%default-debootstrap-hooks})" msgstr "" #. type: table #: doc/guix.texi:34153 msgid "" "When not @code{#f}, this must be a G-expression that specifies a directory " "with scripts that will run when the OS is installed. It can also be a list " "of @code{(name . file-like)} pairs. For example:" msgstr "" #. type: lisp #: doc/guix.texi:34156 #, no-wrap msgid "`((99-hello-world . ,(plain-file \"#!/bin/sh\\necho Hello, World\")))\n" msgstr "" #. type: table #: doc/guix.texi:34161 msgid "" "That will create a directory with one executable named @code{99-hello-world} " "and run it every time this variant is installed. If set to @code{#f}, hooks " "in @file{/etc/ganeti/instance-debootstrap/hooks} will be used, if any." msgstr "" #. type: item #: doc/guix.texi:34161 #, no-wrap msgid "@code{proxy} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:34163 msgid "Optional HTTP proxy to use." msgstr "" #. type: item #: doc/guix.texi:34163 doc/guix.texi:36393 #, no-wrap msgid "@code{mirror} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:34166 msgid "" "The Debian mirror. Typically something like @code{http://ftp.no.debian.org/" "debian}. The default varies depending on the distribution." msgstr "" #. type: item #: doc/guix.texi:34166 #, no-wrap msgid "@code{arch} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:34169 msgid "" "The dpkg architecture. Set to @code{armhf} to debootstrap an ARMv7 instance " "on an AArch64 host. Default is to use the current system architecture." msgstr "" #. type: item #: doc/guix.texi:34169 #, no-wrap msgid "@code{suite} (default: @code{\"stable\"})" msgstr "" #. type: table #: doc/guix.texi:34172 msgid "" "When set, this must be a Debian distribution ``suite'' such as @code{buster} " "or @code{focal}. If set to @code{#f}, the default for the OS provider is " "used." msgstr "" #. type: item #: doc/guix.texi:34172 #, no-wrap msgid "@code{extra-pkgs} (default: @code{%default-debootstrap-extra-pkgs})" msgstr "" #. type: table #: doc/guix.texi:34175 msgid "" "List of extra packages that will get installed by dpkg in addition to the " "minimal system." msgstr "" #. type: item #: doc/guix.texi:34175 #, no-wrap msgid "@code{components} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:34178 msgid "" "When set, must be a list of Debian repository ``components''. For example " "@code{'(\"main\" \"contrib\")}." msgstr "" #. type: item #: doc/guix.texi:34178 #, no-wrap msgid "@code{generate-cache?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:34180 msgid "Whether to automatically cache the generated debootstrap archive." msgstr "" #. type: item #: doc/guix.texi:34180 #, no-wrap msgid "@code{clean-cache} (default: @code{14})" msgstr "" #. type: table #: doc/guix.texi:34183 msgid "" "Discard the cache after this amount of days. Use @code{#f} to never clear " "the cache." msgstr "" #. type: item #: doc/guix.texi:34183 #, no-wrap msgid "@code{partition-style} (default: @code{'msdos})" msgstr "" #. type: table #: doc/guix.texi:34186 msgid "" "The type of partition to create. When set, it must be one of @code{'msdos}, " "@code{'none} or a string." msgstr "" #. type: item #: doc/guix.texi:34186 #, no-wrap msgid "@code{partition-alignment} (default: @code{2048})" msgstr "" #. type: table #: doc/guix.texi:34188 msgid "Alignment of the partition in sectors." msgstr "" #. type: deffn #: doc/guix.texi:34191 #, no-wrap msgid "{Scheme Procedure} debootstrap-variant @var{name} @var{configuration}" msgstr "" #. type: deffn #: doc/guix.texi:34194 msgid "" "This is a helper procedure that creates a @code{ganeti-os-variant} record. " "It takes two parameters: a name and a @code{debootstrap-configuration} " "object." msgstr "" #. type: deffn #: doc/guix.texi:34196 #, no-wrap msgid "{Scheme Procedure} debootstrap-os @var{variants}@dots{}" msgstr "" #. type: deffn #: doc/guix.texi:34199 msgid "" "This is a helper procedure that creates a @code{ganeti-os} record. It takes " "a list of variants created with @code{debootstrap-variant}." msgstr "" #. type: deffn #: doc/guix.texi:34201 #, no-wrap msgid "{Scheme Procedure} guix-variant @var{name} @var{configuration}" msgstr "" #. type: deffn #: doc/guix.texi:34206 msgid "" "This is a helper procedure that creates a @code{ganeti-os-variant} record " "for use with the Guix OS provider. It takes a name and a G-expression that " "returns a ``file-like'' (@pxref{G-Expressions, file-like objects}) object " "containing a Guix System configuration." msgstr "" #. type: deffn #: doc/guix.texi:34208 #, no-wrap msgid "{Scheme Procedure} guix-os @var{variants}@dots{}" msgstr "" #. type: deffn #: doc/guix.texi:34211 msgid "" "This is a helper procedure that creates a @code{ganeti-os} record. It takes " "a list of variants produced by @code{guix-variant}." msgstr "" #. type: defvr #: doc/guix.texi:34213 #, no-wrap msgid "{Scheme Variable} %default-debootstrap-variants" msgstr "" #. type: defvr #: doc/guix.texi:34217 msgid "" "This is a convenience variable to make the debootstrap provider work ``out " "of the box'' without users having to declare variants manually. It contains " "a single debootstrap variant with the default configuration:" msgstr "" #. type: lisp #: doc/guix.texi:34222 #, no-wrap msgid "" "(list (debootstrap-variant\n" " \"default\"\n" " (debootstrap-configuration)))\n" msgstr "" #. type: defvr #: doc/guix.texi:34225 #, no-wrap msgid "{Scheme Variable} %default-guix-variants" msgstr "" #. type: defvr #: doc/guix.texi:34229 msgid "" "This is a convenience variable to make the Guix OS provider work without " "additional configuration. It creates a virtual machine that has an SSH " "server, a serial console, and authorizes the Ganeti hosts SSH keys." msgstr "" #. type: lisp #: doc/guix.texi:34235 #, no-wrap msgid "" "(list (guix-variant\n" " \"default\"\n" " (file-append ganeti-instance-guix\n" " \"/share/doc/ganeti-instance-guix/examples/dynamic.scm\")))\n" msgstr "" #. type: Plain text #: doc/guix.texi:34241 msgid "" "Users can implement support for OS providers unbeknownst to Guix by " "extending the @code{ganeti-os} and @code{ganeti-os-variant} records " "appropriately. For example:" msgstr "" #. type: lisp #: doc/guix.texi:34250 #, no-wrap msgid "" "(ganeti-os\n" " (name \"custom\")\n" " (extension \".conf\")\n" " (variants\n" " (list (ganeti-os-variant\n" " (name \"foo\")\n" " (configuration (plain-file \"bar\" \"this is fine\"))))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:34255 msgid "" "That creates @file{/etc/ganeti/instance-custom/variants/foo.conf} which " "points to a file in the store with contents @code{this is fine}. It also " "creates @file{/etc/ganeti/instance-custom/variants/variants.list} with " "contents @code{foo}." msgstr "" #. type: Plain text #: doc/guix.texi:34258 msgid "" "Obviously this may not work for all OS providers out there. If you find the " "interface limiting, please reach out to @email{guix-devel@@gnu.org}." msgstr "" #. type: Plain text #: doc/guix.texi:34261 msgid "" "The rest of this section documents the various services that are included by " "@code{ganeti-service-type}." msgstr "" #. type: defvr #: doc/guix.texi:34262 #, no-wrap msgid "{Scheme Variable} ganeti-noded-service-type" msgstr "" #. type: defvr #: doc/guix.texi:34266 msgid "" "@command{ganeti-noded} is the daemon responsible for node-specific functions " "within the Ganeti system. The value of this service must be a @code{ganeti-" "noded-configuration} object." msgstr "" #. type: deftp #: doc/guix.texi:34268 #, no-wrap msgid "{Data Type} ganeti-noded-configuration" msgstr "" #. type: deftp #: doc/guix.texi:34270 msgid "This is the configuration for the @code{ganeti-noded} service." msgstr "" #. type: table #: doc/guix.texi:34274 doc/guix.texi:34324 doc/guix.texi:34354 #: doc/guix.texi:34381 doc/guix.texi:34413 doc/guix.texi:34466 #: doc/guix.texi:34486 doc/guix.texi:34512 doc/guix.texi:34545 msgid "The @code{ganeti} package to use for this service." msgstr "" #. type: item #: doc/guix.texi:34275 #, no-wrap msgid "@code{port} (default: @code{1811})" msgstr "" #. type: table #: doc/guix.texi:34277 msgid "The TCP port on which the node daemon listens for network requests." msgstr "" #. type: item #: doc/guix.texi:34278 doc/guix.texi:34328 doc/guix.texi:34420 #: doc/guix.texi:34490 #, no-wrap msgid "@code{address} (default: @code{\"0.0.0.0\"})" msgstr "" #. type: table #: doc/guix.texi:34281 msgid "" "The network address that the daemon will bind to. The default address means " "bind to all available addresses." msgstr "" #. type: table #: doc/guix.texi:34285 msgid "" "When this is set, it must be a specific network interface (e.g.@: " "@code{eth0}) that the daemon will bind to." msgstr "" #. type: item #: doc/guix.texi:34286 doc/guix.texi:34428 #, no-wrap msgid "@code{max-clients} (default: @code{20})" msgstr "" #. type: table #: doc/guix.texi:34290 msgid "" "This sets a limit on the maximum number of simultaneous client connections " "that the daemon will handle. Connections above this count are accepted, but " "no responses will be sent until enough connections have closed." msgstr "" #. type: item #: doc/guix.texi:34291 doc/guix.texi:34433 #, no-wrap msgid "@code{ssl?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:34295 msgid "" "Whether to use SSL/TLS to encrypt network communications. The certificate " "is automatically provisioned by the cluster and can be rotated with " "@command{gnt-cluster renew-crypto}." msgstr "" #. type: item #: doc/guix.texi:34296 doc/guix.texi:34436 #, no-wrap msgid "@code{ssl-key} (default: @file{\"/var/lib/ganeti/server.pem\"})" msgstr "" #. type: table #: doc/guix.texi:34298 doc/guix.texi:34438 msgid "" "This can be used to provide a specific encryption key for TLS communications." msgstr "" #. type: item #: doc/guix.texi:34299 doc/guix.texi:34439 #, no-wrap msgid "@code{ssl-cert} (default: @file{\"/var/lib/ganeti/server.pem\"})" msgstr "" #. type: table #: doc/guix.texi:34301 doc/guix.texi:34441 msgid "" "This can be used to provide a specific certificate for TLS communications." msgstr "" #. type: table #: doc/guix.texi:34305 doc/guix.texi:34445 msgid "" "When true, the daemon performs additional logging for debugging purposes. " "Note that this will leak encryption details to the log files, use with " "caution." msgstr "" #. type: defvr #: doc/guix.texi:34309 #, no-wrap msgid "{Scheme Variable} ganeti-confd-service-type" msgstr "" #. type: defvr #: doc/guix.texi:34315 msgid "" "@command{ganeti-confd} answers queries related to the configuration of a " "Ganeti cluster. The purpose of this daemon is to have a highly available " "and fast way to query cluster configuration values. It is automatically " "active on all @dfn{master candidates}. The value of this service must be a " "@code{ganeti-confd-configuration} object." msgstr "" #. type: deftp #: doc/guix.texi:34318 #, no-wrap msgid "{Data Type} ganeti-confd-configuration" msgstr "" #. type: deftp #: doc/guix.texi:34320 msgid "This is the configuration for the @code{ganeti-confd} service." msgstr "" #. type: item #: doc/guix.texi:34325 #, no-wrap msgid "@code{port} (default: @code{1814})" msgstr "" #. type: table #: doc/guix.texi:34327 msgid "The UDP port on which to listen for network requests." msgstr "" #. type: table #: doc/guix.texi:34330 msgid "Network address that the daemon will bind to." msgstr "" #. type: table #: doc/guix.texi:34333 doc/guix.texi:34362 doc/guix.texi:34389 #: doc/guix.texi:34469 doc/guix.texi:34496 doc/guix.texi:34522 msgid "" "When true, the daemon performs additional logging for debugging purposes." msgstr "" #. type: defvr #: doc/guix.texi:34337 #, no-wrap msgid "{Scheme Variable} ganeti-wconfd-service-type" msgstr "" #. type: defvr #: doc/guix.texi:34343 msgid "" "@command{ganeti-wconfd} is the daemon that has authoritative knowledge about " "the cluster configuration and is the only entity that can accept changes to " "it. All jobs that need to modify the configuration will do so by sending " "appropriate requests to this daemon. It only runs on the @dfn{master node} " "and will automatically disable itself on other nodes." msgstr "" #. type: defvr #: doc/guix.texi:34346 msgid "" "The value of this service must be a @code{ganeti-wconfd-configuration} " "object." msgstr "" #. type: deftp #: doc/guix.texi:34348 #, no-wrap msgid "{Data Type} ganeti-wconfd-configuration" msgstr "" #. type: deftp #: doc/guix.texi:34350 msgid "This is the configuration for the @code{ganeti-wconfd} service." msgstr "" #. type: item #: doc/guix.texi:34355 doc/guix.texi:34382 #, no-wrap msgid "@code{no-voting?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:34359 msgid "" "The daemon will refuse to start if the majority of cluster nodes does not " "agree that it is running on the master node. Set to @code{#t} to start even " "if a quorum can not be reached (dangerous, use with caution)." msgstr "" #. type: defvr #: doc/guix.texi:34366 #, no-wrap msgid "{Scheme Variable} ganeti-luxid-service-type" msgstr "" #. type: defvr #: doc/guix.texi:34371 msgid "" "@command{ganeti-luxid} is a daemon used to answer queries related to the " "configuration and the current live state of a Ganeti cluster. Additionally, " "it is the authoritative daemon for the Ganeti job queue. Jobs can be " "submitted via this daemon and it schedules and starts them." msgstr "" #. type: defvr #: doc/guix.texi:34373 msgid "It takes a @code{ganeti-luxid-configuration} object." msgstr "" #. type: deftp #: doc/guix.texi:34375 #, no-wrap msgid "{Data Type} ganeti-luxid-configuration" msgstr "" #. type: deftp #: doc/guix.texi:34377 msgid "This is the configuration for the @code{ganeti-luxid} service." msgstr "" #. type: table #: doc/guix.texi:34386 msgid "" "The daemon will refuse to start if it cannot verify that the majority of " "cluster nodes believes that it is running on the master node. Set to " "@code{#t} to ignore such checks and start anyway (this can be dangerous)." msgstr "" #. type: defvr #: doc/guix.texi:34393 #, no-wrap msgid "{Scheme Variable} ganeti-rapi-service-type" msgstr "" #. type: defvr #: doc/guix.texi:34397 msgid "" "@command{ganeti-rapi} provides a remote API for Ganeti clusters. It runs on " "the master node and can be used to perform cluster actions programmatically " "via a JSON-based RPC protocol." msgstr "" #. type: defvr #: doc/guix.texi:34403 msgid "" "Most query operations are allowed without authentication (unless " "@var{require-authentication?} is set), whereas write operations require " "explicit authorization via the @file{/var/lib/ganeti/rapi/users} file. See " "the @url{https://docs.ganeti.org/docs/ganeti/3.0/html/rapi.html, Ganeti " "Remote API documentation} for more information." msgstr "" #. type: defvr #: doc/guix.texi:34405 msgid "" "The value of this service must be a @code{ganeti-rapi-configuration} object." msgstr "" #. type: deftp #: doc/guix.texi:34407 #, no-wrap msgid "{Data Type} ganeti-rapi-configuration" msgstr "" #. type: deftp #: doc/guix.texi:34409 msgid "This is the configuration for the @code{ganeti-rapi} service." msgstr "" #. type: item #: doc/guix.texi:34414 #, no-wrap msgid "@code{require-authentication?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:34416 msgid "Whether to require authentication even for read-only operations." msgstr "" #. type: item #: doc/guix.texi:34417 #, no-wrap msgid "@code{port} (default: @code{5080})" msgstr "" #. type: table #: doc/guix.texi:34419 msgid "The TCP port on which to listen to API requests." msgstr "" #. type: table #: doc/guix.texi:34423 msgid "" "The network address that the service will bind to. By default it listens on " "all configured addresses." msgstr "" #. type: table #: doc/guix.texi:34427 msgid "" "When set, it must specify a specific network interface such as @code{eth0} " "that the daemon will bind to." msgstr "" #. type: table #: doc/guix.texi:34432 msgid "" "The maximum number of simultaneous client requests to handle. Further " "connections are allowed, but no responses are sent until enough connections " "have closed." msgstr "" #. type: table #: doc/guix.texi:34435 msgid "Whether to use SSL/TLS encryption on the RAPI port." msgstr "" #. type: defvr #: doc/guix.texi:34449 #, no-wrap msgid "{Scheme Variable} ganeti-kvmd-service-type" msgstr "" #. type: defvr #: doc/guix.texi:34457 msgid "" "@command{ganeti-kvmd} is responsible for determining whether a given KVM " "instance was shut down by an administrator or a user. Normally Ganeti will " "restart an instance that was not stopped through Ganeti itself. If the " "cluster option @code{user_shutdown} is true, this daemon monitors the " "@code{QMP} socket provided by QEMU and listens for shutdown events, and " "marks the instance as @dfn{USER_down} instead of @dfn{ERROR_down} when it " "shuts down gracefully by itself." msgstr "" #. type: defvr #: doc/guix.texi:34459 msgid "It takes a @code{ganeti-kvmd-configuration} object." msgstr "" #. type: deftp #: doc/guix.texi:34461 #, no-wrap msgid "{Data Type} ganeti-kvmd-configuration" msgstr "" #. type: defvr #: doc/guix.texi:34473 #, no-wrap msgid "{Scheme Variable} ganeti-mond-service-type" msgstr "" #. type: defvr #: doc/guix.texi:34477 msgid "" "@command{ganeti-mond} is an optional daemon that provides Ganeti monitoring " "functionality. It is responsible for running data collectors and publish " "the collected information through a HTTP interface." msgstr "" #. type: defvr #: doc/guix.texi:34479 msgid "It takes a @code{ganeti-mond-configuration} object." msgstr "" #. type: deftp #: doc/guix.texi:34481 #, no-wrap msgid "{Data Type} ganeti-mond-configuration" msgstr "" #. type: item #: doc/guix.texi:34487 #, no-wrap msgid "@code{port} (default: @code{1815})" msgstr "" #. type: table #: doc/guix.texi:34489 doc/guix.texi:34515 msgid "The port on which the daemon will listen." msgstr "" #. type: table #: doc/guix.texi:34493 msgid "" "The network address that the daemon will bind to. By default it binds to " "all available interfaces." msgstr "" #. type: defvr #: doc/guix.texi:34500 #, no-wrap msgid "{Scheme Variable} ganeti-metad-service-type" msgstr "" #. type: defvr #: doc/guix.texi:34503 msgid "" "@command{ganeti-metad} is an optional daemon that can be used to provide " "information about the cluster to instances or OS install scripts." msgstr "" #. type: defvr #: doc/guix.texi:34505 msgid "It takes a @code{ganeti-metad-configuration} object." msgstr "" #. type: deftp #: doc/guix.texi:34507 #, no-wrap msgid "{Data Type} ganeti-metad-configuration" msgstr "" #. type: table #: doc/guix.texi:34519 msgid "" "If set, the daemon will bind to this address only. If left unset, the " "behavior depends on the cluster configuration." msgstr "" #. type: defvr #: doc/guix.texi:34526 #, no-wrap msgid "{Scheme Variable} ganeti-watcher-service-type" msgstr "" #. type: defvr #: doc/guix.texi:34534 msgid "" "@command{ganeti-watcher} is a script designed to run periodically and ensure " "the health of a cluster. It will automatically restart instances that have " "stopped without Ganeti's consent, and repairs DRBD links in case a node has " "rebooted. It also archives old cluster jobs and restarts Ganeti daemons " "that are not running. If the cluster parameter @code{ensure_node_health} is " "set, the watcher will also shutdown instances and DRBD devices if the node " "it is running on is declared offline by known master candidates." msgstr "" #. type: defvr #: doc/guix.texi:34536 msgid "It can be paused on all nodes with @command{gnt-cluster watcher pause}." msgstr "" #. type: defvr #: doc/guix.texi:34538 msgid "The service takes a @code{ganeti-watcher-configuration} object." msgstr "" #. type: deftp #: doc/guix.texi:34540 #, no-wrap msgid "{Data Type} ganeti-watcher-configuration" msgstr "" #. type: item #: doc/guix.texi:34546 #, no-wrap msgid "@code{schedule} (default: @code{'(next-second-from (next-minute (range 0 60 5)))})" msgstr "" #. type: table #: doc/guix.texi:34548 msgid "How often to run the script. The default is every five minutes." msgstr "" #. type: item #: doc/guix.texi:34549 #, no-wrap msgid "@code{rapi-ip} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:34552 msgid "" "This option needs to be specified only if the RAPI daemon is configured to " "use a particular interface or address. By default the cluster address is " "used." msgstr "" #. type: item #: doc/guix.texi:34553 #, no-wrap msgid "@code{job-age} (default: @code{(* 6 3600)})" msgstr "" #. type: table #: doc/guix.texi:34556 msgid "" "Archive cluster jobs older than this age, specified in seconds. The default " "is 6 hours. This keeps @command{gnt-job list} manageable." msgstr "" #. type: item #: doc/guix.texi:34557 #, no-wrap msgid "@code{verify-disks?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:34561 msgid "" "If this is @code{#f}, the watcher will not try to repair broken DRBD links " "automatically. Administrators will need to use @command{gnt-cluster verify-" "disks} manually instead." msgstr "" #. type: table #: doc/guix.texi:34564 msgid "" "When @code{#t}, the script performs additional logging for debugging " "purposes." msgstr "" #. type: defvr #: doc/guix.texi:34568 #, no-wrap msgid "{Scheme Variable} ganeti-cleaner-service-type" msgstr "" #. type: defvr #: doc/guix.texi:34576 msgid "" "@command{ganeti-cleaner} is a script designed to run periodically and remove " "old files from the cluster. This service type controls two @dfn{cron jobs}: " "one intended for the master node that permanently purges old cluster jobs, " "and one intended for every node that removes expired X509 certificates, " "keys, and outdated @command{ganeti-watcher} information. Like all Ganeti " "services, it is safe to include even on non-master nodes as it will disable " "itself as necessary." msgstr "" #. type: defvr #: doc/guix.texi:34578 msgid "It takes a @code{ganeti-cleaner-configuration} object." msgstr "" #. type: deftp #: doc/guix.texi:34580 #, no-wrap msgid "{Data Type} ganeti-cleaner-configuration" msgstr "" #. type: table #: doc/guix.texi:34585 msgid "The @code{ganeti} package to use for the @command{gnt-cleaner} command." msgstr "" #. type: item #: doc/guix.texi:34586 #, no-wrap msgid "@code{master-schedule} (default: @code{\"45 1 * * *\"})" msgstr "" #. type: table #: doc/guix.texi:34589 msgid "" "How often to run the master cleaning job. The default is once per day, at " "01:45:00." msgstr "" #. type: item #: doc/guix.texi:34590 #, no-wrap msgid "@code{node-schedule} (default: @code{\"45 2 * * *\"})" msgstr "" #. type: table #: doc/guix.texi:34593 msgid "" "How often to run the node cleaning job. The default is once per day, at " "02:45:00." msgstr "" #. type: Plain text #: doc/guix.texi:34607 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:34608 #, no-wrap msgid "{Scheme Procedure} git-daemon-service [#:config (git-daemon-configuration)]" msgstr "" #. type: deffn #: doc/guix.texi:34612 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:34618 msgid "" "The optional @var{config} argument should be a @code{} object, by default it allows read-only access to " "exported@footnote{By creating the magic file @file{git-daemon-export-ok} in " "the repository directory.} repositories under @file{/srv/git}." msgstr "" #. type: deftp #: doc/guix.texi:34621 #, no-wrap msgid "{Data Type} git-daemon-configuration" msgstr "" #. type: deftp #: doc/guix.texi:34623 msgid "Data type representing the configuration for @code{git-daemon-service}." msgstr "" #. type: item #: doc/guix.texi:34625 #, no-wrap msgid "@code{package} (default: @code{git})" msgstr "" #. type: table #: doc/guix.texi:34627 doc/guix.texi:34687 msgid "Package object of the Git distributed version control system." msgstr "" #. type: item #: doc/guix.texi:34628 doc/guix.texi:34691 #, no-wrap msgid "@code{export-all?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:34631 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:34632 #, no-wrap msgid "@code{base-path} (default: @file{/srv/git})" msgstr "" #. type: table #: doc/guix.texi:34638 msgid "" "Whether to remap all the path requests as relative to the given path. If " "you run @command{git daemon} with @code{(base-path \"/srv/git\")} on " "@samp{example.com}, then if you later try to pull @indicateurl{git://example." "com/hello.git}, git daemon will interpret the path as @file{/srv/git/hello." "git}." msgstr "" #. type: item #: doc/guix.texi:34639 #, no-wrap msgid "@code{user-path} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:34647 msgid "" "Whether to allow @code{~user} notation to be used in requests. When " "specified with empty string, requests to @indicateurl{git://host/~alice/foo} " "is taken as a request to access @code{foo} repository in the home directory " "of user @code{alice}. If @code{(user-path \"@var{path}\")} is specified, " "the same request is taken as a request to access @file{@var{path}/foo} " "repository in the home directory of user @code{alice}." msgstr "" #. type: item #: doc/guix.texi:34648 #, no-wrap msgid "@code{listen} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:34651 msgid "" "Whether to listen on specific IP addresses or hostnames, defaults to all." msgstr "" #. type: item #: doc/guix.texi:34652 #, no-wrap msgid "@code{port} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:34654 msgid "Whether to listen on an alternative port, which defaults to 9418." msgstr "" #. type: item #: doc/guix.texi:34655 #, no-wrap msgid "@code{whitelist} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:34657 msgid "If not empty, only allow access to this list of directories." msgstr "" #. type: table #: doc/guix.texi:34661 msgid "" "Extra options will be passed to @command{git daemon}, please run " "@command{man git-daemon} for more information." msgstr "" #. type: Plain text #: doc/guix.texi:34675 msgid "" "The @code{git://} protocol lacks authentication. When you pull from a " "repository fetched via @code{git://}, you don't know whether the data you " "receive was modified or is even coming from the specified host, and your " "connection is subject to eavesdropping. It's better to use an authenticated " "and encrypted transport, such as @code{https}. Although Git allows you to " "serve repositories using unsophisticated file-based web servers, there is a " "faster protocol implemented by the @code{git-http-backend} program. This " "program is the back-end of a proper Git web service. It is designed to sit " "behind a FastCGI proxy. @xref{Web Services}, for more on running the " "necessary @code{fcgiwrap} daemon." msgstr "" #. type: Plain text #: doc/guix.texi:34678 msgid "" "Guix has a separate configuration data type for serving Git repositories " "over HTTP." msgstr "" #. type: deftp #: doc/guix.texi:34679 #, no-wrap msgid "{Data Type} git-http-configuration" msgstr "" #. type: deftp #: doc/guix.texi:34683 msgid "" "Data type representing the configuration for a future @code{git-http-service-" "type}; can currently be used to configure Nginx through @code{git-http-nginx-" "location-configuration}." msgstr "" #. type: item #: doc/guix.texi:34685 #, no-wrap msgid "@code{package} (default: @var{git})" msgstr "" #. type: item #: doc/guix.texi:34688 #, no-wrap msgid "@code{git-root} (default: @file{/srv/git})" msgstr "" #. type: table #: doc/guix.texi:34690 msgid "Directory containing the Git repositories to expose to the world." msgstr "" #. type: table #: doc/guix.texi:34694 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:34695 #, no-wrap msgid "@code{uri-path} (default: @samp{/git/})" msgstr "" #. type: table #: doc/guix.texi:34700 msgid "" "Path prefix for Git access. With the default @samp{/git/} prefix, this will " "map @indicateurl{http://@var{server}/git/@var{repo}.git} to @file{/srv/git/" "@var{repo}.git}. Requests whose URI paths do not begin with this prefix are " "not passed on to this Git instance." msgstr "" #. type: item #: doc/guix.texi:34701 #, no-wrap msgid "@code{fcgiwrap-socket} (default: @code{127.0.0.1:9000})" msgstr "" #. type: table #: doc/guix.texi:34704 msgid "" "The socket on which the @code{fcgiwrap} daemon is listening. @xref{Web " "Services}." msgstr "" #. type: Plain text #: doc/guix.texi:34711 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:34712 #, no-wrap msgid "{Scheme Procedure} git-http-nginx-location-configuration @" msgstr "" #. type: deffn #: doc/guix.texi:34717 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: lisp #: doc/guix.texi:34734 #, 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:34741 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:34743 #, no-wrap msgid "Cgit Service" msgstr "" #. type: cindex #: doc/guix.texi:34745 #, no-wrap msgid "Cgit service" msgstr "" #. type: cindex #: doc/guix.texi:34746 #, no-wrap msgid "Git, web interface" msgstr "" #. type: Plain text #: doc/guix.texi:34749 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:34752 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: lisp #: doc/guix.texi:34755 #, no-wrap msgid "(service cgit-service-type)\n" msgstr "" #. type: Plain text #: doc/guix.texi:34759 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:34763 msgid "Available @code{cgit-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:34764 #, no-wrap msgid "{@code{cgit-configuration} parameter} package package" msgstr "" #. type: deftypevr #: doc/guix.texi:34766 msgid "The CGIT package." msgstr "" #. type: deftypevr #: doc/guix.texi:34769 #, no-wrap msgid "{@code{cgit-configuration} parameter} nginx-server-configuration-list nginx" msgstr "" #. type: deftypevr #: doc/guix.texi:34771 msgid "NGINX configuration." msgstr "" #. type: deftypevr #: doc/guix.texi:34774 #, no-wrap msgid "{@code{cgit-configuration} parameter} file-object about-filter" msgstr "" #. type: deftypevr #: doc/guix.texi:34777 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:34782 #, no-wrap msgid "{@code{cgit-configuration} parameter} string agefile" msgstr "" #. type: deftypevr #: doc/guix.texi:34785 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:34790 #, no-wrap msgid "{@code{cgit-configuration} parameter} file-object auth-filter" msgstr "" #. type: deftypevr #: doc/guix.texi:34793 msgid "" "Specifies a command that will be invoked for authenticating repository " "access." msgstr "" #. type: deftypevr #: doc/guix.texi:34798 #, no-wrap msgid "{@code{cgit-configuration} parameter} string branch-sort" msgstr "" #. type: deftypevr #: doc/guix.texi:34801 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:34803 msgid "Defaults to @samp{\"name\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:34806 #, no-wrap msgid "{@code{cgit-configuration} parameter} string cache-root" msgstr "" #. type: deftypevr #: doc/guix.texi:34808 msgid "Path used to store the cgit cache entries." msgstr "" #. type: deftypevr #: doc/guix.texi:34810 msgid "Defaults to @samp{\"/var/cache/cgit\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:34813 #, no-wrap msgid "{@code{cgit-configuration} parameter} integer cache-static-ttl" msgstr "" #. type: deftypevr #: doc/guix.texi:34816 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:34818 doc/guix.texi:35261 msgid "Defaults to @samp{-1}." msgstr "" #. type: deftypevr #: doc/guix.texi:34821 #, no-wrap msgid "{@code{cgit-configuration} parameter} integer cache-dynamic-ttl" msgstr "" #. type: deftypevr #: doc/guix.texi:34824 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:34829 #, no-wrap msgid "{@code{cgit-configuration} parameter} integer cache-repo-ttl" msgstr "" #. type: deftypevr #: doc/guix.texi:34832 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:34837 #, no-wrap msgid "{@code{cgit-configuration} parameter} integer cache-root-ttl" msgstr "" #. type: deftypevr #: doc/guix.texi:34840 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:34845 #, no-wrap msgid "{@code{cgit-configuration} parameter} integer cache-scanrc-ttl" msgstr "" #. type: deftypevr #: doc/guix.texi:34848 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:34853 #, no-wrap msgid "{@code{cgit-configuration} parameter} integer cache-about-ttl" msgstr "" #. type: deftypevr #: doc/guix.texi:34856 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:34861 #, no-wrap msgid "{@code{cgit-configuration} parameter} integer cache-snapshot-ttl" msgstr "" #. type: deftypevr #: doc/guix.texi:34864 msgid "" "Number which specifies the time-to-live, in minutes, for the cached version " "of snapshots." msgstr "" #. type: deftypevr #: doc/guix.texi:34869 #, no-wrap msgid "{@code{cgit-configuration} parameter} integer cache-size" msgstr "" #. type: deftypevr #: doc/guix.texi:34872 msgid "" "The maximum number of entries in the cgit cache. When set to @samp{0}, " "caching is disabled." msgstr "" #. type: deftypevr #: doc/guix.texi:34877 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean case-sensitive-sort?" msgstr "" #. type: deftypevr #: doc/guix.texi:34879 msgid "Sort items in the repo list case sensitively." msgstr "" #. type: deftypevr #: doc/guix.texi:34884 #, no-wrap msgid "{@code{cgit-configuration} parameter} list clone-prefix" msgstr "" #. type: deftypevr #: doc/guix.texi:34887 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:34892 #, no-wrap msgid "{@code{cgit-configuration} parameter} list clone-url" msgstr "" #. type: deftypevr #: doc/guix.texi:34894 msgid "List of @code{clone-url} templates." msgstr "" #. type: deftypevr #: doc/guix.texi:34899 #, no-wrap msgid "{@code{cgit-configuration} parameter} file-object commit-filter" msgstr "" #. type: deftypevr #: doc/guix.texi:34901 msgid "Command which will be invoked to format commit messages." msgstr "" #. type: deftypevr #: doc/guix.texi:34906 #, no-wrap msgid "{@code{cgit-configuration} parameter} string commit-sort" msgstr "" #. type: deftypevr #: doc/guix.texi:34910 doc/guix.texi:35468 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:34912 msgid "Defaults to @samp{\"git log\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:34915 #, no-wrap msgid "{@code{cgit-configuration} parameter} file-object css" msgstr "" #. type: deftypevr #: doc/guix.texi:34917 msgid "URL which specifies the css document to include in all cgit pages." msgstr "" #. type: deftypevr #: doc/guix.texi:34919 msgid "Defaults to @samp{\"/share/cgit/cgit.css\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:34922 #, no-wrap msgid "{@code{cgit-configuration} parameter} file-object email-filter" msgstr "" #. type: deftypevr #: doc/guix.texi:34926 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:34931 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean embedded?" msgstr "" #. type: deftypevr #: doc/guix.texi:34934 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:34939 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean enable-commit-graph?" msgstr "" #. type: deftypevr #: doc/guix.texi:34943 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:34948 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean enable-filter-overrides?" msgstr "" #. type: deftypevr #: doc/guix.texi:34951 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:34956 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean enable-follow-links?" msgstr "" #. type: deftypevr #: doc/guix.texi:34959 msgid "" "Flag which, when set to @samp{#t}, allows users to follow a file in the log " "view." msgstr "" #. type: deftypevr #: doc/guix.texi:34964 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean enable-http-clone?" msgstr "" #. type: deftypevr #: doc/guix.texi:34967 msgid "" "If set to @samp{#t}, cgit will act as an dumb HTTP endpoint for Git clones." msgstr "" #. type: deftypevr #: doc/guix.texi:34972 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean enable-index-links?" msgstr "" #. type: deftypevr #: doc/guix.texi:34975 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:34980 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean enable-index-owner?" msgstr "" #. type: deftypevr #: doc/guix.texi:34983 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:34988 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean enable-log-filecount?" msgstr "" #. type: deftypevr #: doc/guix.texi:34991 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:34996 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean enable-log-linecount?" msgstr "" #. type: deftypevr #: doc/guix.texi:34999 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:35004 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean enable-remote-branches?" msgstr "" #. type: deftypevr #: doc/guix.texi:35007 doc/guix.texi:35531 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:35012 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean enable-subject-links?" msgstr "" #. type: deftypevr #: doc/guix.texi:35016 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:35021 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean enable-html-serving?" msgstr "" #. type: deftypevr #: doc/guix.texi:35025 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:35030 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean enable-tree-linenumbers?" msgstr "" #. type: deftypevr #: doc/guix.texi:35033 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:35038 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean enable-git-config?" msgstr "" #. type: deftypevr #: doc/guix.texi:35041 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:35046 #, no-wrap msgid "{@code{cgit-configuration} parameter} file-object favicon" msgstr "" #. type: deftypevr #: doc/guix.texi:35048 msgid "URL used as link to a shortcut icon for cgit." msgstr "" #. type: deftypevr #: doc/guix.texi:35050 msgid "Defaults to @samp{\"/favicon.ico\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:35053 #, no-wrap msgid "{@code{cgit-configuration} parameter} string footer" msgstr "" #. type: deftypevr #: doc/guix.texi:35057 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:35062 #, no-wrap msgid "{@code{cgit-configuration} parameter} string head-include" msgstr "" #. type: deftypevr #: doc/guix.texi:35065 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:35070 #, no-wrap msgid "{@code{cgit-configuration} parameter} string header" msgstr "" #. type: deftypevr #: doc/guix.texi:35073 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:35078 #, no-wrap msgid "{@code{cgit-configuration} parameter} file-object include" msgstr "" #. type: deftypevr #: doc/guix.texi:35081 msgid "" "Name of a configfile to include before the rest of the current config- file " "is parsed." msgstr "" #. type: deftypevr #: doc/guix.texi:35086 #, no-wrap msgid "{@code{cgit-configuration} parameter} string index-header" msgstr "" #. type: deftypevr #: doc/guix.texi:35089 msgid "" "The content of the file specified with this option will be included verbatim " "above the repository index." msgstr "" #. type: deftypevr #: doc/guix.texi:35094 #, no-wrap msgid "{@code{cgit-configuration} parameter} string index-info" msgstr "" #. type: deftypevr #: doc/guix.texi:35097 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:35102 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean local-time?" msgstr "" #. type: deftypevr #: doc/guix.texi:35105 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:35110 #, no-wrap msgid "{@code{cgit-configuration} parameter} file-object logo" msgstr "" #. type: deftypevr #: doc/guix.texi:35113 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:35115 msgid "Defaults to @samp{\"/share/cgit/cgit.png\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:35118 #, no-wrap msgid "{@code{cgit-configuration} parameter} string logo-link" msgstr "" #. type: deftypevr #: doc/guix.texi:35120 doc/guix.texi:35577 msgid "URL loaded when clicking on the cgit logo image." msgstr "" #. type: deftypevr #: doc/guix.texi:35125 #, no-wrap msgid "{@code{cgit-configuration} parameter} file-object owner-filter" msgstr "" #. type: deftypevr #: doc/guix.texi:35128 msgid "" "Command which will be invoked to format the Owner column of the main page." msgstr "" #. type: deftypevr #: doc/guix.texi:35133 #, no-wrap msgid "{@code{cgit-configuration} parameter} integer max-atom-items" msgstr "" #. type: deftypevr #: doc/guix.texi:35135 msgid "Number of items to display in atom feeds view." msgstr "" #. type: deftypevr #: doc/guix.texi:35140 #, no-wrap msgid "{@code{cgit-configuration} parameter} integer max-commit-count" msgstr "" #. type: deftypevr #: doc/guix.texi:35142 msgid "Number of entries to list per page in \"log\" view." msgstr "" #. type: deftypevr #: doc/guix.texi:35147 #, no-wrap msgid "{@code{cgit-configuration} parameter} integer max-message-length" msgstr "" #. type: deftypevr #: doc/guix.texi:35149 msgid "Number of commit message characters to display in \"log\" view." msgstr "" #. type: deftypevr #: doc/guix.texi:35151 doc/guix.texi:35167 msgid "Defaults to @samp{80}." msgstr "" #. type: deftypevr #: doc/guix.texi:35154 #, no-wrap msgid "{@code{cgit-configuration} parameter} integer max-repo-count" msgstr "" #. type: deftypevr #: doc/guix.texi:35157 msgid "" "Specifies the number of entries to list per page on the repository index " "page." msgstr "" #. type: deftypevr #: doc/guix.texi:35162 #, no-wrap msgid "{@code{cgit-configuration} parameter} integer max-repodesc-length" msgstr "" #. type: deftypevr #: doc/guix.texi:35165 msgid "" "Specifies the maximum number of repo description characters to display on " "the repository index page." msgstr "" #. type: deftypevr #: doc/guix.texi:35170 #, no-wrap msgid "{@code{cgit-configuration} parameter} integer max-blob-size" msgstr "" #. type: deftypevr #: doc/guix.texi:35172 msgid "Specifies the maximum size of a blob to display HTML for in KBytes." msgstr "" #. type: deftypevr #: doc/guix.texi:35177 #, no-wrap msgid "{@code{cgit-configuration} parameter} string max-stats" msgstr "" #. type: deftypevr #: doc/guix.texi:35180 msgid "" "Maximum statistics period. Valid values are @samp{week},@samp{month}, " "@samp{quarter} and @samp{year}." msgstr "" #. type: deftypevr #: doc/guix.texi:35185 #, no-wrap msgid "{@code{cgit-configuration} parameter} mimetype-alist mimetype" msgstr "" #. type: deftypevr #: doc/guix.texi:35187 msgid "Mimetype for the specified filename extension." msgstr "" #. type: deftypevr #: doc/guix.texi:35191 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:35194 #, no-wrap msgid "{@code{cgit-configuration} parameter} file-object mimetype-file" msgstr "" #. type: deftypevr #: doc/guix.texi:35196 msgid "Specifies the file to use for automatic mimetype lookup." msgstr "" #. type: deftypevr #: doc/guix.texi:35201 #, no-wrap msgid "{@code{cgit-configuration} parameter} string module-link" msgstr "" #. type: deftypevr #: doc/guix.texi:35204 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:35209 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean nocache?" msgstr "" #. type: deftypevr #: doc/guix.texi:35211 msgid "If set to the value @samp{#t} caching will be disabled." msgstr "" #. type: deftypevr #: doc/guix.texi:35216 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean noplainemail?" msgstr "" #. type: deftypevr #: doc/guix.texi:35219 msgid "" "If set to @samp{#t} showing full author email addresses will be disabled." msgstr "" #. type: deftypevr #: doc/guix.texi:35224 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean noheader?" msgstr "" #. type: deftypevr #: doc/guix.texi:35227 msgid "" "Flag which, when set to @samp{#t}, will make cgit omit the standard header " "on all pages." msgstr "" #. type: deftypevr #: doc/guix.texi:35232 #, no-wrap msgid "{@code{cgit-configuration} parameter} project-list project-list" msgstr "" #. type: deftypevr #: doc/guix.texi:35236 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:35241 #, no-wrap msgid "{@code{cgit-configuration} parameter} file-object readme" msgstr "" #. type: deftypevr #: doc/guix.texi:35243 msgid "Text which will be used as default value for @code{cgit-repo-readme}." msgstr "" #. type: deftypevr #: doc/guix.texi:35248 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean remove-suffix?" msgstr "" #. type: deftypevr #: doc/guix.texi:35252 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:35257 #, no-wrap msgid "{@code{cgit-configuration} parameter} integer renamelimit" msgstr "" #. type: deftypevr #: doc/guix.texi:35259 msgid "Maximum number of files to consider when detecting renames." msgstr "" #. type: deftypevr #: doc/guix.texi:35264 #, no-wrap msgid "{@code{cgit-configuration} parameter} string repository-sort" msgstr "" #. type: deftypevr #: doc/guix.texi:35266 msgid "The way in which repositories in each section are sorted." msgstr "" #. type: deftypevr #: doc/guix.texi:35271 #, no-wrap msgid "{@code{cgit-configuration} parameter} robots-list robots" msgstr "" #. type: deftypevr #: doc/guix.texi:35273 msgid "Text used as content for the @code{robots} meta-tag." msgstr "" #. type: deftypevr #: doc/guix.texi:35275 msgid "Defaults to @samp{(\"noindex\" \"nofollow\")}." msgstr "" #. type: deftypevr #: doc/guix.texi:35278 #, no-wrap msgid "{@code{cgit-configuration} parameter} string root-desc" msgstr "" #. type: deftypevr #: doc/guix.texi:35280 msgid "Text printed below the heading on the repository index page." msgstr "" #. type: deftypevr #: doc/guix.texi:35282 msgid "Defaults to @samp{\"a fast webinterface for the git dscm\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:35285 #, no-wrap msgid "{@code{cgit-configuration} parameter} string root-readme" msgstr "" #. type: deftypevr #: doc/guix.texi:35288 msgid "" "The content of the file specified with this option will be included verbatim " "below the ``about'' link on the repository index page." msgstr "" #. type: deftypevr #: doc/guix.texi:35293 #, no-wrap msgid "{@code{cgit-configuration} parameter} string root-title" msgstr "" #. type: deftypevr #: doc/guix.texi:35295 msgid "Text printed as heading on the repository index page." msgstr "" #. type: deftypevr #: doc/guix.texi:35300 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean scan-hidden-path" msgstr "" #. type: deftypevr #: doc/guix.texi:35306 msgid "" "If set to @samp{#t} and repository-directory is enabled, repository-" "directory will recurse into directories whose name starts with a period. " "Otherwise, repository-directory will stay away from such directories, " "considered as ``hidden''. Note that this does not apply to the @file{.git} " "directory in non-bare repos." msgstr "" #. type: deftypevr #: doc/guix.texi:35311 #, no-wrap msgid "{@code{cgit-configuration} parameter} list snapshots" msgstr "" #. type: deftypevr #: doc/guix.texi:35314 msgid "" "Text which specifies the default set of snapshot formats that cgit generates " "links for." msgstr "" #. type: deftypevr #: doc/guix.texi:35319 #, no-wrap msgid "{@code{cgit-configuration} parameter} repository-directory repository-directory" msgstr "" #. type: deftypevr #: doc/guix.texi:35322 msgid "" "Name of the directory to scan for repositories (represents @code{scan-path})." msgstr "" #. type: deftypevr #: doc/guix.texi:35324 msgid "Defaults to @samp{\"/srv/git\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:35327 #, no-wrap msgid "{@code{cgit-configuration} parameter} string section" msgstr "" #. type: deftypevr #: doc/guix.texi:35330 doc/guix.texi:35646 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:35335 #, no-wrap msgid "{@code{cgit-configuration} parameter} string section-sort" msgstr "" #. type: deftypevr #: doc/guix.texi:35338 msgid "" "Flag which, when set to @samp{1}, will sort the sections on the repository " "listing by name." msgstr "" #. type: deftypevr #: doc/guix.texi:35343 #, no-wrap msgid "{@code{cgit-configuration} parameter} integer section-from-path" msgstr "" #. type: deftypevr #: doc/guix.texi:35346 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:35351 #, no-wrap msgid "{@code{cgit-configuration} parameter} boolean side-by-side-diffs?" msgstr "" #. type: deftypevr #: doc/guix.texi:35354 msgid "" "If set to @samp{#t} shows side-by-side diffs instead of unidiffs per default." msgstr "" #. type: deftypevr #: doc/guix.texi:35359 #, no-wrap msgid "{@code{cgit-configuration} parameter} file-object source-filter" msgstr "" #. type: deftypevr #: doc/guix.texi:35362 msgid "" "Specifies a command which will be invoked to format plaintext blobs in the " "tree view." msgstr "" #. type: deftypevr #: doc/guix.texi:35367 #, no-wrap msgid "{@code{cgit-configuration} parameter} integer summary-branches" msgstr "" #. type: deftypevr #: doc/guix.texi:35370 msgid "" "Specifies the number of branches to display in the repository ``summary'' " "view." msgstr "" #. type: deftypevr #: doc/guix.texi:35375 #, no-wrap msgid "{@code{cgit-configuration} parameter} integer summary-log" msgstr "" #. type: deftypevr #: doc/guix.texi:35378 msgid "" "Specifies the number of log entries to display in the repository ``summary'' " "view." msgstr "" #. type: deftypevr #: doc/guix.texi:35383 #, no-wrap msgid "{@code{cgit-configuration} parameter} integer summary-tags" msgstr "" #. type: deftypevr #: doc/guix.texi:35386 msgid "" "Specifies the number of tags to display in the repository ``summary'' view." msgstr "" #. type: deftypevr #: doc/guix.texi:35391 #, no-wrap msgid "{@code{cgit-configuration} parameter} string strict-export" msgstr "" #. type: deftypevr #: doc/guix.texi:35394 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:35399 #, no-wrap msgid "{@code{cgit-configuration} parameter} string virtual-root" msgstr "" #. type: deftypevr #: doc/guix.texi:35401 msgid "URL which, if specified, will be used as root for all cgit links." msgstr "" #. type: deftypevr #: doc/guix.texi:35403 msgid "Defaults to @samp{\"/\"}." msgstr "" #. type: deftypevr #: doc/guix.texi:35406 #, no-wrap msgid "{@code{cgit-configuration} parameter} repository-cgit-configuration-list repositories" msgstr "" #. type: deftypevr #: doc/guix.texi:35408 msgid "A list of @dfn{cgit-repo} records to use with config." msgstr "" #. type: deftypevr #: doc/guix.texi:35412 msgid "Available @code{repository-cgit-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:35413 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-list snapshots" msgstr "" #. type: deftypevr #: doc/guix.texi:35416 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:35421 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-file-object source-filter" msgstr "" #. type: deftypevr #: doc/guix.texi:35423 msgid "Override the default @code{source-filter}." msgstr "" #. type: deftypevr #: doc/guix.texi:35428 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-string url" msgstr "" #. type: deftypevr #: doc/guix.texi:35430 msgid "The relative URL used to access the repository." msgstr "" #. type: deftypevr #: doc/guix.texi:35435 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-file-object about-filter" msgstr "" #. type: deftypevr #: doc/guix.texi:35437 msgid "Override the default @code{about-filter}." msgstr "" #. type: deftypevr #: doc/guix.texi:35442 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-string branch-sort" msgstr "" #. type: deftypevr #: doc/guix.texi:35445 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:35450 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-list clone-url" msgstr "" #. type: deftypevr #: doc/guix.texi:35452 msgid "A list of URLs which can be used to clone repo." msgstr "" #. type: deftypevr #: doc/guix.texi:35457 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-file-object commit-filter" msgstr "" #. type: deftypevr #: doc/guix.texi:35459 msgid "Override the default @code{commit-filter}." msgstr "" #. type: deftypevr #: doc/guix.texi:35464 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-string commit-sort" msgstr "" #. type: deftypevr #: doc/guix.texi:35473 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-string defbranch" msgstr "" #. type: deftypevr #: doc/guix.texi:35478 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:35483 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-string desc" msgstr "" #. type: deftypevr #: doc/guix.texi:35485 msgid "The value to show as repository description." msgstr "" #. type: deftypevr #: doc/guix.texi:35490 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-string homepage" msgstr "" #. type: deftypevr #: doc/guix.texi:35492 msgid "The value to show as repository homepage." msgstr "" #. type: deftypevr #: doc/guix.texi:35497 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-file-object email-filter" msgstr "" #. type: deftypevr #: doc/guix.texi:35499 msgid "Override the default @code{email-filter}." msgstr "" #. type: deftypevr #: doc/guix.texi:35504 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-commit-graph?" msgstr "" #. type: deftypevr #: doc/guix.texi:35507 msgid "" "A flag which can be used to disable the global setting @code{enable-commit-" "graph?}." msgstr "" #. type: deftypevr #: doc/guix.texi:35512 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-log-filecount?" msgstr "" #. type: deftypevr #: doc/guix.texi:35515 msgid "" "A flag which can be used to disable the global setting @code{enable-log-" "filecount?}." msgstr "" #. type: deftypevr #: doc/guix.texi:35520 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-log-linecount?" msgstr "" #. type: deftypevr #: doc/guix.texi:35523 msgid "" "A flag which can be used to disable the global setting @code{enable-log-" "linecount?}." msgstr "" #. type: deftypevr #: doc/guix.texi:35528 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-remote-branches?" msgstr "" #. type: deftypevr #: doc/guix.texi:35536 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-subject-links?" msgstr "" #. type: deftypevr #: doc/guix.texi:35539 msgid "" "A flag which can be used to override the global setting @code{enable-subject-" "links?}." msgstr "" #. type: deftypevr #: doc/guix.texi:35544 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-html-serving?" msgstr "" #. type: deftypevr #: doc/guix.texi:35547 msgid "" "A flag which can be used to override the global setting @code{enable-html-" "serving?}." msgstr "" #. type: deftypevr #: doc/guix.texi:35552 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-boolean hide?" msgstr "" #. type: deftypevr #: doc/guix.texi:35555 msgid "" "Flag which, when set to @code{#t}, hides the repository from the repository " "index." msgstr "" #. type: deftypevr #: doc/guix.texi:35560 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-boolean ignore?" msgstr "" #. type: deftypevr #: doc/guix.texi:35562 msgid "Flag which, when set to @samp{#t}, ignores the repository." msgstr "" #. type: deftypevr #: doc/guix.texi:35567 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-file-object logo" msgstr "" #. type: deftypevr #: doc/guix.texi:35570 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:35575 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-string logo-link" msgstr "" #. type: deftypevr #: doc/guix.texi:35582 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-file-object owner-filter" msgstr "" #. type: deftypevr #: doc/guix.texi:35584 msgid "Override the default @code{owner-filter}." msgstr "" #. type: deftypevr #: doc/guix.texi:35589 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-string module-link" msgstr "" #. type: deftypevr #: doc/guix.texi:35593 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:35598 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} module-link-path module-link-path" msgstr "" #. type: deftypevr #: doc/guix.texi:35602 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:35607 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-string max-stats" msgstr "" #. type: deftypevr #: doc/guix.texi:35609 msgid "Override the default maximum statistics period." msgstr "" #. type: deftypevr #: doc/guix.texi:35614 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-string name" msgstr "" #. type: deftypevr #: doc/guix.texi:35616 msgid "The value to show as repository name." msgstr "" #. type: deftypevr #: doc/guix.texi:35621 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-string owner" msgstr "" #. type: deftypevr #: doc/guix.texi:35623 msgid "A value used to identify the owner of the repository." msgstr "" #. type: deftypevr #: doc/guix.texi:35628 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-string path" msgstr "" #. type: deftypevr #: doc/guix.texi:35630 msgid "An absolute path to the repository directory." msgstr "" #. type: deftypevr #: doc/guix.texi:35635 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-string readme" msgstr "" #. type: deftypevr #: doc/guix.texi:35638 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:35643 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-string section" msgstr "" #. type: deftypevr #: doc/guix.texi:35651 #, no-wrap msgid "{@code{repository-cgit-configuration} parameter} repo-list extra-options" msgstr "" #. type: deftypevr #: doc/guix.texi:35653 doc/guix.texi:35662 msgid "Extra options will be appended to cgitrc file." msgstr "" #. type: deftypevr #: doc/guix.texi:35660 #, no-wrap msgid "{@code{cgit-configuration} parameter} list extra-options" msgstr "" #. type: Plain text #: doc/guix.texi:35674 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:35676 msgid "Available @code{opaque-cgit-configuration} fields are:" msgstr "" #. type: deftypevr #: doc/guix.texi:35677 #, no-wrap msgid "{@code{opaque-cgit-configuration} parameter} package cgit" msgstr "" #. type: deftypevr #: doc/guix.texi:35679 msgid "The cgit package." msgstr "" #. type: deftypevr #: doc/guix.texi:35681 #, no-wrap msgid "{@code{opaque-cgit-configuration} parameter} string string" msgstr "" #. type: deftypevr #: doc/guix.texi:35683 msgid "The contents of the @code{cgitrc}, as a string." msgstr "" #. type: Plain text #: doc/guix.texi:35687 msgid "" "For example, if your @code{cgitrc} is just the empty string, you could " "instantiate a cgit service like this:" msgstr "" #. type: lisp #: doc/guix.texi:35692 #, no-wrap msgid "" "(service cgit-service-type\n" " (opaque-cgit-configuration\n" " (cgitrc \"\")))\n" msgstr "" #. type: subsubheading #: doc/guix.texi:35694 #, no-wrap msgid "Gitolite Service" msgstr "" #. type: cindex #: doc/guix.texi:35696 #, no-wrap msgid "Gitolite service" msgstr "" #. type: cindex #: doc/guix.texi:35697 #, no-wrap msgid "Git, hosting" msgstr "" #. type: Plain text #: doc/guix.texi:35700 msgid "" "@uref{https://gitolite.com/gitolite/, Gitolite} is a tool for hosting Git " "repositories on a central server." msgstr "" #. type: Plain text #: doc/guix.texi:35703 msgid "" "Gitolite can handle multiple repositories and users, and supports flexible " "configuration of the permissions for the users on the repositories." msgstr "" #. type: Plain text #: doc/guix.texi:35706 msgid "" "The following example will configure Gitolite using the default @code{git} " "user, and the provided SSH public key." msgstr "" #. type: lisp #: doc/guix.texi:35713 #, no-wrap msgid "" "(service gitolite-service-type\n" " (gitolite-configuration\n" " (admin-pubkey (plain-file\n" " \"yourname.pub\"\n" " \"ssh-rsa AAAA... guix@@example.com\"))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:35718 msgid "" "Gitolite is configured through a special admin repository which you can " "clone, for example, if you setup Gitolite on @code{example.com}, you would " "run the following command to clone the admin repository." msgstr "" #. type: example #: doc/guix.texi:35721 #, no-wrap msgid "git clone git@@example.com:gitolite-admin\n" msgstr "" #. type: Plain text #: doc/guix.texi:35727 msgid "" "When the Gitolite service is activated, the provided @code{admin-pubkey} " "will be inserted in to the @file{keydir} directory in the gitolite-admin " "repository. If this results in a change in the repository, it will be " "committed using the message ``gitolite setup by GNU Guix''." msgstr "" #. type: deftp #: doc/guix.texi:35728 #, no-wrap msgid "{Data Type} gitolite-configuration" msgstr "" #. type: deftp #: doc/guix.texi:35730 msgid "" "Data type representing the configuration for @code{gitolite-service-type}." msgstr "" #. type: item #: doc/guix.texi:35732 #, no-wrap msgid "@code{package} (default: @var{gitolite})" msgstr "" #. type: table #: doc/guix.texi:35738 msgid "" "Gitolite package to use. There are optional Gitolite dependencies that are " "not included in the default package, such as Redis and git-annex. These " "features can be made available by using the @code{make-gitolite} procedure " "in the @code{(gnu packages version-control}) module to produce a variant of " "Gitolite with the desired additional dependencies." msgstr "" #. type: table #: doc/guix.texi:35741 msgid "" "The following code returns a package in which the Redis and git-annex " "programs can be invoked by Gitolite's scripts:" msgstr "" #. type: example #: doc/guix.texi:35747 #, no-wrap msgid "" "(use-modules (gnu packages databases)\n" " (gnu packages haskell-apps)\n" " (gnu packages version-control))\n" "(make-gitolite (list redis git-annex))\n" msgstr "" #. type: item #: doc/guix.texi:35749 #, no-wrap msgid "@code{user} (default: @var{git})" msgstr "" #. type: table #: doc/guix.texi:35752 msgid "" "User to use for Gitolite. This will be user that you use when accessing " "Gitolite over SSH." msgstr "" #. type: item #: doc/guix.texi:35753 #, no-wrap msgid "@code{group} (default: @var{git})" msgstr "" #. type: table #: doc/guix.texi:35755 msgid "Group to use for Gitolite." msgstr "" #. type: item #: doc/guix.texi:35756 #, no-wrap msgid "@code{home-directory} (default: @var{\"/var/lib/gitolite\"})" msgstr "" #. type: table #: doc/guix.texi:35758 msgid "" "Directory in which to store the Gitolite configuration and repositories." msgstr "" #. type: item #: doc/guix.texi:35759 #, no-wrap msgid "@code{rc-file} (default: @var{(gitolite-rc-file)})" msgstr "" #. type: table #: doc/guix.texi:35762 msgid "" "A ``file-like'' object (@pxref{G-Expressions, file-like objects}), " "representing the configuration for Gitolite." msgstr "" #. type: item #: doc/guix.texi:35763 #, no-wrap msgid "@code{admin-pubkey} (default: @var{#f})" msgstr "" #. type: table #: doc/guix.texi:35767 msgid "" "A ``file-like'' object (@pxref{G-Expressions, file-like objects}) used to " "setup Gitolite. This will be inserted in to the @file{keydir} directory " "within the gitolite-admin repository." msgstr "" #. type: table #: doc/guix.texi:35769 msgid "To specify the SSH key as a string, use the @code{plain-file} function." msgstr "" #. type: lisp #: doc/guix.texi:35772 #, no-wrap msgid "(plain-file \"yourname.pub\" \"ssh-rsa AAAA... guix@@example.com\")\n" msgstr "" #. type: deftp #: doc/guix.texi:35777 #, no-wrap msgid "{Data Type} gitolite-rc-file" msgstr "" #. type: deftp #: doc/guix.texi:35779 msgid "Data type representing the Gitolite RC file." msgstr "" #. type: item #: doc/guix.texi:35781 #, no-wrap msgid "@code{umask} (default: @code{#o0077})" msgstr "" #. type: table #: doc/guix.texi:35784 msgid "" "This controls the permissions Gitolite sets on the repositories and their " "contents." msgstr "" #. type: table #: doc/guix.texi:35788 msgid "" "A value like @code{#o0027} will give read access to the group used by " "Gitolite (by default: @code{git}). This is necessary when using Gitolite " "with software like cgit or gitweb." msgstr "" #. type: item #: doc/guix.texi:35789 #, no-wrap msgid "@code{local-code} (default: @code{\"$rc@{GL_ADMIN_BASE@}/local\"})" msgstr "" #. type: table #: doc/guix.texi:35792 msgid "" "Allows you to add your own non-core programs, or even override the shipped " "ones with your own." msgstr "" #. type: table #: doc/guix.texi:35797 msgid "" "Please supply the FULL path to this variable. By default, directory called " "\"local\" in your gitolite clone is used, providing the benefits of " "versioning them as well as making changes to them without having to log on " "to the server." msgstr "" #. type: item #: doc/guix.texi:35798 #, no-wrap msgid "@code{unsafe-pattern} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:35803 msgid "" "An optional Perl regular expression for catching unsafe configurations in " "the configuration file. See @uref{https://gitolite.com/gitolite/git-config." "html#compensating-for-unsafe_patt, Gitolite's documentation} for more " "information." msgstr "" #. type: table #: doc/guix.texi:35810 msgid "" "When the value is not @code{#f}, it should be a string containing a Perl " "regular expression, such as @samp{\"[`~#\\$\\&()|;<>]\"}, which is the " "default value used by gitolite. It rejects any special character in " "configuration that might be interpreted by a shell, which is useful when " "sharing the administration burden with other people that do not otherwise " "have shell access on the server." msgstr "" #. type: item #: doc/guix.texi:35811 #, no-wrap msgid "@code{git-config-keys} (default: @code{\"\"})" msgstr "" #. type: table #: doc/guix.texi:35814 msgid "" "Gitolite allows you to set git config values using the @samp{config} " "keyword. This setting allows control over the config keys to accept." msgstr "" #. type: item #: doc/guix.texi:35815 #, no-wrap msgid "@code{roles} (default: @code{'((\"READERS\" . 1) (\"WRITERS\" . ))})" msgstr "" #. type: table #: doc/guix.texi:35817 msgid "" "Set the role names allowed to be used by users running the perms command." msgstr "" #. type: item #: doc/guix.texi:35818 #, no-wrap msgid "@code{enable} (default: @code{'(\"help\" \"desc\" \"info\" \"perms\" \"writable\" \"ssh-authkeys\" \"git-config\" \"daemon\" \"gitweb\")})" msgstr "" #. type: table #: doc/guix.texi:35820 msgid "" "This setting controls the commands and features to enable within Gitolite." msgstr "" #. type: subsubheading #: doc/guix.texi:35825 #, no-wrap msgid "Gitile Service" msgstr "" #. type: cindex #: doc/guix.texi:35827 #, no-wrap msgid "Gitile service" msgstr "" #. type: cindex #: doc/guix.texi:35828 #, no-wrap msgid "Git, forge" msgstr "" #. type: Plain text #: doc/guix.texi:35831 msgid "" "@uref{https://git.lepiller.eu/gitile, Gitile} is a Git forge for viewing " "public git repository contents from a web browser." msgstr "" #. type: Plain text #: doc/guix.texi:35837 msgid "" "Gitile works best in collaboration with Gitolite, and will serve the public " "repositories from Gitolite by default. The service should listen only on a " "local port, and a webserver should be configured to serve static resources. " "The gitile service provides an easy way to extend the Nginx service for that " "purpose (@pxref{NGINX})." msgstr "" #. type: Plain text #: doc/guix.texi:35841 msgid "" "The following example will configure Gitile to serve repositories from a " "custom location, with some default messages for the home page and the " "footers." msgstr "" #. type: lisp #: doc/guix.texi:35864 #, no-wrap msgid "" "(service gitile-service-type\n" " (gitile-configuration\n" " (repositories \"/srv/git\")\n" " (base-git-url \"https://myweb.site/git\")\n" " (index-title \"My git repositories\")\n" " (intro '((p \"This is all my public work!\")))\n" " (footer '((p \"This is the end\")))\n" " (nginx-server-block\n" " (nginx-server-configuration\n" " (ssl-certificate\n" " \"/etc/letsencrypt/live/myweb.site/fullchain.pem\")\n" " (ssl-certificate-key\n" " \"/etc/letsencrypt/live/myweb.site/privkey.pem\")\n" " (listen '(\"443 ssl http2\" \"[::]:443 ssl http2\"))\n" " (locations\n" " (list\n" " ;; Allow for https anonymous fetch on /git/ urls.\n" " (git-http-nginx-location-configuration\n" " (git-http-configuration\n" " (uri-path \"/git/\")\n" " (git-root \"/var/lib/gitolite/repositories\")))))))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:35873 msgid "" "In addition to the configuration record, you should configure your git " "repositories to contain some optional information. First, your public " "repositories need to contain the @file{git-daemon-export-ok} magic file that " "allows Git to export the repository. Gitile uses the presence of this file " "to detect public repositories it should make accessible. To do so with " "Gitolite for instance, modify your @file{conf/gitolite.conf} to include this " "in the repositories you want to make public:" msgstr "" #. type: example #: doc/guix.texi:35877 #, no-wrap msgid "" "repo foo\n" " R = daemon\n" msgstr "" #. type: Plain text #: doc/guix.texi:35883 msgid "" "In addition, Gitile can read the repository configuration to display more " "information on the repository. Gitile uses the gitweb namespace for its " "configuration. As an example, you can use the following in your @file{conf/" "gitolite.conf}:" msgstr "" #. type: example #: doc/guix.texi:35890 #, no-wrap msgid "" "repo foo\n" " R = daemon\n" " desc = A long description, optionally with HTML, shown on the index page\n" " config gitweb.name = The Foo Project\n" " config gitweb.synopsis = A short description, shown on the main page of the project\n" msgstr "" #. type: Plain text #: doc/guix.texi:35896 msgid "" "Do not forget to commit and push these changes once you are satisfied. You " "may need to change your gitolite configuration to allow the previous " "configuration options to be set. One way to do that is to add the following " "service definition:" msgstr "" #. type: lisp #: doc/guix.texi:35908 #, no-wrap msgid "" "(service gitolite-service-type\n" " (gitolite-configuration\n" " (admin-pubkey (local-file \"key.pub\"))\n" " (rc-file\n" " (gitolite-rc-file\n" " (umask #o0027)\n" " ;; Allow to set any configuration key\n" " (git-config-keys \".*\")\n" " ;; Allow any text as a valid configuration value\n" " (unsafe-patt \"^$\")))))\n" msgstr "" #. type: deftp #: doc/guix.texi:35910 #, no-wrap msgid "{Data Type} gitile-configuration" msgstr "" #. type: deftp #: doc/guix.texi:35912 msgid "" "Data type representing the configuration for @code{gitile-service-type}." msgstr "" #. type: item #: doc/guix.texi:35914 #, no-wrap msgid "@code{package} (default: @var{gitile})" msgstr "" #. type: table #: doc/guix.texi:35916 msgid "Gitile package to use." msgstr "" #. type: table #: doc/guix.texi:35919 msgid "The host on which gitile is listening." msgstr "" #. type: item #: doc/guix.texi:35920 #, no-wrap msgid "@code{port} (default: @code{8080})" msgstr "" #. type: table #: doc/guix.texi:35922 msgid "The port on which gitile is listening." msgstr "" #. type: item #: doc/guix.texi:35923 #, no-wrap msgid "@code{database} (default: @code{\"/var/lib/gitile/gitile-db.sql\"})" msgstr "" #. type: table #: doc/guix.texi:35925 msgid "The location of the database." msgstr "" #. type: item #: doc/guix.texi:35926 #, no-wrap msgid "@code{repositories} (default: @code{\"/var/lib/gitolite/repositories\"})" msgstr "" #. type: table #: doc/guix.texi:35930 msgid "" "The location of the repositories. Note that only public repositories will " "be shown by Gitile. To make a repository public, add an empty @file{git-" "daemon-export-ok} file at the root of that repository." msgstr "" #. type: code{#1} #: doc/guix.texi:35931 #, no-wrap msgid "base-git-url" msgstr "" #. type: table #: doc/guix.texi:35933 msgid "The base git url that will be used to show clone commands." msgstr "" #. type: item #: doc/guix.texi:35934 #, no-wrap msgid "@code{index-title} (default: @code{\"Index\"})" msgstr "" #. type: table #: doc/guix.texi:35936 msgid "" "The page title for the index page that lists all the available repositories." msgstr "" #. type: item #: doc/guix.texi:35937 #, no-wrap msgid "@code{intro} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:35940 msgid "" "The intro content, as a list of sxml expressions. This is shown above the " "list of repositories, on the index page." msgstr "" #. type: item #: doc/guix.texi:35941 #, no-wrap msgid "@code{footer} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:35944 msgid "" "The footer content, as a list of sxml expressions. This is shown on every " "page served by Gitile." msgstr "" #. type: code{#1} #: doc/guix.texi:35945 #, no-wrap msgid "nginx-server-block" msgstr "" #. type: table #: doc/guix.texi:35948 msgid "" "An nginx server block that will be extended and used as a reverse proxy by " "Gitile to serve its pages, and as a normal web server to serve its assets." msgstr "" #. type: table #: doc/guix.texi:35952 msgid "" "You can use this block to add more custom URLs to your domain, such as a " "@code{/git/} URL for anonymous clones, or serving any other files you would " "like to serve." msgstr "" #. type: subsubheading #: doc/guix.texi:35959 #, no-wrap msgid "The Battle for Wesnoth Service" msgstr "" #. type: cindex #: doc/guix.texi:35960 #, no-wrap msgid "wesnothd" msgstr "" #. type: Plain text #: doc/guix.texi:35964 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:35965 #, no-wrap msgid "{Scheme Variable} wesnothd-service-type" msgstr "" #. type: defvar #: doc/guix.texi:35969 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: lisp #: doc/guix.texi:35972 #, no-wrap msgid "(service wesnothd-service-type)\n" msgstr "" #. type: deftp #: doc/guix.texi:35975 #, no-wrap msgid "{Data Type} wesnothd-configuration" msgstr "" #. type: deftp #: doc/guix.texi:35977 msgid "Data type representing the configuration of @command{wesnothd}." msgstr "" #. type: item #: doc/guix.texi:35979 #, no-wrap msgid "@code{package} (default: @code{wesnoth-server})" msgstr "" #. type: table #: doc/guix.texi:35981 msgid "The wesnoth server package to use." msgstr "" #. type: item #: doc/guix.texi:35982 #, no-wrap msgid "@code{port} (default: @code{15000})" msgstr "" #. type: table #: doc/guix.texi:35984 doc/guix.texi:36389 msgid "The port to bind the server to." msgstr "" #. type: cindex #: doc/guix.texi:35990 #, no-wrap msgid "pam-mount" msgstr "" #. type: Plain text #: doc/guix.texi:35995 msgid "" "The @code{(gnu services pam-mount)} module provides a service allowing users " "to mount volumes when they log in. It should be able to mount any volume " "format supported by the system." msgstr "" #. type: defvar #: doc/guix.texi:35996 #, no-wrap msgid "{Scheme Variable} pam-mount-service-type" msgstr "" #. type: defvar #: doc/guix.texi:35998 msgid "Service type for PAM Mount support." msgstr "" #. type: deftp #: doc/guix.texi:36000 #, no-wrap msgid "{Data Type} pam-mount-configuration" msgstr "" #. type: deftp #: doc/guix.texi:36002 msgid "Data type representing the configuration of PAM Mount." msgstr "" #. type: code{#1} #: doc/guix.texi:36006 #, no-wrap msgid "rules" msgstr "" #. type: table #: doc/guix.texi:36009 msgid "" "The configuration rules that will be used to generate @file{/etc/security/" "pam_mount.conf.xml}." msgstr "" #. type: table #: doc/guix.texi:36013 msgid "" "The configuration rules are SXML elements (@pxref{SXML,,, guile, GNU Guile " "Reference Manual}), and the default ones don't mount anything for anyone at " "login:" msgstr "" #. type: lisp #: doc/guix.texi:36028 #, no-wrap msgid "" "`((debug (@@ (enable \"0\")))\n" " (mntoptions (@@ (allow ,(string-join\n" " '(\"nosuid\" \"nodev\" \"loop\"\n" " \"encryption\" \"fsck\" \"nonempty\"\n" " \"allow_root\" \"allow_other\")\n" " \",\"))))\n" " (mntoptions (@@ (require \"nosuid,nodev\")))\n" " (logout (@@ (wait \"0\")\n" " (hup \"0\")\n" " (term \"no\")\n" " (kill \"no\")))\n" " (mkmountpoint (@@ (enable \"1\")\n" " (remove \"true\"))))\n" msgstr "" #. type: table #: doc/guix.texi:36034 msgid "" "Some @code{volume} elements must be added to automatically mount volumes at " "login. Here's an example allowing the user @code{alice} to mount her " "encrypted @env{HOME} directory and allowing the user @code{bob} to mount the " "partition where he stores his data:" msgstr "" #. type: lisp #: doc/guix.texi:36059 #, no-wrap msgid "" "(define pam-mount-rules\n" "`((debug (@@ (enable \"0\")))\n" " (volume (@@ (user \"alice\")\n" " (fstype \"crypt\")\n" " (path \"/dev/sda2\")\n" " (mountpoint \"/home/alice\")))\n" " (volume (@@ (user \"bob\")\n" " (fstype \"auto\")\n" " (path \"/dev/sdb3\")\n" " (mountpoint \"/home/bob/data\")\n" " (options \"defaults,autodefrag,compress\")))\n" " (mntoptions (@@ (allow ,(string-join\n" " '(\"nosuid\" \"nodev\" \"loop\"\n" " \"encryption\" \"fsck\" \"nonempty\"\n" " \"allow_root\" \"allow_other\")\n" " \",\"))))\n" " (mntoptions (@@ (require \"nosuid,nodev\")))\n" " (logout (@@ (wait \"0\")\n" " (hup \"0\")\n" " (term \"no\")\n" " (kill \"no\")))\n" " (mkmountpoint (@@ (enable \"1\")\n" " (remove \"true\")))))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:36063 #, no-wrap msgid "" "(service pam-mount-service-type\n" " (pam-mount-configuration\n" " (rules pam-mount-rules)))\n" msgstr "" #. type: table #: doc/guix.texi:36067 msgid "" "The complete list of possible options can be found in the man page for " "@uref{http://pam-mount.sourceforge.net/pam_mount.conf.5.html, pam_mount." "conf}." msgstr "" #. type: subsubheading #: doc/guix.texi:36074 #, no-wrap msgid "Guix Build Coordinator" msgstr "" #. type: Plain text #: doc/guix.texi:36080 msgid "" "The @uref{https://git.cbaines.net/guix/build-coordinator/,Guix Build " "Coordinator} aids in distributing derivation builds among machines running " "an @dfn{agent}. The build daemon is still used to build the derivations, " "but the Guix Build Coordinator manages allocating builds and working with " "the results." msgstr "" #. type: Plain text #: doc/guix.texi:36086 msgid "" "The Guix Build Coordinator consists of one @dfn{coordinator}, and one or " "more connected @dfn{agent} processes. The coordinator process handles " "clients submitting builds, and allocating builds to agents. The agent " "processes talk to a build daemon to actually perform the builds, then send " "the results back to the coordinator." msgstr "" #. type: Plain text #: doc/guix.texi:36090 msgid "" "There is a script to run the coordinator component of the Guix Build " "Coordinator, but the Guix service uses a custom Guile script instead, to " "provide better integration with G-expressions used in the configuration." msgstr "" #. type: defvar #: doc/guix.texi:36091 #, no-wrap msgid "{Scheme Variable} guix-build-coordinator-service-type" msgstr "" #. type: defvar #: doc/guix.texi:36094 msgid "" "Service type for the Guix Build Coordinator. Its value must be a @code{guix-" "build-coordinator-configuration} object." msgstr "" #. type: deftp #: doc/guix.texi:36096 #, no-wrap msgid "{Data Type} guix-build-coordinator-configuration" msgstr "" #. type: deftp #: doc/guix.texi:36098 msgid "Data type representing the configuration of the Guix Build Coordinator." msgstr "" #. type: item #: doc/guix.texi:36100 doc/guix.texi:36278 #, no-wrap msgid "@code{package} (default: @code{guix-build-coordinator})" msgstr "" #. type: table #: doc/guix.texi:36102 doc/guix.texi:36151 doc/guix.texi:36280 msgid "The Guix Build Coordinator package to use." msgstr "" #. type: item #: doc/guix.texi:36103 #, no-wrap msgid "@code{user} (default: @code{\"guix-build-coordinator\"})" msgstr "" #. type: table #: doc/guix.texi:36105 doc/guix.texi:36154 doc/guix.texi:36283 #: doc/guix.texi:36335 doc/guix.texi:36383 msgid "The system user to run the service as." msgstr "" #. type: item #: doc/guix.texi:36106 #, no-wrap msgid "@code{group} (default: @code{\"guix-build-coordinator\"})" msgstr "" #. type: table #: doc/guix.texi:36108 doc/guix.texi:36338 doc/guix.texi:36386 msgid "The system group to run the service as." msgstr "" #. type: item #: doc/guix.texi:36109 #, no-wrap msgid "@code{database-uri-string} (default: @code{\"sqlite:///var/lib/guix-build-coordinator/guix_build_coordinator.db\"})" msgstr "" #. type: table #: doc/guix.texi:36111 msgid "The URI to use for the database." msgstr "" #. type: item #: doc/guix.texi:36112 #, no-wrap msgid "@code{agent-communication-uri} (default: @code{\"http://0.0.0.0:8745\"})" msgstr "" #. type: table #: doc/guix.texi:36114 msgid "The URI describing how to listen to requests from agent processes." msgstr "" #. type: item #: doc/guix.texi:36115 #, no-wrap msgid "@code{client-communication-uri} (default: @code{\"http://127.0.0.1:8746\"})" msgstr "" #. type: table #: doc/guix.texi:36119 msgid "" "The URI describing how to listen to requests from clients. The client API " "allows submitting builds and currently isn't authenticated, so take care " "when configuring this value." msgstr "" #. type: item #: doc/guix.texi:36120 #, no-wrap msgid "@code{allocation-strategy} (default: @code{#~basic-build-allocation-strategy})" msgstr "" #. type: table #: doc/guix.texi:36124 msgid "" "A G-expression for the allocation strategy to be used. This is a procedure " "that takes the datastore as an argument and populates the allocation plan in " "the database." msgstr "" #. type: item #: doc/guix.texi:36125 #, no-wrap msgid "@code{hooks} (default: @var{'()})" msgstr "" #. type: table #: doc/guix.texi:36128 msgid "" "An association list of hooks. These provide a way to execute arbitrary code " "upon certain events, like a build result being processed." msgstr "" #. type: item #: doc/guix.texi:36129 #, no-wrap msgid "@code{parallel-hooks} (default: @var{'()})" msgstr "" #. type: table #: doc/guix.texi:36133 msgid "" "Hooks can be configured to run in parallel. This parameter is an " "association list of hooks to do in parallel, where the key is the symbol for " "the hook and the value is the number of threads to run." msgstr "" #. type: item #: doc/guix.texi:36134 #, no-wrap msgid "@code{guile} (default: @code{guile-3.0-latest})" msgstr "" #. type: table #: doc/guix.texi:36136 msgid "The Guile package with which to run the Guix Build Coordinator." msgstr "" #. type: defvar #: doc/guix.texi:36140 #, no-wrap msgid "{Scheme Variable} guix-build-coordinator-agent-service-type" msgstr "" #. type: defvar #: doc/guix.texi:36143 msgid "" "Service type for a Guix Build Coordinator agent. Its value must be a " "@code{guix-build-coordinator-agent-configuration} object." msgstr "" #. type: deftp #: doc/guix.texi:36145 #, no-wrap msgid "{Data Type} guix-build-coordinator-agent-configuration" msgstr "" #. type: deftp #: doc/guix.texi:36147 msgid "" "Data type representing the configuration a Guix Build Coordinator agent." msgstr "" #. type: item #: doc/guix.texi:36149 #, no-wrap msgid "@code{package} (default: @code{guix-build-coordinator/agent-only})" msgstr "" #. type: item #: doc/guix.texi:36152 #, no-wrap msgid "@code{user} (default: @code{\"guix-build-coordinator-agent\"})" msgstr "" #. type: item #: doc/guix.texi:36155 #, no-wrap msgid "@code{coordinator} (default: @code{\"http://localhost:8745\"})" msgstr "" #. type: table #: doc/guix.texi:36157 doc/guix.texi:36286 msgid "The URI to use when connecting to the coordinator." msgstr "" #. type: code{#1} #: doc/guix.texi:36158 #, no-wrap msgid "authentication" msgstr "" #. type: table #: doc/guix.texi:36161 msgid "" "Record describing how this agent should authenticate with the coordinator. " "Possible record types are described below." msgstr "" #. type: item #: doc/guix.texi:36162 doc/guix.texi:36287 #, no-wrap msgid "@code{systems} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:36165 msgid "" "The systems for which this agent should fetch builds. The agent process " "will use the current system it's running on as the default." msgstr "" #. type: item #: doc/guix.texi:36166 #, no-wrap msgid "@code{max-parallel-builds} (default: @code{1})" msgstr "" #. type: table #: doc/guix.texi:36168 msgid "The number of builds to perform in parallel." msgstr "" #. type: item #: doc/guix.texi:36169 #, no-wrap msgid "@code{max-allocated-builds} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:36171 msgid "The maximum number of builds this agent can be allocated." msgstr "" #. type: item #: doc/guix.texi:36172 #, no-wrap msgid "@code{max-1min-load-average} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:36176 msgid "" "Load average value to look at when considering starting new builds, if the 1 " "minute load average exceeds this value, the agent will wait before starting " "new builds." msgstr "" #. type: table #: doc/guix.texi:36180 msgid "" "This will be unspecified if the value is @code{#f}, and the agent will use " "the number of cores reported by the system as the max 1 minute load average." msgstr "" #. type: item #: doc/guix.texi:36181 #, no-wrap msgid "@code{derivation-substitute-urls} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:36184 msgid "" "URLs from which to attempt to fetch substitutes for derivations, if the " "derivations aren't already available." msgstr "" #. type: item #: doc/guix.texi:36185 #, no-wrap msgid "@code{non-derivation-substitute-urls} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:36188 msgid "" "URLs from which to attempt to fetch substitutes for build inputs, if the " "input store items aren't already available." msgstr "" #. type: deftp #: doc/guix.texi:36192 #, no-wrap msgid "{Data Type} guix-build-coordinator-agent-password-auth" msgstr "" #. type: deftp #: doc/guix.texi:36195 msgid "" "Data type representing an agent authenticating with a coordinator via a UUID " "and password." msgstr "" #. type: table #: doc/guix.texi:36201 doc/guix.texi:36217 msgid "" "The UUID of the agent. This should be generated by the coordinator process, " "stored in the coordinator database, and used by the intended agent." msgstr "" #. type: table #: doc/guix.texi:36204 msgid "The password to use when connecting to the coordinator." msgstr "" #. type: deftp #: doc/guix.texi:36208 #, no-wrap msgid "{Data Type} guix-build-coordinator-agent-password-file-auth" msgstr "" #. type: deftp #: doc/guix.texi:36211 msgid "" "Data type representing an agent authenticating with a coordinator via a UUID " "and password read from a file." msgstr "" #. type: code{#1} #: doc/guix.texi:36218 #, no-wrap msgid "password-file" msgstr "" #. type: table #: doc/guix.texi:36221 msgid "" "A file containing the password to use when connecting to the coordinator." msgstr "" #. type: deftp #: doc/guix.texi:36225 #, no-wrap msgid "{Data Type} guix-build-coordinator-agent-dynamic-auth" msgstr "" #. type: deftp #: doc/guix.texi:36228 msgid "" "Data type representing an agent authenticating with a coordinator via a " "dynamic auth token and agent name." msgstr "" #. type: code{#1} #: doc/guix.texi:36230 doc/guix.texi:36247 #, no-wrap msgid "agent-name" msgstr "" #. type: table #: doc/guix.texi:36234 doc/guix.texi:36251 msgid "" "Name of an agent, this is used to match up to an existing entry in the " "database if there is one. When no existing entry is found, a new entry is " "automatically added." msgstr "" #. type: code{#1} #: doc/guix.texi:36235 #, no-wrap msgid "token" msgstr "" #. type: table #: doc/guix.texi:36238 msgid "" "Dynamic auth token, this is created and stored in the coordinator database, " "and is used by the agent to authenticate." msgstr "" #. type: deftp #: doc/guix.texi:36242 #, no-wrap msgid "{Data Type} guix-build-coordinator-agent-dynamic-auth-with-file" msgstr "" #. type: deftp #: doc/guix.texi:36245 msgid "" "Data type representing an agent authenticating with a coordinator via a " "dynamic auth token read from a file and agent name." msgstr "" #. type: code{#1} #: doc/guix.texi:36252 #, no-wrap msgid "token-file" msgstr "" #. type: table #: doc/guix.texi:36255 msgid "" "File containing the dynamic auth token, this is created and stored in the " "coordinator database, and is used by the agent to authenticate." msgstr "" #. type: Plain text #: doc/guix.texi:36265 msgid "" "The Guix Build Coordinator package contains a script to query an instance of " "the Guix Data Service for derivations to build, and then submit builds for " "those derivations to the coordinator. The service type below assists in " "running this script. This is an additional tool that may be useful when " "building derivations contained within an instance of the Guix Data Service." msgstr "" #. type: defvar #: doc/guix.texi:36266 #, no-wrap msgid "{Scheme Variable} guix-build-coordinator-queue-builds-service-type" msgstr "" #. type: defvar #: doc/guix.texi:36271 msgid "" "Service type for the guix-build-coordinator-queue-builds-from-guix-data-" "service script. Its value must be a @code{guix-build-coordinator-queue-" "builds-configuration} object." msgstr "" #. type: deftp #: doc/guix.texi:36273 #, no-wrap msgid "{Data Type} guix-build-coordinator-queue-builds-configuration" msgstr "" #. type: deftp #: doc/guix.texi:36276 msgid "" "Data type representing the options to the queue builds from guix data " "service script." msgstr "" #. type: item #: doc/guix.texi:36281 #, no-wrap msgid "@code{user} (default: @code{\"guix-build-coordinator-queue-builds\"})" msgstr "" #. type: item #: doc/guix.texi:36284 #, no-wrap msgid "@code{coordinator} (default: @code{\"http://localhost:8746\"})" msgstr "" #. type: table #: doc/guix.texi:36289 msgid "The systems for which to fetch derivations to build." msgstr "" #. type: item #: doc/guix.texi:36290 #, no-wrap msgid "@code{systems-and-targets} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:36293 msgid "" "An association list of system and target pairs for which to fetch " "derivations to build." msgstr "" #. type: item #: doc/guix.texi:36294 #, no-wrap msgid "@code{guix-data-service} (default: @code{\"https://data.guix.gnu.org\"})" msgstr "" #. type: table #: doc/guix.texi:36297 msgid "" "The Guix Data Service instance from which to query to find out about " "derivations to build." msgstr "" #. type: item #: doc/guix.texi:36298 #, no-wrap msgid "@code{guix-data-service-build-server-id} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:36303 msgid "" "The Guix Data Service build server ID corresponding to the builds being " "submitted. Providing this speeds up the submitting of builds as derivations " "that have already been submitted can be skipped before asking the " "coordinator to build them." msgstr "" #. type: item #: doc/guix.texi:36304 #, no-wrap msgid "@code{processed-commits-file} (default: @code{\"/var/cache/guix-build-coordinator-queue-builds/processed-commits\"})" msgstr "" #. type: table #: doc/guix.texi:36307 msgid "" "A file to record which commits have been processed, to avoid needlessly " "processing them again if the service is restarted." msgstr "" #. type: subsubheading #: doc/guix.texi:36311 #, no-wrap msgid "Guix Data Service" msgstr "" #. type: Plain text #: doc/guix.texi:36315 msgid "" "The @uref{http://data.guix.gnu.org,Guix Data Service} processes, stores and " "provides data about GNU Guix. This includes information about packages, " "derivations and lint warnings." msgstr "" #. type: Plain text #: doc/guix.texi:36318 msgid "" "The data is stored in a PostgreSQL database, and available through a web " "interface." msgstr "" #. type: defvar #: doc/guix.texi:36319 #, no-wrap msgid "{Scheme Variable} guix-data-service-type" msgstr "" #. type: defvar #: doc/guix.texi:36324 msgid "" "Service type for the Guix Data Service. Its value must be a @code{guix-data-" "service-configuration} object. The service optionally extends the getmail " "service, as the guix-commits mailing list is used to find out about changes " "in the Guix git repository." msgstr "" #. type: deftp #: doc/guix.texi:36326 #, no-wrap msgid "{Data Type} guix-data-service-configuration" msgstr "" #. type: deftp #: doc/guix.texi:36328 doc/guix.texi:36376 msgid "Data type representing the configuration of the Guix Data Service." msgstr "" #. type: item #: doc/guix.texi:36330 #, no-wrap msgid "@code{package} (default: @code{guix-data-service})" msgstr "" #. type: table #: doc/guix.texi:36332 msgid "The Guix Data Service package to use." msgstr "" #. type: item #: doc/guix.texi:36333 #, no-wrap msgid "@code{user} (default: @code{\"guix-data-service\"})" msgstr "" #. type: item #: doc/guix.texi:36336 #, no-wrap msgid "@code{group} (default: @code{\"guix-data-service\"})" msgstr "" #. type: item #: doc/guix.texi:36339 #, no-wrap msgid "@code{port} (default: @code{8765})" msgstr "" #. type: table #: doc/guix.texi:36341 msgid "The port to bind the web service to." msgstr "" #. type: item #: doc/guix.texi:36342 doc/guix.texi:36390 #, no-wrap msgid "@code{host} (default: @code{\"127.0.0.1\"})" msgstr "" #. type: table #: doc/guix.texi:36344 msgid "The host to bind the web service to." msgstr "" #. type: item #: doc/guix.texi:36345 #, no-wrap msgid "@code{getmail-idle-mailboxes} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:36348 msgid "" "If set, this is the list of mailboxes that the getmail service will be " "configured to listen to." msgstr "" #. type: item #: doc/guix.texi:36349 #, no-wrap msgid "@code{commits-getmail-retriever-configuration} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:36353 msgid "" "If set, this is the @code{getmail-retriever-configuration} object with which " "to configure getmail to fetch mail from the guix-commits mailing list." msgstr "" #. type: item #: doc/guix.texi:36354 #, no-wrap msgid "@code{extra-options} (default: @var{'()})" msgstr "" #. type: table #: doc/guix.texi:36356 msgid "Extra command line options for @code{guix-data-service}." msgstr "" #. type: item #: doc/guix.texi:36357 #, no-wrap msgid "@code{extra-process-jobs-options} (default: @var{'()})" msgstr "" #. type: table #: doc/guix.texi:36359 msgid "Extra command line options for @code{guix-data-service-process-jobs}." msgstr "" #. type: subsubheading #: doc/guix.texi:36363 #, no-wrap msgid "Nar Herder" msgstr "" #. type: Plain text #: doc/guix.texi:36366 msgid "" "The @uref{https://git.cbaines.net/guix/nar-herder/about/,Nar Herder} is a " "utility for managing a collection of nars." msgstr "" #. type: defvar #: doc/guix.texi:36367 #, no-wrap msgid "{Scheme Variable} nar-herder-type" msgstr "" #. type: defvar #: doc/guix.texi:36372 msgid "" "Service type for the Guix Data Service. Its value must be a @code{nar-" "herder-configuration} object. The service optionally extends the getmail " "service, as the guix-commits mailing list is used to find out about changes " "in the Guix git repository." msgstr "" #. type: deftp #: doc/guix.texi:36374 #, no-wrap msgid "{Data Type} nar-herder-configuration" msgstr "" #. type: item #: doc/guix.texi:36378 #, no-wrap msgid "@code{package} (default: @code{nar-herder})" msgstr "" #. type: table #: doc/guix.texi:36380 msgid "The Nar Herder package to use." msgstr "" #. type: item #: doc/guix.texi:36381 #, no-wrap msgid "@code{user} (default: @code{\"nar-herder\"})" msgstr "" #. type: item #: doc/guix.texi:36384 #, no-wrap msgid "@code{group} (default: @code{\"nar-herder\"})" msgstr "" #. type: item #: doc/guix.texi:36387 #, no-wrap msgid "@code{port} (default: @code{8734})" msgstr "" #. type: table #: doc/guix.texi:36392 msgid "The host to bind the server to." msgstr "" #. type: table #: doc/guix.texi:36397 msgid "" "Optional URL of the other Nar Herder instance which should be mirrored. " "This means that this Nar Herder instance will download it's database, and " "keep it up to date." msgstr "" #. type: item #: doc/guix.texi:36398 #, no-wrap msgid "@code{database} (default: @code{\"/var/lib/nar-herder/nar_herder.db\"})" msgstr "" #. type: table #: doc/guix.texi:36403 msgid "" "Location for the database. If this Nar Herder instance is mirroring " "another, the database will be downloaded if it doesn't exist. If this Nar " "Herder instance isn't mirroring another, an empty database will be created." msgstr "" #. type: item #: doc/guix.texi:36404 #, no-wrap msgid "@code{database-dump} (default: @code{\"/var/lib/nar-herder/nar_herder_dump.db\"})" msgstr "" #. type: table #: doc/guix.texi:36408 msgid "" "Location of the database dump. This is created and regularly updated by " "taking a copy of the database. This is the version of the database that is " "available to download." msgstr "" #. type: item #: doc/guix.texi:36409 #, no-wrap msgid "@code{storage} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:36411 msgid "Optional location in which to store nars." msgstr "" #. type: item #: doc/guix.texi:36412 #, no-wrap msgid "@code{storage-limit} (default: @code{\"none\"})" msgstr "" #. type: table #: doc/guix.texi:36415 msgid "" "Limit in bytes for the nars stored in the storage location. This can also " "be set to ``none'' so that there is no limit." msgstr "" #. type: table #: doc/guix.texi:36418 msgid "" "When the storage location exceeds this size, nars are removed according to " "the nar removal criteria." msgstr "" #. type: item #: doc/guix.texi:36419 #, no-wrap msgid "@code{storage-nar-removal-criteria} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:36422 msgid "" "Criteria used to remove nars from the storage location. These are used in " "conjunction with the storage limit." msgstr "" #. type: table #: doc/guix.texi:36427 msgid "" "When the storage location exceeds the storage limit size, nars will be " "checked against the nar removal criteria and if any of the criteria match, " "they will be removed. This will continue until the storage location is " "below the storage limit size." msgstr "" #. type: table #: doc/guix.texi:36431 msgid "" "Each criteria is specified by a string, then an equals sign, then another " "string. Currently, only one criteria is supported, checking if a nar is " "stored on another Nar Herder instance." msgstr "" #. type: table #: doc/guix.texi:36439 msgid "" "This allows the user's Guix to keep substitute information in cache for " "@var{ttl}." msgstr "" #. type: item #: doc/guix.texi:36446 #, no-wrap msgid "@code{log-level} (default: @code{'DEBUG})" msgstr "" #. type: table #: doc/guix.texi:36449 msgid "" "Log level to use, specify a log level like @code{'INFO} to stop logging " "individual requests." msgstr "" #. type: cindex #: doc/guix.texi:36456 #, no-wrap msgid "oom" msgstr "" #. type: cindex #: doc/guix.texi:36457 #, no-wrap msgid "out of memory killer" msgstr "" #. type: cindex #: doc/guix.texi:36458 #, no-wrap msgid "earlyoom" msgstr "" #. type: cindex #: doc/guix.texi:36459 #, no-wrap msgid "early out of memory daemon" msgstr "" #. type: subsubheading #: doc/guix.texi:36460 #, no-wrap msgid "Early OOM Service" msgstr "" #. type: Plain text #: doc/guix.texi:36467 msgid "" "@uref{https://github.com/rfjakob/earlyoom,Early OOM}, also known as " "Earlyoom, is a minimalist out of memory (OOM) daemon that runs in user space " "and provides a more responsive and configurable alternative to the in-kernel " "OOM killer. It is useful to prevent the system from becoming unresponsive " "when it runs out of memory." msgstr "" #. type: deffn #: doc/guix.texi:36468 #, no-wrap msgid "{Scheme Variable} earlyoom-service-type" msgstr "" #. type: deffn #: doc/guix.texi:36473 msgid "" "The service type for running @command{earlyoom}, the Early OOM daemon. Its " "value must be a @code{earlyoom-configuration} object, described below. The " "service can be instantiated in its default configuration with:" msgstr "" #. type: lisp #: doc/guix.texi:36476 #, no-wrap msgid "(service earlyoom-service-type)\n" msgstr "" #. type: deftp #: doc/guix.texi:36479 #, no-wrap msgid "{Data Type} earlyoom-configuration" msgstr "" #. type: deftp #: doc/guix.texi:36481 msgid "This is the configuration record for the @code{earlyoom-service-type}." msgstr "" #. type: item #: doc/guix.texi:36483 #, no-wrap msgid "@code{earlyoom} (default: @var{earlyoom})" msgstr "" #. type: table #: doc/guix.texi:36485 msgid "The Earlyoom package to use." msgstr "" #. type: item #: doc/guix.texi:36486 #, no-wrap msgid "@code{minimum-available-memory} (default: @code{10})" msgstr "" #. type: table #: doc/guix.texi:36488 msgid "The threshold for the minimum @emph{available} memory, in percentages." msgstr "" #. type: item #: doc/guix.texi:36489 #, no-wrap msgid "@code{minimum-free-swap} (default: @code{10})" msgstr "" #. type: table #: doc/guix.texi:36491 msgid "The threshold for the minimum free swap memory, in percentages." msgstr "" #. type: item #: doc/guix.texi:36492 #, no-wrap msgid "@code{prefer-regexp} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:36495 msgid "" "A regular expression (as a string) to match the names of the processes that " "should be preferably killed." msgstr "" #. type: item #: doc/guix.texi:36496 #, no-wrap msgid "@code{avoid-regexp} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:36499 msgid "" "A regular expression (as a string) to match the names of the processes that " "should @emph{not} be killed." msgstr "" #. type: item #: doc/guix.texi:36500 #, no-wrap msgid "@code{memory-report-interval} (default: @code{0})" msgstr "" #. type: table #: doc/guix.texi:36503 msgid "" "The interval in seconds at which a memory report is printed. It is disabled " "by default." msgstr "" #. type: item #: doc/guix.texi:36504 #, no-wrap msgid "@code{ignore-positive-oom-score-adj?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:36507 msgid "" "A boolean indicating whether the positive adjustments set in @file{/proc/*/" "oom_score_adj} should be ignored." msgstr "" #. type: item #: doc/guix.texi:36508 #, no-wrap msgid "@code{show-debug-messages?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:36511 msgid "" "A boolean indicating whether debug messages should be printed. The logs are " "saved at @file{/var/log/earlyoom.log}." msgstr "" #. type: item #: doc/guix.texi:36512 #, no-wrap msgid "@code{send-notification-command} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:36515 msgid "" "This can be used to provide a custom command used for sending notifications." msgstr "" #. type: cindex #: doc/guix.texi:36518 #, no-wrap msgid "modprobe" msgstr "" #. type: cindex #: doc/guix.texi:36519 #, no-wrap msgid "kernel module loader" msgstr "" #. type: subsubheading #: doc/guix.texi:36520 #, no-wrap msgid "Kernel Module Loader Service" msgstr "" #. type: Plain text #: doc/guix.texi:36526 msgid "" "The kernel module loader service allows one to load loadable kernel modules " "at boot. This is especially useful for modules that don't autoload and need " "to be manually loaded, as is the case with @code{ddcci}." msgstr "" #. type: deffn #: doc/guix.texi:36527 #, no-wrap msgid "{Scheme Variable} kernel-module-loader-service-type" msgstr "" #. type: deffn #: doc/guix.texi:36533 msgid "" "The service type for loading loadable kernel modules at boot with " "@command{modprobe}. Its value must be a list of strings representing module " "names. For example loading the drivers provided by @code{ddcci-driver-" "linux}, in debugging mode by passing some module parameters, can be done as " "follow:" msgstr "" #. type: lisp #: doc/guix.texi:36538 #, no-wrap msgid "" "(use-modules (gnu) (gnu services))\n" "(use-package-modules linux)\n" "(use-service-modules linux)\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:36542 #, no-wrap msgid "" "(define ddcci-config\n" " (plain-file \"ddcci.conf\"\n" " \"options ddcci dyndbg delay=120\"))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:36552 #, no-wrap msgid "" "(operating-system\n" " ...\n" " (services (cons* (service kernel-module-loader-service-type\n" " '(\"ddcci\" \"ddcci_backlight\"))\n" " (simple-service 'ddcci-config etc-service-type\n" " (list `(\"modprobe.d/ddcci.conf\"\n" " ,ddcci-config)))\n" " %base-services))\n" " (kernel-loadable-modules (list ddcci-driver-linux)))\n" msgstr "" #. type: cindex #: doc/guix.texi:36555 #, no-wrap msgid "rasdaemon" msgstr "" #. type: cindex #: doc/guix.texi:36556 #, no-wrap msgid "Platform Reliability, Availability and Serviceability daemon" msgstr "" #. type: subsubheading #: doc/guix.texi:36557 #, no-wrap msgid "Rasdaemon Service" msgstr "" #. type: Plain text #: doc/guix.texi:36562 msgid "" "The Rasdaemon service provides a daemon which monitors platform " "@acronym{RAS, Reliability@comma{} Availability@comma{} and Serviceability} " "reports from Linux kernel trace events, logging them to syslogd." msgstr "" #. type: Plain text #: doc/guix.texi:36565 msgid "" "Reliability, Availability and Serviceability is a concept used on servers " "meant to measure their robustness." msgstr "" #. type: Plain text #: doc/guix.texi:36568 msgid "" "@strong{Relability} is the probability that a system will produce correct " "outputs:" msgstr "" #. type: item #: doc/guix.texi:36570 #, no-wrap msgid "Generally measured as Mean Time Between Failures (MTBF), and" msgstr "" #. type: item #: doc/guix.texi:36571 #, no-wrap msgid "Enhanced by features that help to avoid, detect and repair hardware" msgstr "" #. type: itemize #: doc/guix.texi:36573 msgid "faults" msgstr "" #. type: Plain text #: doc/guix.texi:36577 msgid "" "@strong{Availability} is the probability that a system is operational at a " "given time:" msgstr "" #. type: item #: doc/guix.texi:36579 #, no-wrap msgid "Generally measured as a percentage of downtime per a period of time, and" msgstr "" #. type: item #: doc/guix.texi:36580 #, no-wrap msgid "Often uses mechanisms to detect and correct hardware faults in runtime." msgstr "" #. type: Plain text #: doc/guix.texi:36585 msgid "" "@strong{Serviceability} is the simplicity and speed with which a system can " "be repaired or maintained:" msgstr "" #. type: item #: doc/guix.texi:36587 #, no-wrap msgid "Generally measured on Mean Time Between Repair (MTBR)." msgstr "" #. type: Plain text #: doc/guix.texi:36592 msgid "Among the monitoring measures, the most usual ones include:" msgstr "" #. type: item #: doc/guix.texi:36594 #, no-wrap msgid "CPU – detect errors at instruction execution and at L1/L2/L3 caches;" msgstr "" #. type: item #: doc/guix.texi:36595 #, no-wrap msgid "Memory – add error correction logic (ECC) to detect and correct errors;" msgstr "" #. type: item #: doc/guix.texi:36596 #, no-wrap msgid "I/O – add CRC checksums for transferred data;" msgstr "" #. type: item #: doc/guix.texi:36597 #, no-wrap msgid "Storage – RAID, journal file systems, checksums, Self-Monitoring," msgstr "" #. type: itemize #: doc/guix.texi:36599 msgid "Analysis and Reporting Technology (SMART)." msgstr "" #. type: Plain text #: doc/guix.texi:36605 msgid "" "By monitoring the number of occurrences of error detections, it is possible " "to identify if the probability of hardware errors is increasing, and, on " "such case, do a preventive maintenance to replace a degraded component while " "those errors are correctable." msgstr "" #. type: Plain text #: doc/guix.texi:36609 msgid "" "For detailed information about the types of error events gathered and how to " "make sense of them, see the kernel administrator's guide at @url{https://www." "kernel.org/doc/html/latest/admin-guide/ras.html}." msgstr "" #. type: defvr #: doc/guix.texi:36610 #, no-wrap msgid "{Scheme Variable} rasdaemon-service-type" msgstr "" #. type: defvr #: doc/guix.texi:36613 msgid "" "Service type for the @command{rasdaemon} service. It accepts a " "@code{rasdaemon-configuration} object. Instantiating like" msgstr "" #. type: lisp #: doc/guix.texi:36616 #, no-wrap msgid "(service rasdaemon-service-type)\n" msgstr "" #. type: defvr #: doc/guix.texi:36620 msgid "" "will load with a default configuration, which monitors all events and logs " "to syslogd." msgstr "" #. type: deftp #: doc/guix.texi:36622 #, no-wrap msgid "{Data Type} rasdaemon-configuration" msgstr "" #. type: deftp #: doc/guix.texi:36624 msgid "The data type representing the configuration of @command{rasdaemon}." msgstr "" #. type: item #: doc/guix.texi:36626 #, no-wrap msgid "@code{record?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:36631 msgid "" "A boolean indicating whether to record the events in an SQLite database. " "This provides a more structured access to the information contained in the " "log file. The database location is hard-coded to @file{/var/lib/rasdaemon/" "ras-mc_event.db}." msgstr "" #. type: cindex #: doc/guix.texi:36635 #, no-wrap msgid "zram" msgstr "" #. type: cindex #: doc/guix.texi:36636 #, no-wrap msgid "compressed swap" msgstr "" #. type: cindex #: doc/guix.texi:36637 #, no-wrap msgid "Compressed RAM-based block devices" msgstr "" #. type: subsubheading #: doc/guix.texi:36638 #, no-wrap msgid "Zram Device Service" msgstr "" #. type: Plain text #: doc/guix.texi:36644 msgid "" "The Zram device service provides a compressed swap device in system memory. " "The Linux Kernel documentation has more information about @uref{https://www." "kernel.org/doc/html/latest/admin-guide/blockdev/zram.html,zram} devices." msgstr "" #. type: deffn #: doc/guix.texi:36645 #, no-wrap msgid "{Scheme Variable} zram-device-service-type" msgstr "" #. type: deffn #: doc/guix.texi:36649 msgid "" "This service creates the zram block device, formats it as swap and enables " "it as a swap device. The service's value is a @code{zram-device-" "configuration} record." msgstr "" #. type: deftp #: doc/guix.texi:36650 #, no-wrap msgid "{Data Type} zram-device-configuration" msgstr "" #. type: deftp #: doc/guix.texi:36653 msgid "" "This is the data type representing the configuration for the zram-device " "service." msgstr "" #. type: item #: doc/guix.texi:36655 #, no-wrap msgid "@code{size} (default @code{\"1G\"})" msgstr "" #. type: table #: doc/guix.texi:36659 msgid "" "This is the amount of space you wish to provide for the zram device. It " "accepts a string and can be a number of bytes or use a suffix, eg.: " "@code{\"512M\"} or @code{1024000}." msgstr "" #. type: item #: doc/guix.texi:36659 #, no-wrap msgid "@code{compression-algorithm} (default @code{'lzo})" msgstr "" #. type: table #: doc/guix.texi:36663 msgid "" "This is the compression algorithm you wish to use. It is difficult to list " "all the possible compression options, but common ones supported by Guix's " "Linux Libre Kernel include @code{'lzo}, @code{'lz4} and @code{'zstd}." msgstr "" #. type: item #: doc/guix.texi:36663 #, no-wrap msgid "@code{memory-limit} (default @code{0})" msgstr "" #. type: table #: doc/guix.texi:36670 msgid "" "This is the maximum amount of memory which the zram device can use. Setting " "it to '0' disables the limit. While it is generally expected that " "compression will be 2:1, it is possible that uncompressable data can be " "written to swap and this is a method to limit how much memory can be used. " "It accepts a string and can be a number of bytes or use a suffix, eg.: " "@code{\"2G\"}." msgstr "" #. type: item #: doc/guix.texi:36670 #, no-wrap msgid "@code{priority} (default @code{#f})" msgstr "" #. type: table #: doc/guix.texi:36675 msgid "" "This is the priority of the swap device created from the zram device. " "@xref{Swap Space} for a description of swap priorities. You might want to " "set a specific priority for the zram device, otherwise it could end up not " "being used much for the reasons described there." msgstr "" #. type: defvr #: doc/guix.texi:36683 #, no-wrap msgid "{Scheme Variable} hurd-console-service-type" msgstr "" #. type: defvr #: doc/guix.texi:36685 msgid "This service starts the fancy @code{VGA} console client on the Hurd." msgstr "" #. type: defvr #: doc/guix.texi:36687 msgid "The service's value is a @code{hurd-console-configuration} record." msgstr "" #. type: deftp #: doc/guix.texi:36689 #, no-wrap msgid "{Data Type} hurd-console-configuration" msgstr "" #. type: deftp #: doc/guix.texi:36692 msgid "" "This is the data type representing the configuration for the hurd-console-" "service." msgstr "" #. type: item #: doc/guix.texi:36694 doc/guix.texi:36710 #, no-wrap msgid "@code{hurd} (default: @var{hurd})" msgstr "" #. type: table #: doc/guix.texi:36696 doc/guix.texi:36712 msgid "The Hurd package to use." msgstr "" #. type: defvr #: doc/guix.texi:36699 #, no-wrap msgid "{Scheme Variable} hurd-getty-service-type" msgstr "" #. type: defvr #: doc/guix.texi:36701 msgid "This service starts a tty using the Hurd @code{getty} program." msgstr "" #. type: defvr #: doc/guix.texi:36703 msgid "The service's value is a @code{hurd-getty-configuration} record." msgstr "" #. type: deftp #: doc/guix.texi:36705 #, no-wrap msgid "{Data Type} hurd-getty-configuration" msgstr "" #. type: deftp #: doc/guix.texi:36708 msgid "" "This is the data type representing the configuration for the hurd-getty-" "service." msgstr "" #. type: table #: doc/guix.texi:36715 msgid "The name of the console this Getty runs on---e.g., @code{\"tty1\"}." msgstr "" #. type: item #: doc/guix.texi:36716 #, no-wrap msgid "@code{baud-rate} (default: @code{38400})" msgstr "" #. type: table #: doc/guix.texi:36718 msgid "An integer specifying the baud rate of the tty." msgstr "" #. type: cindex #: doc/guix.texi:36725 #, no-wrap msgid "fingerprint" msgstr "" #. type: subsubheading #: doc/guix.texi:36726 #, no-wrap msgid "Fingerprint Service" msgstr "" #. type: Plain text #: doc/guix.texi:36730 msgid "" "The @code{(gnu services authentication)} module provides a DBus service to " "read and identify fingerprints via a fingerprint sensor." msgstr "" #. type: defvr #: doc/guix.texi:36731 #, no-wrap msgid "{Scheme Variable} fprintd-service-type" msgstr "" #. type: defvr #: doc/guix.texi:36734 msgid "" "The service type for @command{fprintd}, which provides the fingerprint " "reading capability." msgstr "" #. type: lisp #: doc/guix.texi:36737 #, no-wrap msgid "(service fprintd-service-type)\n" msgstr "" #. type: cindex #: doc/guix.texi:36740 #, no-wrap msgid "sysctl" msgstr "" #. type: subsubheading #: doc/guix.texi:36741 #, no-wrap msgid "System Control Service" msgstr "" #. type: Plain text #: doc/guix.texi:36745 msgid "" "The @code{(gnu services sysctl)} provides a service to configure kernel " "parameters at boot." msgstr "" #. type: defvr #: doc/guix.texi:36746 #, no-wrap msgid "{Scheme Variable} sysctl-service-type" msgstr "" #. type: defvr #: doc/guix.texi:36750 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: lisp #: doc/guix.texi:36755 #, no-wrap msgid "" "(service sysctl-service-type\n" " (sysctl-configuration\n" " (settings '((\"net.ipv4.ip_forward\" . \"1\")))))\n" msgstr "" #. type: defvr #: doc/guix.texi:36762 msgid "" "Since @code{sysctl-service-type} is used in the default lists of services, " "@code{%base-services} and @code{%desktop-services}, you can use @code{modify-" "services} to change its configuration and add the kernel parameters that you " "want (@pxref{Service Reference, @code{modify-services}})." msgstr "" #. type: lisp #: doc/guix.texi:36769 #, no-wrap msgid "" "(modify-services %base-services\n" " (sysctl-service-type config =>\n" " (sysctl-configuration\n" " (settings (append '((\"net.ipv4.ip_forward\" . \"1\"))\n" " %default-sysctl-settings)))))\n" msgstr "" #. type: deftp #: doc/guix.texi:36773 #, no-wrap msgid "{Data Type} sysctl-configuration" msgstr "" #. type: deftp #: doc/guix.texi:36775 msgid "The data type representing the configuration of @command{sysctl}." msgstr "" #. type: item #: doc/guix.texi:36777 #, no-wrap msgid "@code{sysctl} (default: @code{(file-append procps \"/sbin/sysctl\"})" msgstr "" #. type: table #: doc/guix.texi:36779 msgid "The @command{sysctl} executable to use." msgstr "" #. type: item #: doc/guix.texi:36780 #, no-wrap msgid "@code{settings} (default: @code{%default-sysctl-settings})" msgstr "" #. type: table #: doc/guix.texi:36782 msgid "An association list specifies kernel parameters and their values." msgstr "" #. type: defvr #: doc/guix.texi:36785 #, no-wrap msgid "{Scheme Variable} %default-sysctl-settings" msgstr "" #. type: defvr #: doc/guix.texi:36788 msgid "" "An association list specifying the default @command{sysctl} parameters on " "Guix System." msgstr "" #. type: cindex #: doc/guix.texi:36790 #, no-wrap msgid "pcscd" msgstr "" #. type: subsubheading #: doc/guix.texi:36791 #, no-wrap msgid "PC/SC Smart Card Daemon Service" msgstr "" #. type: Plain text #: doc/guix.texi:36798 msgid "" "The @code{(gnu services security-token)} module provides the following " "service to run @command{pcscd}, the PC/SC Smart Card Daemon. " "@command{pcscd} is the daemon program for pcsc-lite and the MuscleCard " "framework. It is a resource manager that coordinates communications with " "smart card readers, smart cards and cryptographic tokens that are connected " "to the system." msgstr "" #. type: defvr #: doc/guix.texi:36799 #, no-wrap msgid "{Scheme Variable} pcscd-service-type" msgstr "" #. type: defvr #: doc/guix.texi:36803 msgid "" "Service type for the @command{pcscd} service. Its value must be a " "@code{pcscd-configuration} object. To run pcscd in the default " "configuration, instantiate it as:" msgstr "" #. type: lisp #: doc/guix.texi:36806 #, no-wrap msgid "(service pcscd-service-type)\n" msgstr "" #. type: deftp #: doc/guix.texi:36809 #, no-wrap msgid "{Data Type} pcscd-configuration" msgstr "" #. type: deftp #: doc/guix.texi:36811 msgid "The data type representing the configuration of @command{pcscd}." msgstr "" #. type: item #: doc/guix.texi:36813 #, no-wrap msgid "@code{pcsc-lite} (default: @code{pcsc-lite})" msgstr "" #. type: table #: doc/guix.texi:36815 msgid "The pcsc-lite package that provides pcscd." msgstr "" #. type: item #: doc/guix.texi:36815 #, no-wrap msgid "@code{usb-drivers} (default: @code{(list ccid)})" msgstr "" #. type: table #: doc/guix.texi:36818 msgid "" "List of packages that provide USB drivers to pcscd. Drivers are expected to " "be under @file{pcsc/drivers} in the store directory of the package." msgstr "" #. type: cindex #: doc/guix.texi:36821 #, no-wrap msgid "lirc" msgstr "" #. type: subsubheading #: doc/guix.texi:36822 #, no-wrap msgid "Lirc Service" msgstr "" #. type: Plain text #: doc/guix.texi:36825 msgid "The @code{(gnu services lirc)} module provides the following service." msgstr "" #. type: deffn #: doc/guix.texi:36826 #, no-wrap msgid "{Scheme Procedure} lirc-service [#:lirc lirc] @" msgstr "" #. type: deffn #: doc/guix.texi:36831 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:36835 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:36838 msgid "" "Finally, @var{extra-options} is a list of additional command-line options " "passed to @command{lircd}." msgstr "" #. type: cindex #: doc/guix.texi:36840 #, no-wrap msgid "spice" msgstr "" #. type: subsubheading #: doc/guix.texi:36841 #, no-wrap msgid "Spice Service" msgstr "" #. type: Plain text #: doc/guix.texi:36844 msgid "The @code{(gnu services spice)} module provides the following service." msgstr "" #. type: deffn #: doc/guix.texi:36845 #, no-wrap msgid "{Scheme Procedure} spice-vdagent-service [#:spice-vdagent]" msgstr "" #. type: deffn #: doc/guix.texi:36849 msgid "" "Returns a service that runs @url{https://www.spice-space.org,VDAGENT}, a " "daemon that enables sharing the clipboard with a vm and setting the guest " "display resolution when the graphical console window resizes." msgstr "" #. type: cindex #: doc/guix.texi:36851 #, no-wrap msgid "inputattach" msgstr "" #. type: subsubheading #: doc/guix.texi:36852 #, no-wrap msgid "inputattach Service" msgstr "" #. type: cindex #: doc/guix.texi:36854 #, no-wrap msgid "tablet input, for Xorg" msgstr "" #. type: cindex #: doc/guix.texi:36855 #, no-wrap msgid "touchscreen input, for Xorg" msgstr "" #. type: Plain text #: doc/guix.texi:36859 msgid "" "The @uref{https://linuxwacom.github.io/, inputattach} service allows you to " "use input devices such as Wacom tablets, touchscreens, or joysticks with the " "Xorg display server." msgstr "" #. type: deffn #: doc/guix.texi:36860 #, no-wrap msgid "{Scheme Variable} inputattach-service-type" msgstr "" #. type: deffn #: doc/guix.texi:36863 msgid "" "Type of a service that runs @command{inputattach} on a device and dispatches " "events from it." msgstr "" #. type: deftp #: doc/guix.texi:36865 #, no-wrap msgid "{Data Type} inputattach-configuration" msgstr "" #. type: item #: doc/guix.texi:36867 #, no-wrap msgid "@code{device-type} (default: @code{\"wacom\"})" msgstr "" #. type: table #: doc/guix.texi:36870 msgid "" "The type of device to connect to. Run @command{inputattach --help}, from " "the @code{inputattach} package, to see the list of supported device types." msgstr "" #. type: item #: doc/guix.texi:36871 #, no-wrap msgid "@code{device} (default: @code{\"/dev/ttyS0\"})" msgstr "" #. type: table #: doc/guix.texi:36873 msgid "The device file to connect to the device." msgstr "" #. type: table #: doc/guix.texi:36877 msgid "" "Baud rate to use for the serial connection. Should be a number or @code{#f}." msgstr "" #. type: item #: doc/guix.texi:36878 #, no-wrap msgid "@code{log-file} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:36880 msgid "If true, this must be the name of a file to log messages to." msgstr "" #. type: subsubheading #: doc/guix.texi:36883 #, no-wrap msgid "Dictionary Service" msgstr "" #. type: cindex #: doc/guix.texi:36884 #, no-wrap msgid "dictionary" msgstr "" #. type: Plain text #: doc/guix.texi:36886 msgid "The @code{(gnu services dict)} module provides the following service:" msgstr "" #. type: defvr #: doc/guix.texi:36887 #, no-wrap msgid "{Scheme Variable} dicod-service-type" msgstr "" #. type: defvr #: doc/guix.texi:36890 msgid "" "This is the type of the service that runs the @command{dicod} daemon, an " "implementation of DICT server (@pxref{Dicod,,, dico, GNU Dico Manual})." msgstr "" #. type: deffn #: doc/guix.texi:36892 #, no-wrap msgid "{Scheme Procedure} dicod-service [#:config (dicod-configuration)]" msgstr "" #. type: deffn #: doc/guix.texi:36895 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:36899 msgid "" "The optional @var{config} argument specifies the configuration for " "@command{dicod}, which should be a @code{} object, by " "default it serves the GNU Collaborative International Dictionary of English." msgstr "" #. type: deffn #: doc/guix.texi:36903 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:36905 #, no-wrap msgid "{Data Type} dicod-configuration" msgstr "" #. type: deftp #: doc/guix.texi:36907 msgid "Data type representing the configuration of dicod." msgstr "" #. type: item #: doc/guix.texi:36909 #, no-wrap msgid "@code{dico} (default: @var{dico})" msgstr "" #. type: table #: doc/guix.texi:36911 msgid "Package object of the GNU Dico dictionary server." msgstr "" #. type: item #: doc/guix.texi:36912 #, no-wrap msgid "@code{interfaces} (default: @var{'(\"localhost\")})" msgstr "" #. type: table #: doc/guix.texi:36916 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:36917 #, no-wrap msgid "@code{handlers} (default: @var{'()})" msgstr "" #. type: table #: doc/guix.texi:36919 msgid "" "List of @code{} objects denoting handlers (module instances)." msgstr "" #. type: item #: doc/guix.texi:36920 #, no-wrap msgid "@code{databases} (default: @var{(list %dicod-database:gcide)})" msgstr "" #. type: table #: doc/guix.texi:36922 msgid "" "List of @code{} objects denoting dictionaries to be served." msgstr "" #. type: deftp #: doc/guix.texi:36925 #, no-wrap msgid "{Data Type} dicod-handler" msgstr "" #. type: deftp #: doc/guix.texi:36927 msgid "Data type representing a dictionary handler (module instance)." msgstr "" #. type: table #: doc/guix.texi:36931 msgid "Name of the handler (module instance)." msgstr "" #. type: item #: doc/guix.texi:36932 #, no-wrap msgid "@code{module} (default: @var{#f})" msgstr "" #. type: table #: doc/guix.texi:36936 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: table #: doc/guix.texi:36939 msgid "" "List of strings or gexps representing the arguments for the module handler" msgstr "" #. type: deftp #: doc/guix.texi:36942 #, no-wrap msgid "{Data Type} dicod-database" msgstr "" #. type: deftp #: doc/guix.texi:36944 msgid "Data type representing a dictionary database." msgstr "" #. type: table #: doc/guix.texi:36948 msgid "Name of the database, will be used in DICT commands." msgstr "" #. type: code{#1} #: doc/guix.texi:36949 #, no-wrap msgid "handler" msgstr "" #. type: table #: doc/guix.texi:36952 msgid "" "Name of the dicod handler (module instance) used by this database " "(@pxref{Handlers,,, dico, GNU Dico Manual})." msgstr "" #. type: item #: doc/guix.texi:36953 #, no-wrap msgid "@code{complex?} (default: @var{#f})" msgstr "" #. type: table #: doc/guix.texi:36956 msgid "" "Whether the database configuration complex. The complex configuration will " "need a corresponding @code{} object, otherwise not." msgstr "" #. type: table #: doc/guix.texi:36960 msgid "" "List of strings or gexps representing the arguments for the database " "(@pxref{Databases,,, dico, GNU Dico Manual})." msgstr "" #. type: defvr #: doc/guix.texi:36963 #, no-wrap msgid "{Scheme Variable} %dicod-database:gcide" msgstr "" #. type: defvr #: doc/guix.texi:36966 msgid "" "A @code{} object serving the GNU Collaborative International " "Dictionary of English using the @code{gcide} package." msgstr "" #. type: Plain text #: doc/guix.texi:36969 msgid "The following is an example @code{dicod-service} configuration." msgstr "" #. type: lisp #: doc/guix.texi:36984 #, 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:36986 #, no-wrap msgid "Docker" msgstr "" #. type: subsubheading #: doc/guix.texi:36987 #, no-wrap msgid "Docker Service" msgstr "" #. type: Plain text #: doc/guix.texi:36990 msgid "" "The @code{(gnu services docker)} module provides the following services." msgstr "" #. type: defvr #: doc/guix.texi:36991 #, no-wrap msgid "{Scheme Variable} docker-service-type" msgstr "" #. type: defvr #: doc/guix.texi:36996 msgid "" "This is the type of the service that runs @url{https://www.docker.com," "Docker}, a daemon that can execute application bundles (sometimes referred " "to as ``containers'') in isolated environments." msgstr "" #. type: deftp #: doc/guix.texi:36999 #, no-wrap msgid "{Data Type} docker-configuration" msgstr "" #. type: deftp #: doc/guix.texi:37001 msgid "" "This is the data type representing the configuration of Docker and " "Containerd." msgstr "" #. type: item #: doc/guix.texi:37004 #, no-wrap msgid "@code{docker} (default: @code{docker})" msgstr "" #. type: table #: doc/guix.texi:37006 msgid "The Docker daemon package to use." msgstr "" #. type: item #: doc/guix.texi:37007 #, no-wrap msgid "@code{docker-cli} (default: @code{docker-cli})" msgstr "" #. type: table #: doc/guix.texi:37009 msgid "The Docker client package to use." msgstr "" #. type: item #: doc/guix.texi:37010 #, no-wrap msgid "@code{containerd} (default: @var{containerd})" msgstr "" #. type: table #: doc/guix.texi:37012 msgid "The Containerd package to use." msgstr "" #. type: item #: doc/guix.texi:37013 #, no-wrap msgid "@code{proxy} (default @var{docker-libnetwork-cmd-proxy})" msgstr "" #. type: table #: doc/guix.texi:37015 msgid "The Docker user-land networking proxy package to use." msgstr "" #. type: item #: doc/guix.texi:37016 #, no-wrap msgid "@code{enable-proxy?} (default @code{#t})" msgstr "" #. type: table #: doc/guix.texi:37018 msgid "Enable or disable the use of the Docker user-land networking proxy." msgstr "" #. type: item #: doc/guix.texi:37019 #, no-wrap msgid "@code{debug?} (default @code{#f})" msgstr "" #. type: table #: doc/guix.texi:37021 msgid "Enable or disable debug output." msgstr "" #. type: item #: doc/guix.texi:37022 #, no-wrap msgid "@code{enable-iptables?} (default @code{#t})" msgstr "" #. type: table #: doc/guix.texi:37024 msgid "Enable or disable the addition of iptables rules." msgstr "" #. type: item #: doc/guix.texi:37025 #, no-wrap msgid "@code{environment-variables} (default: @code{()})" msgstr "" #. type: table #: doc/guix.texi:37027 msgid "List of environment variables to set for @command{dockerd}." msgstr "" #. type: table #: doc/guix.texi:37030 msgid "" "This must be a list of strings where each string has the form @samp{@var{key}" "=@var{value}} as in this example:" msgstr "" #. type: lisp #: doc/guix.texi:37034 #, no-wrap msgid "" "(list \"LANGUAGE=eo:ca:eu\"\n" " \"TMPDIR=/tmp/dockerd\")\n" msgstr "" #. type: cindex #: doc/guix.texi:37039 #, no-wrap msgid "Singularity, container service" msgstr "" #. type: defvr #: doc/guix.texi:37040 #, no-wrap msgid "{Scheme Variable} singularity-service-type" msgstr "" #. type: defvr #: doc/guix.texi:37045 msgid "" "This is the type of the service that allows you to run @url{https://www." "sylabs.io/singularity/, Singularity}, a Docker-style tool to create and run " "application bundles (aka. ``containers''). The value for this service is " "the Singularity package to use." msgstr "" #. type: defvr #: doc/guix.texi:37049 msgid "" "The service does not install a daemon; instead, it installs helper programs " "as setuid-root (@pxref{Setuid Programs}) such that unprivileged users can " "invoke @command{singularity run} and similar commands." msgstr "" #. type: cindex #: doc/guix.texi:37051 #, no-wrap msgid "Audit" msgstr "" #. type: subsubheading #: doc/guix.texi:37052 #, no-wrap msgid "Auditd Service" msgstr "" #. type: Plain text #: doc/guix.texi:37055 msgid "The @code{(gnu services auditd)} module provides the following service." msgstr "" #. type: defvr #: doc/guix.texi:37056 #, no-wrap msgid "{Scheme Variable} auditd-service-type" msgstr "" #. type: defvr #: doc/guix.texi:37061 msgid "" "This is the type of the service that runs @url{https://people.redhat.com/" "sgrubb/audit/,auditd}, a daemon that tracks security-relevant information on " "your system." msgstr "" #. type: defvr #: doc/guix.texi:37063 msgid "Examples of things that can be tracked:" msgstr "" #. type: enumerate #: doc/guix.texi:37067 msgid "File accesses" msgstr "" #. type: enumerate #: doc/guix.texi:37069 msgid "System calls" msgstr "" #. type: enumerate #: doc/guix.texi:37071 msgid "Invoked commands" msgstr "" #. type: enumerate #: doc/guix.texi:37073 msgid "Failed login attempts" msgstr "" #. type: enumerate #: doc/guix.texi:37075 msgid "Firewall filtering" msgstr "" #. type: enumerate #: doc/guix.texi:37077 msgid "Network access" msgstr "" #. type: defvr #: doc/guix.texi:37088 msgid "" "@command{auditctl} from the @code{audit} package can be used in order to add " "or remove events to be tracked (until the next reboot). In order to " "permanently track events, put the command line arguments of auditctl into a " "file called @code{audit.rules} in the configuration directory (see below). " "@command{aureport} from the @code{audit} package can be used in order to " "view a report of all recorded events. The audit daemon by default logs into " "the file @file{/var/log/audit.log}." msgstr "" #. type: deftp #: doc/guix.texi:37091 #, no-wrap msgid "{Data Type} auditd-configuration" msgstr "" #. type: deftp #: doc/guix.texi:37093 msgid "This is the data type representing the configuration of auditd." msgstr "" #. type: item #: doc/guix.texi:37096 #, no-wrap msgid "@code{audit} (default: @code{audit})" msgstr "" #. type: table #: doc/guix.texi:37098 msgid "The audit package to use." msgstr "" #. type: item #: doc/guix.texi:37099 #, no-wrap msgid "@code{configuration-directory} (default: @code{%default-auditd-configuration-directory})" msgstr "" #. type: table #: doc/guix.texi:37103 msgid "" "The directory containing the configuration file for the audit package, which " "must be named @code{auditd.conf}, and optionally some audit rules to " "instantiate on startup." msgstr "" #. type: cindex #: doc/guix.texi:37107 #, no-wrap msgid "rshiny" msgstr "" #. type: subsubheading #: doc/guix.texi:37108 #, no-wrap msgid "R-Shiny service" msgstr "" #. type: Plain text #: doc/guix.texi:37111 msgid "" "The @code{(gnu services science)} module provides the following service." msgstr "" #. type: defvr #: doc/guix.texi:37112 #, no-wrap msgid "{Scheme Variable} rshiny-service-type" msgstr "" #. type: defvr #: doc/guix.texi:37117 msgid "" "This is a type of service which is used to run a webapp created with @code{r-" "shiny}. This service sets the @env{R_LIBS_USER} environment variable and " "runs the provided script to call @code{runApp}." msgstr "" #. type: deftp #: doc/guix.texi:37118 #, no-wrap msgid "{Data Type} rshiny-configuration" msgstr "" #. type: deftp #: doc/guix.texi:37120 msgid "This is the data type representing the configuration of rshiny." msgstr "" #. type: item #: doc/guix.texi:37123 #, no-wrap msgid "@code{package} (default: @code{r-shiny})" msgstr "" #. type: table #: doc/guix.texi:37125 msgid "The package to use." msgstr "" #. type: item #: doc/guix.texi:37126 #, no-wrap msgid "@code{binary} (default @code{\"rshiny\"})" msgstr "" #. type: table #: doc/guix.texi:37129 msgid "" "The name of the binary or shell script located at @code{package/bin/} to run " "when the service is run." msgstr "" #. type: table #: doc/guix.texi:37131 msgid "The common way to create this file is as follows:" msgstr "" #. type: lisp #: doc/guix.texi:37148 #, no-wrap msgid "" "@dots{}\n" "(let* ((out (assoc-ref %outputs \"out\"))\n" " (targetdir (string-append out \"/share/\" ,name))\n" " (app (string-append out \"/bin/\" ,name))\n" " (Rbin (search-input-file %build-inputs \"/bin/Rscript\")))\n" " ;; @dots{}\n" " (mkdir-p (string-append out \"/bin\"))\n" " (call-with-output-file app\n" " (lambda (port)\n" " (format port\n" "\"#!~a\n" "library(shiny)\n" "setwd(\\\"~a\\\")\n" "runApp(launch.browser=0, port=4202)~%\\n\"\n" " Rbin targetdir))))\n" msgstr "" #. type: cindex #: doc/guix.texi:37154 #, no-wrap msgid "Nix" msgstr "" #. type: subsubheading #: doc/guix.texi:37155 #, no-wrap msgid "Nix service" msgstr "" #. type: Plain text #: doc/guix.texi:37158 msgid "The @code{(gnu services nix)} module provides the following service." msgstr "" #. type: defvr #: doc/guix.texi:37159 #, no-wrap msgid "{Scheme Variable} nix-service-type" msgstr "" #. type: defvr #: doc/guix.texi:37164 msgid "" "This is the type of the service that runs build daemon of the @url{https://" "nixos.org/nix/, Nix} package manager. Here is an example showing how to use " "it:" msgstr "" #. type: lisp #: doc/guix.texi:37169 #, no-wrap msgid "" "(use-modules (gnu))\n" "(use-service-modules nix)\n" "(use-package-modules package-management)\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:37174 #, no-wrap msgid "" "(operating-system\n" " ;; @dots{}\n" " (packages (append (list nix)\n" " %base-packages))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:37177 #, no-wrap msgid "" " (services (append (list (service nix-service-type))\n" " %base-services)))\n" msgstr "" #. type: defvr #: doc/guix.texi:37180 msgid "After @command{guix system reconfigure} configure Nix for your user:" msgstr "" #. type: item #: doc/guix.texi:37182 #, no-wrap msgid "Add a Nix channel and update it. See" msgstr "" #. type: itemize #: doc/guix.texi:37184 msgid "@url{https://nixos.org/nix/manual/, Nix Package Manager Guide}." msgstr "" #. type: item #: doc/guix.texi:37185 #, no-wrap msgid "Create a symlink to your profile and activate Nix profile:" msgstr "" #. type: example #: doc/guix.texi:37191 #, no-wrap msgid "" "$ ln -s \"/nix/var/nix/profiles/per-user/$USER/profile\" ~/.nix-profile\n" "$ source /run/current-system/profile/etc/profile.d/nix.sh\n" msgstr "" #. type: deftp #: doc/guix.texi:37195 #, no-wrap msgid "{Data Type} nix-configuration" msgstr "" #. type: deftp #: doc/guix.texi:37197 msgid "This data type represents the configuration of the Nix daemon." msgstr "" #. type: item #: doc/guix.texi:37199 #, no-wrap msgid "@code{nix} (default: @code{nix})" msgstr "" #. type: table #: doc/guix.texi:37201 msgid "The Nix package to use." msgstr "" #. type: item #: doc/guix.texi:37202 #, no-wrap msgid "@code{sandbox} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:37204 msgid "Specifies whether builds are sandboxed by default." msgstr "" #. type: item #: doc/guix.texi:37205 #, no-wrap msgid "@code{build-sandbox-items} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:37208 msgid "" "This is a list of strings or objects appended to the @code{build-sandbox-" "items} field of the configuration file." msgstr "" #. type: table #: doc/guix.texi:37216 msgid "Extra command line options for @code{nix-service-type}." msgstr "" #. type: cindex #: doc/guix.texi:37219 #, no-wrap msgid "Fail2Ban" msgstr "" #. type: subsubheading #: doc/guix.texi:37220 #, no-wrap msgid "Fail2Ban service" msgstr "" #. type: Plain text #: doc/guix.texi:37226 msgid "" "@uref{http://www.fail2ban.org/, @code{fail2ban}} scans log files (e.g. " "@code{/var/log/apache/error_log}) and bans IP addresses that show malicious " "signs -- repeated password failures, attempts to make use of exploits, etc." msgstr "" #. type: Plain text #: doc/guix.texi:37229 msgid "" "@code{fail2ban-service-type} service type is provided by the @code{(gnu " "services security)} module." msgstr "" #. type: Plain text #: doc/guix.texi:37232 msgid "" "This service type runs the @code{fail2ban} daemon. It can be configured in " "various ways, which are:" msgstr "" #. type: item #: doc/guix.texi:37234 #, no-wrap msgid "Basic configuration" msgstr "" #. type: table #: doc/guix.texi:37237 msgid "" "The basic parameters of the Fail2Ban service can be configured via its " "@code{fail2ban} configuration, which is documented below." msgstr "" #. type: item #: doc/guix.texi:37238 #, no-wrap msgid "User-specified jail extensions" msgstr "" #. type: table #: doc/guix.texi:37241 msgid "" "The @code{fail2ban-jail-service} function can be used to add new Fail2Ban " "jails." msgstr "" #. type: item #: doc/guix.texi:37242 #, no-wrap msgid "Shepherd extension mechanism" msgstr "" #. type: table #: doc/guix.texi:37245 msgid "" "Service developers can extend the @code{fail2ban-service-type} service type " "itself via the usual service extension mechanism." msgstr "" #. type: defvr #: doc/guix.texi:37247 #, no-wrap msgid "{Scheme Variable} fail2ban-service-type" msgstr "" #. type: defvr #: doc/guix.texi:37251 msgid "" "This is the type of the service that runs @code{fail2ban} daemon. Below is " "an example of a basic, explicit configuration:" msgstr "" #. type: lisp #: doc/guix.texi:37266 #, no-wrap msgid "" "(append\n" " (list\n" " (service fail2ban-service-type\n" " (fail2ban-configuration\n" " (extra-jails\n" " (list\n" " (fail2ban-jail-configuration\n" " (name \"sshd\")\n" " (enabled? #t))))))\n" " ;; There is no implicit dependency on an actual SSH\n" " ;; service, so you need to provide one.\n" " (service openssh-service-type))\n" " %base-services)\n" msgstr "" #. type: deffn #: doc/guix.texi:37269 #, no-wrap msgid "{Scheme Procedure} fail2ban-jail-service @var{svc-type} @var{jail}" msgstr "" #. type: deffn #: doc/guix.texi:37272 msgid "" "Extend @var{svc-type}, a @code{} object with @var{jail}, a " "@code{fail2ban-jail-configuration} object." msgstr "" #. type: lisp #: doc/guix.texi:37288 #, no-wrap msgid "" "(append\n" " (list\n" " (service\n" " ;; The 'fail2ban-jail-service' procedure can extend any service type\n" " ;; with a fail2ban jail. This removes the requirement to explicitly\n" " ;; extend services with fail2ban-service-type.\n" " (fail2ban-jail-service\n" " openssh-service-type\n" " (fail2ban-jail-configuration\n" " (name \"sshd\")\n" " (enabled? #t)))\n" " (openssh-configuration ...))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:37293 msgid "" "Below is the reference for the different @code{jail-service-type} " "configuration records." msgstr "" #. type: deftp #: doc/guix.texi:37298 #, no-wrap msgid "{Data Type} fail2ban-configuration" msgstr "" #. type: deftp #: doc/guix.texi:37300 msgid "Available @code{fail2ban-configuration} fields are:" msgstr "" #. type: item #: doc/guix.texi:37302 #, no-wrap msgid "@code{fail2ban} (default: @code{fail2ban}) (type: package)" msgstr "" #. type: table #: doc/guix.texi:37306 msgid "" "The @code{fail2ban} package to use. It is used for both binaries and as " "base default configuration that is to be extended with @code{} objects." msgstr "" #. type: item #: doc/guix.texi:37307 #, no-wrap msgid "@code{run-directory} (default: @code{\"/var/run/fail2ban\"}) (type: string)" msgstr "" #. type: table #: doc/guix.texi:37309 msgid "The state directory for the @code{fail2ban} daemon." msgstr "" #. type: item #: doc/guix.texi:37310 #, no-wrap msgid "@code{jails} (default: @code{()}) (type: list-of-fail2ban-jail-configurations)" msgstr "" #. type: table #: doc/guix.texi:37313 msgid "" "Instances of @code{} collected from extensions." msgstr "" #. type: item #: doc/guix.texi:37314 #, no-wrap msgid "@code{extra-jails} (default: @code{()}) (type: list-of-fail2ban-jail-configurations)" msgstr "" #. type: table #: doc/guix.texi:37316 msgid "Instances of @code{} explicitly provided." msgstr "" #. type: item #: doc/guix.texi:37317 doc/guix.texi:37446 #, no-wrap msgid "@code{extra-content} (default: @code{()}) (type: text-config)" msgstr "" #. type: table #: doc/guix.texi:37320 msgid "" "Extra raw content to add to the end of the @file{jail.local} file, provided " "as a list of file-like objects." msgstr "" #. type: deftp #: doc/guix.texi:37325 #, no-wrap msgid "{Data Type} fail2ban-ignore-cache-configuration" msgstr "" #. type: deftp #: doc/guix.texi:37327 msgid "Available @code{fail2ban-ignore-cache-configuration} fields are:" msgstr "" #. type: item #: doc/guix.texi:37329 #, no-wrap msgid "@code{key} (type: string)" msgstr "" #. type: table #: doc/guix.texi:37331 msgid "Cache key." msgstr "" #. type: item #: doc/guix.texi:37332 #, no-wrap msgid "@code{max-count} (type: integer)" msgstr "" #. type: table #: doc/guix.texi:37334 msgid "Cache size." msgstr "" #. type: item #: doc/guix.texi:37335 #, no-wrap msgid "@code{max-time} (type: integer)" msgstr "" #. type: table #: doc/guix.texi:37337 msgid "Cache time." msgstr "" #. type: deftp #: doc/guix.texi:37342 #, no-wrap msgid "{Data Type} fail2ban-jail-action-configuration" msgstr "" #. type: deftp #: doc/guix.texi:37344 msgid "Available @code{fail2ban-jail-action-configuration} fields are:" msgstr "" #. type: item #: doc/guix.texi:37346 doc/guix.texi:37360 doc/guix.texi:37458 #: doc/guix.texi:41404 #, no-wrap msgid "@code{name} (type: string)" msgstr "" #. type: table #: doc/guix.texi:37348 msgid "Action name." msgstr "" #. type: item #: doc/guix.texi:37349 #, no-wrap msgid "@code{arguments} (default: @code{()}) (type: list-of-arguments)" msgstr "" #. type: table #: doc/guix.texi:37351 msgid "Action arguments." msgstr "" #. type: deftp #: doc/guix.texi:37356 #, no-wrap msgid "{Data Type} fail2ban-jail-configuration" msgstr "" #. type: deftp #: doc/guix.texi:37358 msgid "Available @code{fail2ban-jail-configuration} fields are:" msgstr "" #. type: table #: doc/guix.texi:37362 msgid "Required name of this jail configuration." msgstr "" #. type: item #: doc/guix.texi:37363 #, no-wrap msgid "@code{enabled?} (default: @code{#t}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:37365 msgid "Whether this jail is enabled." msgstr "" #. type: item #: doc/guix.texi:37366 #, no-wrap msgid "@code{backend} (type: maybe-symbol)" msgstr "" #. type: table #: doc/guix.texi:37370 msgid "" "Backend to use to detect changes in the @code{log-path}. The default is " "'auto. To consult the defaults of the jail configuration, refer to the " "@file{/etc/fail2ban/jail.conf} file of the @code{fail2ban} package." msgstr "" #. type: item #: doc/guix.texi:37371 #, no-wrap msgid "@code{max-retry} (type: maybe-integer)" msgstr "" #. type: table #: doc/guix.texi:37374 msgid "" "The number of failures before a host get banned (e.g. @code{(max-retry 5)})." msgstr "" #. type: item #: doc/guix.texi:37375 #, no-wrap msgid "@code{max-matches} (type: maybe-integer)" msgstr "" #. type: table #: doc/guix.texi:37378 msgid "" "The number of matches stored in ticket (resolvable via tag @code{}) " "in action." msgstr "" #. type: item #: doc/guix.texi:37379 #, no-wrap msgid "@code{find-time} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:37386 msgid "" "The time window during which the maximum retry count must be reached for an " "IP address to be banned. A host is banned if it has generated @code{max-" "retry} during the last @code{find-time} seconds (e.g. @code{(find-time \"10m" "\")}). It can be provided in seconds or using Fail2Ban's \"time " "abbreviation format\", as described in @command{man 5 jail.conf}." msgstr "" #. type: item #: doc/guix.texi:37387 #, no-wrap msgid "@code{ban-time} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:37390 msgid "" "The duration, in seconds or time abbreviated format, that a ban should " "last. (e.g. @code{(ban-time \"10m\")})." msgstr "" #. type: item #: doc/guix.texi:37391 #, no-wrap msgid "@code{ban-time-increment?} (type: maybe-boolean)" msgstr "" #. type: table #: doc/guix.texi:37394 msgid "" "Whether to consider past bans to compute increases to the default ban time " "of a specific IP address." msgstr "" #. type: item #: doc/guix.texi:37395 #, no-wrap msgid "@code{ban-time-factor} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:37397 msgid "The coefficient to use to compute an exponentially growing ban time." msgstr "" #. type: item #: doc/guix.texi:37398 #, no-wrap msgid "@code{ban-time-formula} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:37400 msgid "This is the formula used to calculate the next value of a ban time." msgstr "" #. type: item #: doc/guix.texi:37401 #, no-wrap msgid "@code{ban-time-multipliers} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:37403 msgid "Used to calculate next value of ban time instead of formula." msgstr "" #. type: item #: doc/guix.texi:37404 #, no-wrap msgid "@code{ban-time-max-time} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:37406 msgid "The maximum number of seconds a ban should last." msgstr "" #. type: item #: doc/guix.texi:37407 #, no-wrap msgid "@code{ban-time-rnd-time} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:37411 msgid "" "The maximum number of seconds a randomized ban time should last. This can " "be useful to stop ``clever'' botnets calculating the exact time an IP " "address can be unbanned again." msgstr "" #. type: item #: doc/guix.texi:37412 #, no-wrap msgid "@code{ban-time-overall-jails?} (type: maybe-boolean)" msgstr "" #. type: table #: doc/guix.texi:37416 msgid "" "When true, it specifies the search of an IP address in the database should " "be made across all jails. Otherwise, only the current jail of the ban IP " "address is considered." msgstr "" #. type: item #: doc/guix.texi:37417 #, no-wrap msgid "@code{ignore-self?} (type: maybe-boolean)" msgstr "" #. type: table #: doc/guix.texi:37419 msgid "Never ban the local machine's own IP address." msgstr "" #. type: item #: doc/guix.texi:37420 #, no-wrap msgid "@code{ignore-ip} (default: @code{()}) (type: list-of-strings)" msgstr "" #. type: table #: doc/guix.texi:37424 msgid "" "A list of IP addresses, CIDR masks or DNS hosts to ignore. @code{fail2ban} " "will not ban a host which matches an address in this list." msgstr "" #. type: item #: doc/guix.texi:37425 #, no-wrap msgid "@code{ignore-cache} (type: maybe-fail2ban-ignore-cache-configuration)" msgstr "" #. type: table #: doc/guix.texi:37427 msgid "Provide cache parameters for the ignore failure check." msgstr "" #. type: item #: doc/guix.texi:37428 #, no-wrap msgid "@code{filter} (type: maybe-fail2ban-jail-filter-configuration)" msgstr "" #. type: table #: doc/guix.texi:37432 msgid "" "The filter to use by the jail, specified via a @code{} object. By default, jails have names matching their filter " "name." msgstr "" #. type: item #: doc/guix.texi:37433 #, no-wrap msgid "@code{log-time-zone} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:37435 msgid "The default time zone for log lines that do not have one." msgstr "" #. type: item #: doc/guix.texi:37436 #, no-wrap msgid "@code{log-encoding} (type: maybe-symbol)" msgstr "" #. type: table #: doc/guix.texi:37439 msgid "" "The encoding of the log files handled by the jail. Possible values are: " "@code{'ascii}, @code{'utf-8} and @code{'auto}." msgstr "" #. type: item #: doc/guix.texi:37440 #, no-wrap msgid "@code{log-path} (default: @code{()}) (type: list-of-strings)" msgstr "" #. type: table #: doc/guix.texi:37442 msgid "The file names of the log files to be monitored." msgstr "" #. type: item #: doc/guix.texi:37443 #, no-wrap msgid "@code{action} (default: @code{()}) (type: list-of-fail2ban-jail-actions)" msgstr "" #. type: table #: doc/guix.texi:37445 msgid "A list of @code{}." msgstr "" #. type: table #: doc/guix.texi:37449 msgid "" "Extra content for the jail configuration, provided as a list of file-like " "objects." msgstr "" #. type: deftp #: doc/guix.texi:37454 #, no-wrap msgid "{Data Type} fail2ban-jail-filter-configuration" msgstr "" #. type: deftp #: doc/guix.texi:37456 msgid "Available @code{fail2ban-jail-filter-configuration} fields are:" msgstr "" #. type: table #: doc/guix.texi:37460 msgid "Filter to use." msgstr "" #. type: item #: doc/guix.texi:37461 #, no-wrap msgid "@code{mode} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:37463 msgid "Mode for filter." msgstr "" #. type: cindex #: doc/guix.texi:37473 #, no-wrap msgid "setuid programs" msgstr "" #. type: cindex #: doc/guix.texi:37474 #, no-wrap msgid "setgid programs" msgstr "" #. type: Plain text #: doc/guix.texi:37484 msgid "" "Some programs need to run with elevated 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, " "@command{passwd} should be @dfn{setuid-root}, meaning that it always runs " "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:37491 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 or setgid bits directly on files that " "are in the store, we let the system administrator @emph{declare} which " "programs should be entrusted with these additional privileges." msgstr "" #. type: Plain text #: doc/guix.texi:37498 msgid "" "The @code{setuid-programs} field of an @code{operating-system} declaration " "contains a list of @code{} denoting the names of programs to " "have a setuid or setgid bit set (@pxref{Using the Configuration System}). " "For instance, the @command{mount.nfs} program, which is part of the nfs-" "utils package, with a setuid root can be designated like this:" msgstr "" #. type: lisp #: doc/guix.texi:37502 #, no-wrap msgid "" "(setuid-program\n" " (program (file-append nfs-utils \"/sbin/mount.nfs\")))\n" msgstr "" #. type: Plain text #: doc/guix.texi:37507 msgid "" "And then, to make @command{mount.nfs} setuid on your system, add the " "previous example to your operating system declaration by appending it to " "@code{%setuid-programs} like this:" msgstr "" #. type: lisp #: doc/guix.texi:37515 #, no-wrap msgid "" "(operating-system\n" " ;; Some fields omitted...\n" " (setuid-programs\n" " (append (list (setuid-program\n" " (program (file-append nfs-utils \"/sbin/mount.nfs\"))))\n" " %setuid-programs)))\n" msgstr "" #. type: deftp #: doc/guix.texi:37517 #, no-wrap msgid "{Data Type} setuid-program" msgstr "" #. type: deftp #: doc/guix.texi:37519 msgid "This data type represents a program with a setuid or setgid bit set." msgstr "" #. type: code{#1} #: doc/guix.texi:37521 #, no-wrap msgid "program" msgstr "" #. type: table #: doc/guix.texi:37523 msgid "A file-like object having its setuid and/or setgid bit set." msgstr "" #. type: item #: doc/guix.texi:37524 #, no-wrap msgid "@code{setuid?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:37526 msgid "Whether to set user setuid bit." msgstr "" #. type: item #: doc/guix.texi:37527 #, no-wrap msgid "@code{setgid?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:37529 msgid "Whether to set group setgid bit." msgstr "" #. type: item #: doc/guix.texi:37530 #, no-wrap msgid "@code{user} (default: @code{0})" msgstr "" #. type: table #: doc/guix.texi:37533 msgid "" "UID (integer) or user name (string) for the user owner of the program, " "defaults to root." msgstr "" #. type: item #: doc/guix.texi:37534 #, no-wrap msgid "@code{group} (default: @code{0})" msgstr "" #. type: table #: doc/guix.texi:37537 msgid "" "GID (integer) goup name (string) for the group owner of the program, " "defaults to root." msgstr "" #. type: Plain text #: doc/guix.texi:37543 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:37544 #, no-wrap msgid "{Scheme Variable} %setuid-programs" msgstr "" #. type: defvr #: doc/guix.texi:37547 msgid "" "A list of @code{} denoting common programs that are setuid-" "root." msgstr "" #. type: defvr #: doc/guix.texi:37550 msgid "" "The list includes commands such as @command{passwd}, @command{ping}, " "@command{su}, and @command{sudo}." msgstr "" #. type: Plain text #: doc/guix.texi:37556 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:37560 #, no-wrap msgid "HTTPS, certificates" msgstr "" #. type: cindex #: doc/guix.texi:37561 #, no-wrap msgid "X.509 certificates" msgstr "" #. type: cindex #: doc/guix.texi:37562 #, no-wrap msgid "TLS" msgstr "" #. type: Plain text #: doc/guix.texi:37569 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:37573 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:37577 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:37584 msgid "" "In Guix, this is done by adding a package that provides certificates to the " "@code{packages} field of the @code{operating-system} declaration " "(@pxref{operating-system Reference}). Guix includes one such package, " "@code{nss-certs}, which is a set of CA certificates provided as part of " "Mozilla's Network Security Services." msgstr "" #. type: Plain text #: doc/guix.texi:37589 msgid "" "Note that it is @emph{not} part of @code{%base-packages}, so you need to " "explicitly add it. The @file{/etc/ssl/certs} directory, which is where most " "applications and libraries look for certificates by default, points to the " "certificates installed globally." msgstr "" #. type: Plain text #: doc/guix.texi:37599 msgid "" "Unprivileged users, including users of Guix on a foreign distro, can also " "install their own certificate package in their profile. A number of " "environment variables need to be defined so that applications and libraries " "know where to find them. Namely, the OpenSSL library honors the " "@env{SSL_CERT_DIR} and @env{SSL_CERT_FILE} variables. Some applications add " "their own environment variables; for instance, the Git version control " "system honors the certificate bundle pointed to by the @env{GIT_SSL_CAINFO} " "environment variable. Thus, you would typically run something like:" msgstr "" #. type: example #: doc/guix.texi:37605 #, no-wrap msgid "" "guix install 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:37610 msgid "" "As another example, R requires the @env{CURL_CA_BUNDLE} environment variable " "to point to a certificate bundle, so you would have to run something like " "this:" msgstr "" #. type: example #: doc/guix.texi:37614 #, no-wrap msgid "" "guix install nss-certs\n" "export CURL_CA_BUNDLE=\"$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt\"\n" msgstr "" #. type: Plain text #: doc/guix.texi:37618 msgid "" "For other applications you may want to look up the required environment " "variable in the relevant documentation." msgstr "" #. type: cindex #: doc/guix.texi:37623 #, no-wrap msgid "name service switch" msgstr "" #. type: cindex #: doc/guix.texi:37624 #, no-wrap msgid "NSS" msgstr "" #. type: Plain text #: doc/guix.texi:37633 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:37640 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:37641 #, no-wrap msgid "nss-mdns" msgstr "" #. type: cindex #: doc/guix.texi:37642 #, no-wrap msgid ".local, host name lookup" msgstr "" #. type: Plain text #: doc/guix.texi:37647 msgid "" "As an example, the declaration below configures the NSS to use the " "@uref{https://0pointer.de/lennart/projects/nss-mdns/, @code{nss-mdns} back-" "end}, which supports host name lookups over multicast DNS (mDNS) for host " "names ending in @code{.local}:" msgstr "" #. type: lisp #: doc/guix.texi:37651 #, no-wrap msgid "" "(name-service-switch\n" " (hosts (list %files ;first, check /etc/hosts\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:37656 #, 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: lisp #: doc/guix.texi:37662 #, 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: lisp #: doc/guix.texi:37666 #, no-wrap msgid "" " ;; Then fall back to DNS.\n" " (name-service\n" " (name \"dns\"))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:37670 #, no-wrap msgid "" " ;; Finally, try with the \"full\" 'mdns'.\n" " (name-service\n" " (name \"mdns\")))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:37675 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:37683 msgid "" "Note that, in this case, in addition to setting the @code{name-service-" "switch} of the @code{operating-system} declaration, you also need to use " "@code{avahi-service-type} (@pxref{Networking Services, @code{avahi-service-" "type}}), or @code{%desktop-services}, which includes it (@pxref{Desktop " "Services}). Doing this makes @code{nss-mdns} accessible to the name service " "cache daemon (@pxref{Base Services, @code{nscd-service}})." msgstr "" #. type: Plain text #: doc/guix.texi:37686 msgid "" "For convenience, the following variables provide typical NSS configurations." msgstr "" #. type: defvr #: doc/guix.texi:37687 #, no-wrap msgid "{Scheme Variable} %default-nss" msgstr "" #. type: defvr #: doc/guix.texi:37690 msgid "" "This is the default name service switch configuration, a @code{name-service-" "switch} object." msgstr "" #. type: defvr #: doc/guix.texi:37692 #, no-wrap msgid "{Scheme Variable} %mdns-host-lookup-nss" msgstr "" #. type: defvr #: doc/guix.texi:37695 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:37705 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:37706 #, no-wrap msgid "{Data Type} name-service-switch" msgstr "" #. type: deftp #: doc/guix.texi:37711 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:37713 #, no-wrap msgid "aliases" msgstr "" #. type: itemx #: doc/guix.texi:37714 #, no-wrap msgid "ethers" msgstr "" #. type: itemx #: doc/guix.texi:37716 #, no-wrap msgid "gshadow" msgstr "" #. type: itemx #: doc/guix.texi:37717 #, no-wrap msgid "hosts" msgstr "" #. type: itemx #: doc/guix.texi:37718 #, no-wrap msgid "initgroups" msgstr "" #. type: itemx #: doc/guix.texi:37719 #, no-wrap msgid "netgroup" msgstr "" #. type: itemx #: doc/guix.texi:37720 #, no-wrap msgid "networks" msgstr "" #. type: itemx #: doc/guix.texi:37723 #, no-wrap msgid "rpc" msgstr "" #. type: itemx #: doc/guix.texi:37725 #, no-wrap msgid "shadow" msgstr "" #. type: table #: doc/guix.texi:37728 msgid "" "The system databases handled by the NSS@. Each of these fields must be a " "list of @code{} objects (see below)." msgstr "" #. type: deftp #: doc/guix.texi:37731 #, no-wrap msgid "{Data Type} name-service" msgstr "" #. type: deftp #: doc/guix.texi:37735 msgid "" "This is the data type representing an actual name service and the associated " "lookup action." msgstr "" #. type: table #: doc/guix.texi:37740 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:37745 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:37746 #, no-wrap msgid "reaction" msgstr "" #. type: table #: doc/guix.texi:37750 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: lisp #: doc/guix.texi:37754 #, no-wrap msgid "" "(lookup-specification (unavailable => continue)\n" " (success => return))\n" msgstr "" #. type: Plain text #: doc/guix.texi:37768 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:37777 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: lisp #: doc/guix.texi:37782 #, no-wrap msgid "" "(operating-system\n" " ;; @dots{}\n" " (initrd-modules (cons \"megaraid_sas\" %base-initrd-modules)))\n" msgstr "" #. type: defvr #: doc/guix.texi:37784 #, no-wrap msgid "{Scheme Variable} %base-initrd-modules" msgstr "" #. type: defvr #: doc/guix.texi:37786 msgid "This is the list of kernel modules included in the initrd by default." msgstr "" #. type: Plain text #: doc/guix.texi:37794 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:37799 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: lisp #: doc/guix.texi:37807 #, 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:37812 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:37819 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:37824 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:37826 #, no-wrap msgid "gnu.load=@var{boot}" msgstr "" #. type: table #: doc/guix.texi:37829 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:37833 msgid "" "Guix uses this option to yield control to a boot program that runs the " "service activation programs and then spawns the GNU@tie{}Shepherd, the " "initialization system." msgstr "" #. type: item #: doc/guix.texi:37834 #, no-wrap msgid "root=@var{root}" msgstr "" #. type: table #: doc/guix.texi:37839 msgid "" "Mount @var{root} as the root file system. @var{root} can be a device name " "like @code{/dev/sda1}, a file system label, or a file system UUID. When " "unspecified, the device name from the root file system of the operating " "system declaration is used." msgstr "" #. type: item #: doc/guix.texi:37840 #, no-wrap msgid "rootfstype=@var{type}" msgstr "" #. type: table #: doc/guix.texi:37844 msgid "" "Set the type of the root file system. It overrides the @code{type} field of " "the root file system specified via the @code{operating-system} declaration, " "if any." msgstr "" #. type: item #: doc/guix.texi:37845 #, no-wrap msgid "rootflags=@var{options}" msgstr "" #. type: table #: doc/guix.texi:37849 msgid "" "Set the mount @emph{options} of the root file system. It overrides the " "@code{options} field of the root file system specified via the " "@code{operating-system} declaration, if any." msgstr "" #. type: item #: doc/guix.texi:37850 #, no-wrap msgid "fsck.mode=@var{mode}" msgstr "" #. type: table #: doc/guix.texi:37856 msgid "" "Whether to check the @var{root} file system for errors before mounting it. " "@var{mode} is one of @code{skip} (never check), @code{force} (always check), " "or @code{auto} to respect the root @code{} object's " "@code{check?} setting (@pxref{File Systems}) and run a full scan only if the " "file system was not cleanly shut down." msgstr "" #. type: table #: doc/guix.texi:37859 msgid "" "@code{auto} is the default if this option is not present or if @var{mode} is " "not one of the above." msgstr "" #. type: item #: doc/guix.texi:37860 #, no-wrap msgid "fsck.repair=@var{level}" msgstr "" #. type: table #: doc/guix.texi:37865 msgid "" "The level of repairs to perform automatically if errors are found in the " "@var{root} file system. @var{level} is one of @code{no} (do not write to " "@var{root} at all if possible), @code{yes} (repair as much as possible), or " "@code{preen} to repair problems considered safe to repair automatically." msgstr "" #. type: table #: doc/guix.texi:37868 msgid "" "@code{preen} is the default if this option is not present or if @var{level} " "is not one of the above." msgstr "" #. type: item #: doc/guix.texi:37869 #, no-wrap msgid "gnu.system=@var{system}" msgstr "" #. type: table #: doc/guix.texi:37872 msgid "" "Have @file{/run/booted-system} and @file{/run/current-system} point to " "@var{system}." msgstr "" #. type: item #: doc/guix.texi:37873 #, no-wrap msgid "modprobe.blacklist=@var{modules}@dots{}" msgstr "" #. type: cindex #: doc/guix.texi:37874 #, no-wrap msgid "module, black-listing" msgstr "" #. type: cindex #: doc/guix.texi:37875 #, no-wrap msgid "black list, of kernel modules" msgstr "" #. type: table #: doc/guix.texi:37880 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:37881 #, no-wrap msgid "gnu.repl" msgstr "" #. type: table #: doc/guix.texi:37887 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:37893 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:37896 #, no-wrap msgid "{Scheme Procedure} raw-initrd @var{file-systems} @" msgstr "" #. type: deffn #: doc/guix.texi:37912 msgid "" "[#:linux-modules '()] [#:pre-mount #t] [#:mapped-devices '()] @ [#:keyboard-" "layout #f] [#:helper-packages '()] @ [#:qemu-networking? #f] [#:volatile-" "root? #f] Return a derivation that builds a raw initrd. @var{file-systems} " "is a list of file systems to be mounted by the initrd, possibly in addition " "to the root file system specified on the kernel command line via " "@option{root}. @var{linux-modules} is a list of kernel modules to be loaded " "at boot time. @var{mapped-devices} is a list of device mappings to realize " "before @var{file-systems} are mounted (@pxref{Mapped Devices}). @var{pre-" "mount} is a G-expression to evaluate before realizing @var{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:37918 doc/guix.texi:37942 msgid "" "When true, @var{keyboard-layout} is a @code{} record " "denoting the desired console keyboard layout. This is done before " "@var{mapped-devices} are set up and before @var{file-systems} are mounted " "such that, should the user need to enter a passphrase or use the REPL, this " "happens using the intended keyboard layout." msgstr "" #. type: deffn #: doc/guix.texi:37922 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:37925 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:37927 #, no-wrap msgid "{Scheme Procedure} base-initrd @var{file-systems} @" msgstr "" #. type: deffn #: doc/guix.texi:37936 msgid "" "[#:mapped-devices '()] [#:keyboard-layout #f] @ [#:qemu-networking? #f] [#:" "volatile-root? #f] @ [#:linux-modules '()] Return as a file-like object a " "generic initrd, with kernel modules taken from @var{linux}. @var{file-" "systems} is a list of file-systems to be mounted by the initrd, possibly in " "addition to the root file system specified on the kernel command line via " "@option{root}. @var{mapped-devices} is a list of device mappings to realize " "before @var{file-systems} are mounted." msgstr "" #. type: deffn #: doc/guix.texi:37944 msgid "" "@var{qemu-networking?} and @var{volatile-root?} behaves as in @code{raw-" "initrd}." msgstr "" #. type: deffn #: doc/guix.texi:37949 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:37956 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:37957 #, no-wrap msgid "{Scheme Procedure} expression->initrd @var{exp} @" msgstr "" #. type: deffn #: doc/guix.texi:37963 msgid "" "[#:guile %guile-static-stripped] [#:name \"guile-initrd\"] Return as a file-" "like object a Linux initrd (a gzipped cpio archive) containing @var{guile} " "and that evaluates @var{exp}, a G-expression, upon booting. All the " "derivations referenced by @var{exp} are automatically copied to the initrd." msgstr "" #. type: cindex #: doc/guix.texi:37969 #, no-wrap msgid "boot loader" msgstr "" #. type: Plain text #: doc/guix.texi:37976 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:37981 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:37982 #, no-wrap msgid "{Data Type} bootloader-configuration" msgstr "" #. type: deftp #: doc/guix.texi:37984 msgid "The type of a bootloader configuration declaration." msgstr "" #. type: cindex #: doc/guix.texi:37988 #, no-wrap msgid "EFI, bootloader" msgstr "" #. type: cindex #: doc/guix.texi:37989 #, no-wrap msgid "UEFI, bootloader" msgstr "" #. type: cindex #: doc/guix.texi:37990 #, no-wrap msgid "BIOS, bootloader" msgstr "" #. type: table #: doc/guix.texi:37995 msgid "" "The bootloader to use, as a @code{bootloader} object. For now @code{grub-" "bootloader}, @code{grub-efi-bootloader}, @code{grub-efi-netboot-bootloader}, " "@code{grub-efi-removable-bootloader}, @code{extlinux-bootloader} and @code{u-" "boot-bootloader} are supported." msgstr "" #. type: cindex #: doc/guix.texi:37996 #, no-wrap msgid "ARM, bootloaders" msgstr "" #. type: cindex #: doc/guix.texi:37997 #, no-wrap msgid "AArch64, bootloaders" msgstr "" #. type: table #: doc/guix.texi:38002 msgid "" "Available bootloaders are described in @code{(gnu bootloader @dots{})} " "modules. In particular, @code{(gnu bootloader u-boot)} contains definitions " "of bootloaders for a wide range of ARM and AArch64 systems, using the " "@uref{https://www.denx.de/wiki/U-Boot/, U-Boot bootloader}." msgstr "" #. type: table #: doc/guix.texi:38008 msgid "" "@code{grub-efi-bootloader} allows to boot on modern systems using the " "@dfn{Unified Extensible Firmware Interface} (UEFI). This is what you should " "use if the installation image contains a @file{/sys/firmware/efi} directory " "when you boot it on your system." msgstr "" #. type: table #: doc/guix.texi:38012 msgid "" "@code{grub-bootloader} allows you to boot in particular Intel-based machines " "in ``legacy'' BIOS mode." msgstr "" #. type: vindex #: doc/guix.texi:38013 #, no-wrap msgid "grub-efi-netboot-bootloader" msgstr "" #. type: table #: doc/guix.texi:38017 msgid "" "@code{grub-efi-netboot-bootloader} allows you to boot your system over " "network through TFTP@. In combination with an NFS root file system this " "allows you to build a diskless Guix system." msgstr "" #. type: table #: doc/guix.texi:38023 msgid "" "The installation of the @code{grub-efi-netboot-bootloader} generates the " "content of the TFTP root directory at @code{targets} (@pxref{Bootloader " "Configuration, @code{targets}}), to be served by a TFTP server. You may " "want to mount your TFTP server directories onto the @code{targets} to move " "the required files to the TFTP server automatically." msgstr "" #. type: table #: doc/guix.texi:38032 msgid "" "If you plan to use an NFS root file system as well (actually if you mount " "the store from an NFS share), then the TFTP server needs to serve the file " "@file{/boot/grub/grub.cfg} and other files from the store (like GRUBs " "background image, the kernel (@pxref{operating-system Reference, " "@code{kernel}}) and the initrd (@pxref{operating-system Reference, " "@code{initrd}})), too. All these files from the store will be accessed by " "GRUB through TFTP with their normal store path, for example as @file{tftp://" "tftp-server/gnu/store/…-initrd/initrd.cpio.gz}." msgstr "" #. type: table #: doc/guix.texi:38041 msgid "" "Two symlinks are created to make this possible. For each target in the " "@code{targets} field, the first symlink is @samp{target}@file{/efi/Guix/boot/" "grub/grub.cfg} pointing to @file{../../../boot/grub/grub.cfg}, where " "@samp{target} may be @file{/boot}. In this case the link is not leaving the " "served TFTP root directory, but otherwise it does. The second link is " "@samp{target}@file{/gnu/store} and points to @file{../gnu/store}. This link " "is leaving the served TFTP root directory." msgstr "" #. type: table #: doc/guix.texi:38047 msgid "" "The assumption behind all this is that you have an NFS server exporting the " "root file system for your Guix system, and additionally a TFTP server " "exporting your @code{targets} directories—usually a single @file{/boot}—from " "that same root file system for your Guix system. In this constellation the " "symlinks will work." msgstr "" #. type: table #: doc/guix.texi:38052 msgid "" "For other constellations you will have to program your own bootloader " "installer, which then takes care to make necessary files from the store " "accessible through TFTP, for example by copying them into the TFTP root " "directory to your @code{targets}." msgstr "" #. type: table #: doc/guix.texi:38057 msgid "" "It is important to note that symlinks pointing outside the TFTP root " "directory may need to be allowed in the configuration of your TFTP server. " "Further the store link exposes the whole store through TFTP@. Both points " "need to be considered carefully for security aspects." msgstr "" #. type: table #: doc/guix.texi:38062 msgid "" "Beside the @code{grub-efi-netboot-bootloader}, the already mentioned TFTP " "and NFS servers, you also need a properly configured DHCP server to make the " "booting over netboot possible. For all this we can currently only recommend " "you to look for instructions about @acronym{PXE, Preboot eXecution " "Environment}." msgstr "" #. type: vindex #: doc/guix.texi:38063 #, no-wrap msgid "grub-efi-removable-bootloader" msgstr "" #. type: table #: doc/guix.texi:38070 msgid "" "@code{grub-efi-removable-bootloader} allows you to boot your system from " "removable media by writing the GRUB file to the UEFI-specification location " "of @file{/EFI/BOOT/BOOTX64.efi} of the boot directory, usually @file{/boot/" "efi}. This is also useful for some UEFI firmwares that ``forget'' their " "configuration from their non-volatile storage. Like @code{grub-efi-" "bootloader}, this can only be used if the @file{/sys/firmware/efi} directory " "is available." msgstr "" #. type: quotation #: doc/guix.texi:38075 msgid "" "This @emph{will} overwrite the GRUB file from any other operating systems " "that also place their GRUB file in the UEFI-specification location; making " "them unbootable." msgstr "" #. type: table #: doc/guix.texi:38080 msgid "" "This is a list of strings denoting the targets onto which to install the " "bootloader." msgstr "" #. type: table #: doc/guix.texi:38091 msgid "" "The interpretation of targets depends on the bootloader in question. For " "@code{grub-bootloader}, for example, they should be device names 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} and @code{grub-efi-removable-bootloader} they " "should be mount points of the EFI file system, usually @file{/boot/efi}. " "For @code{grub-efi-netboot-bootloader}, @code{targets} should be the mount " "points corresponding to TFTP root directories served by your TFTP server." msgstr "" #. type: item #: doc/guix.texi:38092 #, no-wrap msgid "@code{menu-entries} (default: @code{()})" msgstr "" #. type: table #: doc/guix.texi:38096 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:38097 #, no-wrap msgid "@code{default-entry} (default: @code{0})" msgstr "" #. type: table #: doc/guix.texi:38100 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:38101 #, no-wrap msgid "@code{timeout} (default: @code{5})" msgstr "" #. type: table #: doc/guix.texi:38104 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: cindex #: doc/guix.texi:38105 #, no-wrap msgid "keyboard layout, for the bootloader" msgstr "" #. type: table #: doc/guix.texi:38109 msgid "" "If this is @code{#f}, the bootloader's menu (if any) uses the default " "keyboard layout, usually US@tie{}English (``qwerty'')." msgstr "" #. type: table #: doc/guix.texi:38112 msgid "" "Otherwise, this must be a @code{keyboard-layout} object (@pxref{Keyboard " "Layout})." msgstr "" #. type: quotation #: doc/guix.texi:38116 msgid "" "This option is currently ignored by bootloaders other than @code{grub} and " "@code{grub-efi}." msgstr "" #. type: item #: doc/guix.texi:38118 #, no-wrap msgid "@code{theme} (default: @var{#f})" msgstr "" #. type: table #: doc/guix.texi:38122 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:38123 #, no-wrap msgid "@code{terminal-outputs} (default: @code{'(gfxterm)})" msgstr "" #. type: table #: doc/guix.texi:38130 msgid "" "The output terminals used for the bootloader boot menu, as a list of " "symbols. GRUB accepts the values: @code{console}, @code{serial}, " "@code{serial_@{0-3@}}, @code{gfxterm}, @code{vga_text}, @code{mda_text}, " "@code{morse}, and @code{pkmodem}. This field corresponds to the GRUB " "variable @code{GRUB_TERMINAL_OUTPUT} (@pxref{Simple configuration,,, grub," "GNU GRUB manual})." msgstr "" #. type: item #: doc/guix.texi:38131 #, no-wrap msgid "@code{terminal-inputs} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:38139 msgid "" "The input terminals used for the bootloader boot menu, as a list of " "symbols. For GRUB, the default is the native platform terminal as " "determined at run-time. GRUB accepts the values: @code{console}, " "@code{serial}, @code{serial_@{0-3@}}, @code{at_keyboard}, and " "@code{usb_keyboard}. This field corresponds to the GRUB variable " "@code{GRUB_TERMINAL_INPUT} (@pxref{Simple configuration,,, grub,GNU GRUB " "manual})." msgstr "" #. type: item #: doc/guix.texi:38140 #, no-wrap msgid "@code{serial-unit} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:38144 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:38145 #, no-wrap msgid "@code{serial-speed} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:38149 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: item #: doc/guix.texi:38150 #, no-wrap msgid "@code{device-tree-support?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:38153 msgid "" "Whether to support Linux @uref{https://en.wikipedia.org/wiki/Devicetree, " "device tree} files loading." msgstr "" #. type: table #: doc/guix.texi:38158 msgid "" "This option in enabled by default. In some cases involving the @code{u-" "boot} bootloader, where the device tree has already been loaded in RAM, it " "can be handy to disable the option by setting it to @code{#f}." msgstr "" #. type: cindex #: doc/guix.texi:38162 #, no-wrap msgid "dual boot" msgstr "" #. type: cindex #: doc/guix.texi:38163 #, no-wrap msgid "boot menu" msgstr "" #. type: Plain text #: doc/guix.texi:38169 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: lisp #: doc/guix.texi:38176 #, 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:38179 msgid "Details below." msgstr "" #. type: deftp #: doc/guix.texi:38180 #, no-wrap msgid "{Data Type} menu-entry" msgstr "" #. type: deftp #: doc/guix.texi:38182 msgid "The type of an entry in the bootloader menu." msgstr "" #. type: table #: doc/guix.texi:38187 msgid "The label to show in the menu---e.g., @code{\"GNU\"}." msgstr "" #. type: item #: doc/guix.texi:38188 #, no-wrap msgid "@code{linux} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:38190 msgid "The Linux kernel image to boot, for example:" msgstr "" #. type: lisp #: doc/guix.texi:38193 #, no-wrap msgid "(file-append linux-libre \"/bzImage\")\n" msgstr "" #. type: table #: doc/guix.texi:38198 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:38201 #, no-wrap msgid "\"(hd0,msdos1)/boot/vmlinuz\"\n" msgstr "" #. type: table #: doc/guix.texi:38205 msgid "" "If the device is specified explicitly as above, then the @code{device} field " "is ignored entirely." msgstr "" #. type: item #: doc/guix.texi:38206 #, no-wrap msgid "@code{linux-arguments} (default: @code{()})" msgstr "" #. type: table #: doc/guix.texi:38209 msgid "" "The list of extra Linux kernel command-line arguments---e.g., " "@code{(\"console=ttyS0\")}." msgstr "" #. type: item #: doc/guix.texi:38210 #, no-wrap msgid "@code{initrd} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:38213 msgid "" "A G-Expression or string denoting the file name of the initial RAM disk to " "use (@pxref{G-Expressions})." msgstr "" #. type: table #: doc/guix.texi:38217 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:38223 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: item #: doc/guix.texi:38224 #, no-wrap msgid "@code{multiboot-kernel} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:38228 msgid "" "The kernel to boot in Multiboot-mode (@pxref{multiboot,,, grub, GNU GRUB " "manual}). When this field is set, a Multiboot menu-entry is generated. For " "example:" msgstr "" #. type: lisp #: doc/guix.texi:38231 #, no-wrap msgid "(file-append mach \"/boot/gnumach\")\n" msgstr "" #. type: item #: doc/guix.texi:38233 #, no-wrap msgid "@code{multiboot-arguments} (default: @code{()})" msgstr "" #. type: table #: doc/guix.texi:38235 msgid "The list of extra command-line arguments for the multiboot-kernel." msgstr "" #. type: item #: doc/guix.texi:38236 #, no-wrap msgid "@code{multiboot-modules} (default: @code{()})" msgstr "" #. type: table #: doc/guix.texi:38238 msgid "The list of commands for loading Multiboot modules. For example:" msgstr "" #. type: lisp #: doc/guix.texi:38244 #, no-wrap msgid "" "(list (list (file-append hurd \"/hurd/ext2fs.static\") \"ext2fs\"\n" " @dots{})\n" " (list (file-append libc \"/lib/ld.so.1\") \"exec\"\n" " @dots{}))\n" msgstr "" #. type: item #: doc/guix.texi:38246 #, no-wrap msgid "@code{chain-loader} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:38251 msgid "" "A string that can be accepted by @code{grub}'s @code{chainloader} directive. " "This has no effect if either @code{linux} or @code{multiboot-kernel} fields " "are specified. The following is an example of chainloading a different GNU/" "Linux system." msgstr "" #. type: lisp #: doc/guix.texi:38262 #, no-wrap msgid "" "(bootloader\n" " (bootloader-configuration\n" " ;; @dots{}\n" " (menu-entries\n" " (list\n" " (menu-entry\n" " (label \"GNU/Linux\")\n" " (device (uuid \"1C31-A17C\" 'fat))\n" " (chain-loader \"/EFI/GNULinux/grubx64.efi\"))))))\n" msgstr "" #. type: cindex #: doc/guix.texi:38267 doc/guix.texi:38327 #, no-wrap msgid "HDPI" msgstr "" #. type: cindex #: doc/guix.texi:38268 doc/guix.texi:38328 #, no-wrap msgid "HiDPI" msgstr "" #. type: cindex #: doc/guix.texi:38269 doc/guix.texi:38329 #, no-wrap msgid "resolution" msgstr "" #. type: Plain text #: doc/guix.texi:38273 msgid "" "For now only GRUB has theme support. GRUB themes are created using the " "@code{grub-theme} form, which is not fully documented yet." msgstr "" #. type: deftp #: doc/guix.texi:38274 #, no-wrap msgid "{Data Type} grub-theme" msgstr "" #. type: deftp #: doc/guix.texi:38276 msgid "Data type representing the configuration of the GRUB theme." msgstr "" #. type: item #: doc/guix.texi:38278 #, no-wrap msgid "@code{gfxmode} (default: @code{'(\"auto\")})" msgstr "" #. type: table #: doc/guix.texi:38281 msgid "" "The GRUB @code{gfxmode} to set (a list of screen resolution strings, " "@pxref{gfxmode,,, grub, GNU GRUB manual})." msgstr "" #. type: deffn #: doc/guix.texi:38284 #, no-wrap msgid "{Scheme Procedure} grub-theme" msgstr "" #. type: deffn #: doc/guix.texi:38288 msgid "" "Return the default GRUB theme used by the operating system if no " "@code{theme} field is specified in @code{bootloader-configuration} record." msgstr "" #. type: deffn #: doc/guix.texi:38291 msgid "" "It comes with a fancy background image displaying the GNU and Guix logos." msgstr "" #. type: Plain text #: doc/guix.texi:38295 msgid "" "For example, to override the default resolution, you may use something like" msgstr "" #. type: lisp #: doc/guix.texi:38303 #, no-wrap msgid "" "(bootloader\n" " (bootloader-configuration\n" " ;; @dots{}\n" " (theme (grub-theme\n" " (inherit (grub-theme))\n" " (gfxmode '(\"1024x786x32\" \"auto\"))))))\n" msgstr "" #. type: section #: doc/guix.texi:38306 #, no-wrap msgid "Invoking @command{guix system}" msgstr "" #. type: command{#1} #: doc/guix.texi:38308 #, no-wrap msgid "guix system" msgstr "" #. type: Plain text #: doc/guix.texi:38312 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:38315 #, no-wrap msgid "guix system @var{options}@dots{} @var{action} @var{file}\n" msgstr "" #. type: Plain text #: doc/guix.texi:38321 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:38323 doc/guix.texi:41607 #, no-wrap msgid "search" msgstr "" #. type: table #: doc/guix.texi:38326 msgid "" "Display available service type definitions that match the given regular " "expressions, sorted by relevance:" msgstr "" #. type: example #: doc/guix.texi:38348 #, no-wrap msgid "" "$ guix system search console\n" "name: console-fonts\n" "location: gnu/services/base.scm:806:2\n" "extends: shepherd-root\n" "description: Install the given fonts on the specified ttys (fonts are per\n" "+ virtual console on GNU/Linux). The value of this service is a list of\n" "+ tty/font pairs. The font can be the name of a font provided by the `kbd'\n" "+ package or any valid argument to `setfont', as in this example:\n" "+\n" "+ '((\"tty1\" . \"LatGrkCyr-8x16\")\n" "+ (\"tty2\" . (file-append\n" "+ font-tamzen\n" "+ \"/share/kbd/consolefonts/TamzenForPowerline10x20.psf\"))\n" "+ (\"tty3\" . (file-append\n" "+ font-terminus\n" "+ \"/share/consolefonts/ter-132n\"))) ; for HDPI\n" "relevance: 9\n" "\n" msgstr "" #. type: example #: doc/guix.texi:38354 #, no-wrap msgid "" "name: mingetty\n" "location: gnu/services/base.scm:1190: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:38361 #, no-wrap msgid "" "name: login\n" "location: gnu/services/base.scm:860: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:38363 doc/guix.texi:41643 #, no-wrap msgid "@dots{}\n" msgstr "" #. type: table #: doc/guix.texi:38368 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: cindex #: doc/guix.texi:38369 doc/guix.texi:41692 #, no-wrap msgid "service type definition, editing" msgstr "" #. type: cindex #: doc/guix.texi:38370 doc/guix.texi:41693 #, no-wrap msgid "editing, service type definition" msgstr "" #. type: item #: doc/guix.texi:38371 doc/guix.texi:41694 #, no-wrap msgid "edit" msgstr "" #. type: table #: doc/guix.texi:38373 msgid "Edit or view the definition of the given service types." msgstr "" #. type: table #: doc/guix.texi:38377 msgid "" "For example, the command below opens your editor, as specified by the " "@env{EDITOR} environment variable, on the definition of the @code{openssh} " "service type:" msgstr "" #. type: example #: doc/guix.texi:38380 #, no-wrap msgid "guix system edit openssh\n" msgstr "" #. type: item #: doc/guix.texi:38382 doc/guix.texi:41705 #, no-wrap msgid "reconfigure" msgstr "" #. type: table #: doc/guix.texi:38387 msgid "" "Build the operating system described in @var{file}, activate it, and switch " "to it@footnote{This action (and the related actions @code{switch-generation} " "and @code{roll-back}) are usable only on systems already running Guix " "System.}." msgstr "" #. type: quotation #: doc/guix.texi:38395 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: table #: doc/guix.texi:38403 msgid "" "This effects all the configuration specified in @var{file}: user accounts, " "system services, global package list, setuid programs, etc. The command " "starts system services specified in @var{file} that are not currently " "running; if a service is currently running this command will arrange for it " "to be upgraded the next time it is stopped (e.g.@: by @code{herd stop X} or " "@code{herd restart X})." msgstr "" #. type: table #: doc/guix.texi:38409 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:38414 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: cindex #: doc/guix.texi:38415 doc/guix.texi:38760 doc/guix.texi:39786 #, no-wrap msgid "provenance tracking, of the operating system" msgstr "" #. type: table #: doc/guix.texi:38420 msgid "" "Upon completion, the new system is deployed under @file{/run/current-" "system}. This directory contains @dfn{provenance meta-data}: the list of " "channels in use (@pxref{Channels}) and @var{file} itself, when available. " "You can view it by running:" msgstr "" #. type: example #: doc/guix.texi:38423 #, no-wrap msgid "guix system describe\n" msgstr "" #. type: table #: doc/guix.texi:38429 msgid "" "This information is useful should you later want to inspect how this " "particular generation was built. In fact, assuming @var{file} is self-" "contained, you can later rebuild generation @var{n} of your operating system " "with:" msgstr "" #. type: example #: doc/guix.texi:38435 #, no-wrap msgid "" "guix time-machine \\\n" " -C /var/guix/profiles/system-@var{n}-link/channels.scm -- \\\n" " system reconfigure \\\n" " /var/guix/profiles/system-@var{n}-link/configuration.scm\n" msgstr "" #. type: table #: doc/guix.texi:38441 msgid "" "You can think of it as some sort of built-in version control! Your system is " "not just a binary artifact: @emph{it carries its own source}. @xref{Service " "Reference, @code{provenance-service-type}}, for more information on " "provenance tracking." msgstr "" #. type: table #: doc/guix.texi:38447 msgid "" "By default, @command{reconfigure} @emph{prevents you from downgrading your " "system}, which could (re)introduce security vulnerabilities and also cause " "problems with ``stateful'' services such as database management systems. " "You can override that behavior by passing @option{--allow-downgrades}." msgstr "" #. type: item #: doc/guix.texi:38448 doc/guix.texi:41764 #, no-wrap msgid "switch-generation" msgstr "" #. type: table #: doc/guix.texi:38457 msgid "" "Switch to an existing system generation. This action atomically switches " "the system profile to the specified system generation. It also rearranges " "the system's existing bootloader menu entries. It makes the menu entry for " "the specified system generation the default, and it moves the entries for " "the other generations to a submenu, if supported by the bootloader being " "used. The next time the system boots, it will use the specified system " "generation." msgstr "" #. type: table #: doc/guix.texi:38461 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:38465 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:38468 #, no-wrap msgid "guix system switch-generation 7\n" msgstr "" #. type: table #: doc/guix.texi:38476 doc/guix.texi:41783 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:38479 #, no-wrap msgid "guix system switch-generation -- -1\n" msgstr "" #. type: table #: doc/guix.texi:38487 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:38489 doc/guix.texi:41789 msgid "This action will fail if the specified generation does not exist." msgstr "" #. type: item #: doc/guix.texi:38490 doc/guix.texi:41790 #, no-wrap msgid "roll-back" msgstr "" #. type: table #: doc/guix.texi:38496 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:38500 msgid "" "Currently, as with @command{switch-generation}, you must reboot after " "running this action to actually start using the preceding system generation." msgstr "" #. type: item #: doc/guix.texi:38501 doc/guix.texi:41796 #, no-wrap msgid "delete-generations" msgstr "" #. type: cindex #: doc/guix.texi:38502 #, no-wrap msgid "deleting system generations" msgstr "" #. type: cindex #: doc/guix.texi:38503 doc/guix.texi:41798 #, no-wrap msgid "saving space" msgstr "" #. type: table #: doc/guix.texi:38507 msgid "" "Delete system generations, making them candidates for garbage collection " "(@pxref{Invoking guix gc}, for information on how to run the ``garbage " "collector'')." msgstr "" #. type: table #: doc/guix.texi:38511 msgid "" "This works in the same way as @samp{guix package --delete-generations} " "(@pxref{Invoking guix package, @option{--delete-generations}}). With no " "arguments, all system generations but the current one are deleted:" msgstr "" #. type: example #: doc/guix.texi:38514 #, no-wrap msgid "guix system delete-generations\n" msgstr "" #. type: table #: doc/guix.texi:38518 msgid "" "You can also select the generations you want to delete. The example below " "deletes all the system generations that are more than two months old:" msgstr "" #. type: example #: doc/guix.texi:38521 #, no-wrap msgid "guix system delete-generations 2m\n" msgstr "" #. type: table #: doc/guix.texi:38526 msgid "" "Running this command automatically reinstalls the bootloader with an updated " "list of menu entries---e.g., the ``old generations'' sub-menu in GRUB no " "longer lists the generations that have been deleted." msgstr "" #. type: table #: doc/guix.texi:38531 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:38532 #, no-wrap msgid "init" msgstr "" #. type: table #: doc/guix.texi:38536 msgid "" "Populate the given directory with all the files necessary to run the " "operating system specified in @var{file}. This is useful for first-time " "installations of Guix System. For instance:" msgstr "" #. type: example #: doc/guix.texi:38539 #, no-wrap msgid "guix system init my-os-config.scm /mnt\n" msgstr "" #. type: table #: doc/guix.texi:38546 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:38550 msgid "" "This command also installs bootloader on the targets specified in @file{my-" "os-config}, unless the @option{--no-bootloader} option was passed." msgstr "" #. type: item #: doc/guix.texi:38551 #, no-wrap msgid "vm" msgstr "" #. type: cindex #: doc/guix.texi:38552 doc/guix.texi:39196 #, no-wrap msgid "virtual machine" msgstr "" #. type: cindex #: doc/guix.texi:38553 #, no-wrap msgid "VM" msgstr "" #. type: anchor{#1} #: doc/guix.texi:38557 msgid "guix system vm" msgstr "" #. type: table #: doc/guix.texi:38557 msgid "" "Build a virtual machine (VM) that contains the operating system declared in " "@var{file}, and return a script to run that VM." msgstr "" #. type: quotation #: doc/guix.texi:38565 msgid "" "The @code{vm} action and others below can use KVM support in the Linux-libre " "kernel. Specifically, if the machine has hardware virtualization support, " "the corresponding KVM kernel module should be loaded, and the @file{/dev/" "kvm} device node must exist and be readable and writable by the user and by " "the build users of the daemon (@pxref{Build Environment Setup})." msgstr "" #. type: table #: doc/guix.texi:38570 msgid "" "Arguments given to the script are passed to QEMU as in the example below, " "which enables networking and requests 1@tie{}GiB of RAM for the emulated " "machine:" msgstr "" #. type: example #: doc/guix.texi:38573 #, no-wrap msgid "$ /gnu/store/@dots{}-run-vm.sh -m 1024 -smp 2 -nic user,model=virtio-net-pci\n" msgstr "" #. type: table #: doc/guix.texi:38576 msgid "It's possible to combine the two steps into one:" msgstr "" #. type: example #: doc/guix.texi:38579 #, no-wrap msgid "$ $(guix system vm my-config.scm) -m 1024 -smp 2 -nic user,model=virtio-net-pci\n" msgstr "" #. type: table #: doc/guix.texi:38582 msgid "The VM shares its store with the host system." msgstr "" #. type: table #: doc/guix.texi:38587 msgid "" "By default, the root file system of the VM is mounted volatile; the " "@option{--persistent} option can be provided to make it persistent instead. " "In that case, the VM disk-image file will be copied from the store to the " "@env{TMPDIR} directory to make it writable." msgstr "" #. type: table #: doc/guix.texi:38592 msgid "" "Additional file systems can be shared between the host and the VM using the " "@option{--share} and @option{--expose} command-line options: the former " "specifies a directory to be shared with write access, while the latter " "provides read-only access to the shared directory." msgstr "" #. type: table #: doc/guix.texi:38596 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:38600 #, no-wrap msgid "" "guix system vm my-config.scm \\\n" " --expose=$HOME --share=$HOME/tmp=/exchange\n" msgstr "" #. type: table #: doc/guix.texi:38605 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:38610 msgid "" "The @option{--full-boot} option forces a complete boot sequence, starting " "with the bootloader. This requires more disk space since a root image " "containing at least the kernel, initrd, and bootloader data files must be " "created." msgstr "" #. type: table #: doc/guix.texi:38613 msgid "" "The @option{--image-size} option can be used to specify the size of the " "image." msgstr "" #. type: table #: doc/guix.texi:38620 msgid "" "The @option{--no-graphic} option will instruct @command{guix system} to " "spawn a headless VM that will use the invoking tty for IO. Among other " "things, this enables copy-pasting, and scrollback. Use the @kbd{ctrl-a} " "prefix to issue QEMU commands; e.g. @kbd{ctrl-a h} prints a help, @kbd{ctrl-" "a x} quits the VM, and @kbd{ctrl-a c} switches between the QEMU monitor and " "the VM." msgstr "" #. type: cindex #: doc/guix.texi:38621 #, no-wrap msgid "System images, creation in various formats" msgstr "" #. type: cindex #: doc/guix.texi:38622 #, no-wrap msgid "Creating system images in various formats" msgstr "" #. type: item #: doc/guix.texi:38623 #, no-wrap msgid "image" msgstr "" #. type: cindex #: doc/guix.texi:38624 #, no-wrap msgid "image, creating disk images" msgstr "" #. type: table #: doc/guix.texi:38636 msgid "" "The @code{image} command can produce various image types. The image type " "can be selected using the @option{--image-type} option. It defaults to " "@code{efi-raw}. When its value is @code{iso9660}, the @option{--label} " "option can be used to specify a volume ID with @code{image}. By default, " "the root file system of a disk image is mounted non-volatile; the @option{--" "volatile} option can be provided to make it volatile instead. When using " "@code{image}, the bootloader installed on the generated image is taken from " "the provided @code{operating-system} definition. The following example " "demonstrates how to generate an image that uses the @code{grub-efi-" "bootloader} bootloader and boot it with QEMU:" msgstr "" #. type: example #: doc/guix.texi:38644 #, no-wrap msgid "" "image=$(guix system image --image-type=qcow2 \\\n" " gnu/system/examples/lightweight-desktop.tmpl)\n" "cp $image /tmp/my-image.qcow2\n" "chmod +w /tmp/my-image.qcow2\n" "qemu-system-x86_64 -enable-kvm -hda /tmp/my-image.qcow2 -m 1000 \\\n" " -bios $(guix build ovmf)/share/firmware/ovmf_x64.bin\n" msgstr "" #. type: table #: doc/guix.texi:38650 msgid "" "When using the @code{efi-raw} image type, a raw disk image is produced; it " "can be copied as is to a USB stick, for instance. Assuming @code{/dev/sdc} " "is the device corresponding to a USB stick, one can copy the image to it " "using the following command:" msgstr "" #. type: example #: doc/guix.texi:38653 #, no-wrap msgid "# dd if=$(guix system image my-os.scm) of=/dev/sdc status=progress\n" msgstr "" #. type: table #: doc/guix.texi:38657 msgid "" "The @code{--list-image-types} command lists all the available image types." msgstr "" #. type: cindex #: doc/guix.texi:38658 #, no-wrap msgid "creating virtual machine images" msgstr "" #. type: table #: doc/guix.texi:38667 msgid "" "When using the @code{qcow2} image type, the returned image is in qcow2 " "format, which the QEMU emulator can efficiently use. @xref{Running Guix in a " "VM}, for more information on how to run the image in a virtual machine. The " "@code{grub-bootloader} bootloader is always used independently of what is " "declared in the @code{operating-system} file passed as argument. This is to " "make it easier to work with QEMU, which uses the SeaBIOS BIOS by default, " "expecting a bootloader to be installed in the Master Boot Record (MBR)." msgstr "" #. type: cindex #: doc/guix.texi:38668 #, no-wrap msgid "docker-image, creating docker images" msgstr "" #. type: table #: doc/guix.texi:38674 msgid "" "When using the @code{docker} image type, 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:38679 #, no-wrap msgid "" "image_id=\"$(docker load < guix-system-docker-image.tar.gz)\"\n" "container_id=\"$(docker create $image_id)\"\n" "docker start $container_id\n" msgstr "" #. type: table #: doc/guix.texi:38686 msgid "" "This command starts a new Docker container from the specified image. It " "will boot the Guix system in the usual manner, which means it will start any " "services you have defined in the operating system configuration. You can " "get an interactive shell running in the container using @command{docker " "exec}:" msgstr "" #. type: example #: doc/guix.texi:38689 #, no-wrap msgid "docker exec -ti $container_id /run/current-system/profile/bin/bash --login\n" msgstr "" #. type: table #: doc/guix.texi:38696 msgid "" "Depending on what you run in the Docker container, it may be necessary to " "give the container additional permissions. For example, if you intend to " "build software using Guix inside of the Docker container, you may need to " "pass the @option{--privileged} option to @code{docker create}." msgstr "" #. type: table #: doc/guix.texi:38700 msgid "" "Last, the @option{--network} option applies to @command{guix system docker-" "image}: it produces an image where network is supposedly shared with the " "host, and thus without services like nscd or NetworkManager." msgstr "" #. type: table #: doc/guix.texi:38708 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:38712 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:38716 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:38720 #, no-wrap msgid "" "guix system container my-config.scm \\\n" " --expose=$HOME --share=$HOME/tmp=/exchange\n" msgstr "" #. type: table #: doc/guix.texi:38725 msgid "" "The @option{--share} and @option{--expose} options can also be passed to the " "generated script to bind-mount additional directories into the container." msgstr "" #. type: quotation #: doc/guix.texi:38728 msgid "This option requires Linux-libre 3.19 or newer." msgstr "" #. type: Plain text #: doc/guix.texi:38735 doc/guix.texi:41907 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:38744 msgid "" "Consider the operating-system @var{expr} evaluates to. This is an " "alternative to specifying a file which evaluates to an operating system. " "This is used to generate the Guix system installer @pxref{Building the " "Installation Image})." msgstr "" #. type: table #: doc/guix.texi:38749 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: table #: doc/guix.texi:38759 msgid "" "Return the derivation file name of the given operating system without " "building anything." msgstr "" #. type: table #: doc/guix.texi:38768 msgid "" "As discussed above, @command{guix system init} and @command{guix system " "reconfigure} always save provenance information @i{via} a dedicated service " "(@pxref{Service Reference, @code{provenance-service-type}}). However, other " "commands don't do that by default. If you wish to, say, create a virtual " "machine image that contains provenance information, you can run:" msgstr "" #. type: example #: doc/guix.texi:38771 #, no-wrap msgid "guix system image -t qcow2 --save-provenance config.scm\n" msgstr "" #. type: table #: doc/guix.texi:38778 msgid "" "That way, the resulting image will effectively ``embed its own source'' in " "the form of meta-data in @file{/run/current-system}. With that information, " "one can rebuild the image to make sure it really contains what it pretends " "to contain; or they could use that to derive a variant of the image." msgstr "" #. type: item #: doc/guix.texi:38779 #, no-wrap msgid "--image-type=@var{type}" msgstr "" #. type: table #: doc/guix.texi:38782 msgid "For the @code{image} action, create an image with given @var{type}." msgstr "" #. type: table #: doc/guix.texi:38785 msgid "" "When this option is omitted, @command{guix system} uses the @code{efi-raw} " "image type." msgstr "" #. type: cindex #: doc/guix.texi:38786 #, no-wrap msgid "ISO-9660 format" msgstr "" #. type: cindex #: doc/guix.texi:38787 #, no-wrap msgid "CD image format" msgstr "" #. type: cindex #: doc/guix.texi:38788 #, no-wrap msgid "DVD image format" msgstr "" #. type: table #: doc/guix.texi:38791 msgid "" "@option{--image-type=iso9660} produces an ISO-9660 image, suitable for " "burning on CDs and DVDs." msgstr "" #. type: item #: doc/guix.texi:38792 #, no-wrap msgid "--image-size=@var{size}" msgstr "" #. type: table #: doc/guix.texi:38797 msgid "" "For the @code{image} action, create an image of the given @var{size}. " "@var{size} may be a number of bytes, or it may include a unit as a suffix " "(@pxref{Block size, size specifications,, coreutils, GNU Coreutils})." msgstr "" #. type: table #: doc/guix.texi:38801 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: table #: doc/guix.texi:38806 msgid "" "For the @code{container} action, allow containers to access the host " "network, that is, do not create a network namespace." msgstr "" #. type: item #: doc/guix.texi:38812 #, no-wrap msgid "--skip-checks" msgstr "" #. type: table #: doc/guix.texi:38814 msgid "Skip pre-installation safety checks." msgstr "" #. type: table #: doc/guix.texi:38821 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: table #: doc/guix.texi:38824 msgid "Instruct @command{guix system reconfigure} to allow system downgrades." msgstr "" #. type: table #: doc/guix.texi:38832 msgid "" "By default, @command{reconfigure} prevents you from downgrading your " "system. It achieves that by comparing the provenance info of your system " "(shown by @command{guix system describe}) with that of your @command{guix} " "command (shown by @command{guix describe}). If the commits for " "@command{guix} are not descendants of those used for your system, " "@command{guix system reconfigure} errors out. Passing @option{--allow-" "downgrades} allows you to bypass these checks." msgstr "" #. type: cindex #: doc/guix.texi:38838 #, no-wrap msgid "on-error" msgstr "" #. type: cindex #: doc/guix.texi:38839 #, no-wrap msgid "on-error strategy" msgstr "" #. type: cindex #: doc/guix.texi:38840 #, no-wrap msgid "error strategy" msgstr "" #. type: item #: doc/guix.texi:38841 #, no-wrap msgid "--on-error=@var{strategy}" msgstr "" #. type: table #: doc/guix.texi:38844 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:38846 #, no-wrap msgid "nothing-special" msgstr "" #. type: table #: doc/guix.texi:38848 msgid "Report the error concisely and exit. This is the default strategy." msgstr "" #. type: item #: doc/guix.texi:38849 #, no-wrap msgid "backtrace" msgstr "" #. type: table #: doc/guix.texi:38851 msgid "Likewise, but also display a backtrace." msgstr "" #. type: item #: doc/guix.texi:38852 #, no-wrap msgid "debug" msgstr "" #. type: table #: doc/guix.texi:38858 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: Plain text #: doc/guix.texi:38865 msgid "" "Once you have built, configured, re-configured, and re-re-configured your " "Guix installation, you may find it useful to list the operating system " "generations available on disk---and that you can choose from the bootloader " "boot menu:" msgstr "" #. type: item #: doc/guix.texi:38868 doc/guix.texi:41823 #, no-wrap msgid "describe" msgstr "" #. type: table #: doc/guix.texi:38871 msgid "" "Describe the running system generation: its file name, the kernel and " "bootloader used, etc., as well as provenance information when available." msgstr "" #. type: table #: doc/guix.texi:38878 msgid "" "The @code{--list-installed} flag is available, with the same syntax that is " "used in @command{guix package --list-installed} (@pxref{Invoking guix " "package}). When the flag is used, the description will include a list of " "packages that are currently installed in the system profile, with optional " "filtering based on a regular expression." msgstr "" #. type: quotation #: doc/guix.texi:38885 msgid "" "The @emph{running} system generation---referred to by @file{/run/current-" "system}---is not necessarily the @emph{current} system generation---referred " "to by @file{/var/guix/profiles/system}: it differs when, for instance, you " "chose from the bootloader menu to boot an older generation." msgstr "" #. type: quotation #: doc/guix.texi:38889 msgid "" "It can also differ from the @emph{booted} system generation---referred to by " "@file{/run/booted-system}---for instance because you reconfigured the system " "in the meantime." msgstr "" #. type: item #: doc/guix.texi:38891 doc/guix.texi:41838 #, no-wrap msgid "list-generations" msgstr "" #. type: table #: doc/guix.texi:38896 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:38901 doc/guix.texi:41848 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:38904 #, no-wrap msgid "$ guix system list-generations 10d\n" msgstr "" #. type: table #: doc/guix.texi:38910 msgid "" "The @code{--list-installed} flag may also be specified, with the same syntax " "that is used in @command{guix package --list-installed}. This may be " "helpful if trying to determine when a package was added to the system." msgstr "" #. type: Plain text #: doc/guix.texi:38916 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:38918 msgid "system-extension-graph" msgstr "" #. type: item #: doc/guix.texi:38920 doc/guix.texi:41878 #, no-wrap msgid "extension-graph" msgstr "" #. type: table #: doc/guix.texi:38927 msgid "" "Emit to standard output the @dfn{service extension graph} of the operating " "system defined in @var{file} (@pxref{Service Composition}, for more " "information on service extensions). By default the output is in Dot/" "Graphviz format, but you can choose a different format with @option{--graph-" "backend}, as with @command{guix graph} (@pxref{Invoking guix graph, " "@option{--backend}}):" msgstr "" #. type: table #: doc/guix.texi:38929 doc/guix.texi:41887 msgid "The command:" msgstr "" #. type: example #: doc/guix.texi:38932 #, no-wrap msgid "$ guix system extension-graph @var{file} | xdot -\n" msgstr "" #. type: table #: doc/guix.texi:38935 doc/guix.texi:41893 msgid "shows the extension relations among services." msgstr "" #. type: quotation #: doc/guix.texi:38938 msgid "The @command{dot} program is provided by the @code{graphviz} package." msgstr "" #. type: anchor{#1} #: doc/guix.texi:38941 msgid "system-shepherd-graph" msgstr "" #. type: item #: doc/guix.texi:38941 doc/guix.texi:41895 #, no-wrap msgid "shepherd-graph" msgstr "" #. type: table #: doc/guix.texi:38946 msgid "" "Emit to standard output the @dfn{dependency graph} of shepherd services of " "the operating system defined in @var{file}. @xref{Shepherd Services}, for " "more information and for an example graph." msgstr "" #. type: table #: doc/guix.texi:38949 doc/guix.texi:41902 msgid "" "Again, the default output format is Dot/Graphviz, but you can pass @option{--" "graph-backend} to select a different one." msgstr "" #. type: section #: doc/guix.texi:38953 #, no-wrap msgid "Invoking @command{guix deploy}" msgstr "" #. type: command{#1} #: doc/guix.texi:38955 #, no-wrap msgid "guix deploy" msgstr "" #. type: Plain text #: doc/guix.texi:38962 msgid "" "We've already seen @code{operating-system} declarations used to manage a " "machine's configuration locally. Suppose you need to configure multiple " "machines, though---perhaps you're managing a service on the web that's " "comprised of several servers. @command{guix deploy} enables you to use " "those same @code{operating-system} declarations to manage multiple remote " "hosts at once as a logical ``deployment''." msgstr "" #. type: quotation #: doc/guix.texi:38967 doc/guix.texi:40495 msgid "" "The functionality described in this section is still under development and " "is subject to change. Get in touch with us on @email{guix-devel@@gnu.org}!" msgstr "" #. type: example #: doc/guix.texi:38971 #, no-wrap msgid "guix deploy @var{file}\n" msgstr "" #. type: Plain text #: doc/guix.texi:38975 msgid "" "Such an invocation will deploy the machines that the code within @var{file} " "evaluates to. As an example, @var{file} might contain a definition like " "this:" msgstr "" #. type: lisp #: doc/guix.texi:38982 #, no-wrap msgid "" ";; This is a Guix deployment of a \"bare bones\" setup, with\n" ";; no X11 display server, to a machine with an SSH daemon\n" ";; listening on localhost:2222. A configuration such as this\n" ";; may be appropriate for virtual machine with ports\n" ";; forwarded to the host's loopback interface.\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:38985 #, no-wrap msgid "" "(use-service-modules networking ssh)\n" "(use-package-modules bootloaders)\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:39006 #, no-wrap msgid "" "(define %system\n" " (operating-system\n" " (host-name \"gnu-deployed\")\n" " (timezone \"Etc/UTC\")\n" " (bootloader (bootloader-configuration\n" " (bootloader grub-bootloader)\n" " (targets '(\"/dev/vda\"))\n" " (terminal-outputs '(console))))\n" " (file-systems (cons (file-system\n" " (mount-point \"/\")\n" " (device \"/dev/vda1\")\n" " (type \"ext4\"))\n" " %base-file-systems))\n" " (services\n" " (append (list (service dhcp-client-service-type)\n" " (service openssh-service-type\n" " (openssh-configuration\n" " (permit-root-login #t)\n" " (allow-empty-passwords? #t))))\n" " %base-services))))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:39016 #, no-wrap msgid "" "(list (machine\n" " (operating-system %system)\n" " (environment managed-host-environment-type)\n" " (configuration (machine-ssh-configuration\n" " (host-name \"localhost\")\n" " (system \"x86_64-linux\")\n" " (user \"alice\")\n" " (identity \"./id_rsa\")\n" " (port 2222)))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:39029 msgid "" "The file should evaluate to a list of @var{machine} objects. This example, " "upon being deployed, will create a new generation on the remote system " "realizing the @code{operating-system} declaration @code{%system}. " "@code{environment} and @code{configuration} specify how the machine should " "be provisioned---that is, how the computing resources should be created and " "managed. The above example does not create any resources, as a " "@code{'managed-host} is a machine that is already running the Guix system " "and available over the network. This is a particularly simple case; a more " "complex deployment may involve, for example, starting virtual machines " "through a Virtual Private Server (VPS) provider. In such a case, a " "different @var{environment} type would be used." msgstr "" #. type: Plain text #: doc/guix.texi:39034 msgid "" "Do note that you first need to generate a key pair on the coordinator " "machine to allow the daemon to export signed archives of files from the " "store (@pxref{Invoking guix archive}), though this step is automatic on Guix " "System:" msgstr "" #. type: Plain text #: doc/guix.texi:39042 msgid "" "Each target machine must authorize the key of the master machine so that it " "accepts store items it receives from the coordinator:" msgstr "" #. type: example #: doc/guix.texi:39045 #, no-wrap msgid "# guix archive --authorize < coordinator-public-key.txt\n" msgstr "" #. type: Plain text #: doc/guix.texi:39056 msgid "" "@code{user}, in this example, specifies the name of the user account to log " "in as to perform the deployment. Its default value is @code{root}, but root " "login over SSH may be forbidden in some cases. To work around this, " "@command{guix deploy} can log in as an unprivileged user and employ " "@code{sudo} to escalate privileges. This will only work if @code{sudo} is " "currently installed on the remote and can be invoked non-interactively as " "@code{user}. That is, the line in @code{sudoers} granting @code{user} the " "ability to use @code{sudo} must contain the @code{NOPASSWD} tag. This can " "be accomplished with the following operating system configuration snippet:" msgstr "" #. type: lisp #: doc/guix.texi:39060 #, no-wrap msgid "" "(use-modules ...\n" " (gnu system)) ;for %sudoers-specification\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:39062 #, no-wrap msgid "" "(define %user \"username\")\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:39070 #, no-wrap msgid "" "(operating-system\n" " ...\n" " (sudoers-file\n" " (plain-file \"sudoers\"\n" " (string-append (plain-file-content %sudoers-specification)\n" " (format #f \"~a ALL = NOPASSWD: ALL~%\"\n" " %user)))))\n" "\n" msgstr "" #. type: Plain text #: doc/guix.texi:39075 msgid "" "For more information regarding the format of the @file{sudoers} file, " "consult @command{man sudoers}." msgstr "" #. type: Plain text #: doc/guix.texi:39080 msgid "" "Once you've deployed a system on a set of machines, you may find it useful " "to run a command on all of them. The @option{--execute} or @option{-x} " "option lets you do that; the example below runs @command{uname -a} on all " "the machines listed in the deployment file:" msgstr "" #. type: example #: doc/guix.texi:39083 #, no-wrap msgid "guix deploy @var{file} -x -- uname -a\n" msgstr "" #. type: Plain text #: doc/guix.texi:39087 msgid "" "One thing you may often need to do after deployment is restart specific " "services on all the machines, which you can do like so:" msgstr "" #. type: example #: doc/guix.texi:39090 #, no-wrap msgid "guix deploy @var{file} -x -- herd restart @var{service}\n" msgstr "" #. type: Plain text #: doc/guix.texi:39094 msgid "" "The @command{guix deploy -x} command returns zero if and only if the command " "succeeded on all the machines." msgstr "" #. type: Plain text #: doc/guix.texi:39099 msgid "" "Below are the data types you need to know about when writing a deployment " "file." msgstr "" #. type: deftp #: doc/guix.texi:39100 #, no-wrap msgid "{Data Type} machine" msgstr "" #. type: deftp #: doc/guix.texi:39103 msgid "" "This is the data type representing a single machine in a heterogeneous Guix " "deployment." msgstr "" #. type: table #: doc/guix.texi:39107 msgid "The object of the operating system configuration to deploy." msgstr "" #. type: code{#1} #: doc/guix.texi:39108 #, no-wrap msgid "environment" msgstr "" #. type: table #: doc/guix.texi:39110 msgid "" "An @code{environment-type} describing how the machine should be provisioned." msgstr "" #. type: item #: doc/guix.texi:39111 #, no-wrap msgid "@code{configuration} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:39116 msgid "" "An object describing the configuration for the machine's " "@code{environment}. If the @code{environment} has a default configuration, " "@code{#f} may be used. If @code{#f} is used for an environment with no " "default configuration, however, an error will be thrown." msgstr "" #. type: deftp #: doc/guix.texi:39119 #, no-wrap msgid "{Data Type} machine-ssh-configuration" msgstr "" #. type: deftp #: doc/guix.texi:39122 msgid "" "This is the data type representing the SSH client parameters for a machine " "with an @code{environment} of @code{managed-host-environment-type}." msgstr "" #. type: item #: doc/guix.texi:39125 #, no-wrap msgid "@code{build-locally?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:39127 msgid "" "If false, system derivations will be built on the machine being deployed to." msgstr "" #. type: code{#1} #: doc/guix.texi:39127 doc/guix.texi:42025 #, no-wrap msgid "system" msgstr "" #. type: table #: doc/guix.texi:39130 msgid "" "The system type describing the architecture of the machine being deployed " "to---e.g., @code{\"x86_64-linux\"}." msgstr "" #. type: item #: doc/guix.texi:39130 #, no-wrap msgid "@code{authorize?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:39133 msgid "" "If true, the coordinator's signing key will be added to the remote's ACL " "keyring." msgstr "" #. type: item #: doc/guix.texi:39135 #, no-wrap msgid "@code{identity} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:39138 msgid "" "If specified, the path to the SSH private key to use to authenticate with " "the remote host." msgstr "" #. type: item #: doc/guix.texi:39139 #, no-wrap msgid "@code{host-key} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:39141 msgid "This should be the SSH host key of the machine, which looks like this:" msgstr "" #. type: example #: doc/guix.texi:39144 #, no-wrap msgid "ssh-ed25519 AAAAC3Nz@dots{} root@@example.org\n" msgstr "" #. type: table #: doc/guix.texi:39149 msgid "" "When @code{host-key} is @code{#f}, the server is authenticated against the " "@file{~/.ssh/known_hosts} file, just like the OpenSSH @command{ssh} client " "does." msgstr "" #. type: item #: doc/guix.texi:39150 #, no-wrap msgid "@code{allow-downgrades?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:39152 msgid "Whether to allow potential downgrades." msgstr "" #. type: table #: doc/guix.texi:39160 msgid "" "Like @command{guix system reconfigure}, @command{guix deploy} compares the " "channel commits currently deployed on the remote host (as returned by " "@command{guix system describe}) to those currently in use (as returned by " "@command{guix describe}) to determine whether commits currently in use are " "descendants of those deployed. When this is not the case and @code{allow-" "downgrades?} is false, it raises an error. This ensures you do not " "accidentally downgrade remote machines." msgstr "" #. type: item #: doc/guix.texi:39161 #, no-wrap msgid "@code{safety-checks?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:39167 msgid "" "Whether to perform ``safety checks'' before deployment. This includes " "verifying that devices and file systems referred to in the operating system " "configuration actually exist on the target machine, and making sure that " "Linux modules required to access storage devices at boot time are listed in " "the @code{initrd-modules} field of the operating system." msgstr "" #. type: table #: doc/guix.texi:39170 msgid "" "These safety checks ensure that you do not inadvertently deploy a system " "that would fail to boot. Be careful before turning them off!" msgstr "" #. type: deftp #: doc/guix.texi:39173 #, no-wrap msgid "{Data Type} digital-ocean-configuration" msgstr "" #. type: deftp #: doc/guix.texi:39176 msgid "" "This is the data type describing the Droplet that should be created for a " "machine with an @code{environment} of @code{digital-ocean-environment-type}." msgstr "" #. type: code{#1} #: doc/guix.texi:39178 #, no-wrap msgid "ssh-key" msgstr "" #. type: table #: doc/guix.texi:39181 msgid "" "The path to the SSH private key to use to authenticate with the remote " "host. In the future, this field may not exist." msgstr "" #. type: code{#1} #: doc/guix.texi:39181 #, no-wrap msgid "tags" msgstr "" #. type: table #: doc/guix.texi:39184 msgid "" "A list of string ``tags'' that uniquely identify the machine. Must be given " "such that no two machines in the deployment have the same set of tags." msgstr "" #. type: code{#1} #: doc/guix.texi:39184 #, no-wrap msgid "region" msgstr "" #. type: table #: doc/guix.texi:39186 msgid "A Digital Ocean region slug, such as @code{\"nyc3\"}." msgstr "" #. type: table #: doc/guix.texi:39188 msgid "A Digital Ocean size slug, such as @code{\"s-1vcpu-1gb\"}" msgstr "" #. type: code{#1} #: doc/guix.texi:39188 #, no-wrap msgid "enable-ipv6?" msgstr "" #. type: table #: doc/guix.texi:39190 msgid "Whether or not the droplet should be created with IPv6 networking." msgstr "" #. type: section #: doc/guix.texi:39194 #, no-wrap msgid "Running Guix in a Virtual Machine" msgstr "" #. type: Plain text #: doc/guix.texi:39202 msgid "" "To run Guix in a virtual machine (VM), one can use the pre-built Guix VM " "image distributed at @url{@value{BASE-URL}/guix-system-vm-image-" "@value{VERSION}.x86_64-linux.qcow2}. This image is a compressed image in " "QCOW format. You can pass it to an emulator such as @uref{https://qemu." "org/, QEMU} (see below for details)." msgstr "" #. type: Plain text #: doc/guix.texi:39209 msgid "" "This image boots the Xfce graphical environment and it contains some " "commonly used tools. You can install more software in the image by running " "@command{guix package} in a terminal (@pxref{Invoking guix package}). You " "can also reconfigure the system based on its initial configuration file " "available as @file{/run/current-system/configuration.scm} (@pxref{Using the " "Configuration System})." msgstr "" #. type: Plain text #: doc/guix.texi:39212 msgid "" "Instead of using this pre-built image, one can also build their own image " "using @command{guix system image} (@pxref{Invoking guix system})." msgstr "" #. type: cindex #: doc/guix.texi:39213 #, no-wrap msgid "QEMU" msgstr "" #. type: Plain text #: doc/guix.texi:39220 msgid "" "If you built your own image, you must copy it out of the store (@pxref{The " "Store}) and give yourself permission to write to the copy before you can use " "it. When invoking QEMU, you must choose a system emulator that is suitable " "for your hardware platform. Here is a minimal QEMU invocation that will " "boot the result of @command{guix system image -t qcow2} on x86_64 hardware:" msgstr "" #. type: example #: doc/guix.texi:39227 #, no-wrap msgid "" "$ qemu-system-x86_64 \\\n" " -nic user,model=virtio-net-pci \\\n" " -enable-kvm -m 2048 \\\n" " -device virtio-blk,drive=myhd \\\n" " -drive if=none,file=guix-system-vm-image-@value{VERSION}.x86_64-linux.qcow2,id=myhd\n" msgstr "" #. type: Plain text #: doc/guix.texi:39230 msgid "Here is what each of these options means:" msgstr "" #. type: item #: doc/guix.texi:39232 #, no-wrap msgid "qemu-system-x86_64" msgstr "" #. type: table #: doc/guix.texi:39235 msgid "" "This specifies the hardware platform to emulate. This should match the host." msgstr "" #. type: item #: doc/guix.texi:39236 #, no-wrap msgid "-nic user,model=virtio-net-pci" msgstr "" #. type: table #: doc/guix.texi:39244 msgid "" "Enable the unprivileged user-mode network stack. The guest OS can access " "the host but not vice versa. This is the simplest way to get the guest OS " "online. @code{model} specifies which network device to emulate: " "@code{virtio-net-pci} is a special device made for virtualized operating " "systems and recommended for most uses. Assuming your hardware platform is " "x86_64, you can get a list of available NIC models by running @command{qemu-" "system-x86_64 -nic model=help}." msgstr "" #. type: item #: doc/guix.texi:39245 #, no-wrap msgid "-enable-kvm" msgstr "" #. type: table #: doc/guix.texi:39249 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:39251 #, no-wrap msgid "-m 2048" msgstr "" #. type: table #: doc/guix.texi:39254 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:39255 #, no-wrap msgid "-device virtio-blk,drive=myhd" msgstr "" #. type: table #: doc/guix.texi:39260 msgid "" "Create a @code{virtio-blk} drive called ``myhd''. @code{virtio-blk} is a " "``paravirtualization'' mechanism for block devices that allows QEMU to " "achieve better performance than if it were emulating a complete disk drive. " "See the QEMU and KVM documentation for more info." msgstr "" #. type: item #: doc/guix.texi:39261 #, no-wrap msgid "-drive if=none,file=/tmp/qemu-image,id=myhd" msgstr "" #. type: table #: doc/guix.texi:39265 msgid "" "Use our QCOW image, the @file{guix-system-vm-image-@value{VERSION}.x86_64-" "linux.qcow2} file, as the backing store of the ``myhd'' drive." msgstr "" #. type: Plain text #: doc/guix.texi:39275 msgid "" "The default @command{run-vm.sh} script that is returned by an invocation of " "@command{guix system vm} does not add a @command{-nic user} flag by " "default. To get network access from within the vm add the @code{(dhcp-" "client-service)} to your system definition and start the VM using " "@command{$(guix system vm config.scm) -nic user}. An important caveat of " "using @command{-nic user} for networking is that @command{ping} will not " "work, because it uses the ICMP protocol. You'll have to use a different " "command to check for network connectivity, for example @command{guix " "download}." msgstr "" #. type: subsection #: doc/guix.texi:39276 #, no-wrap msgid "Connecting Through SSH" msgstr "" #. type: Plain text #: doc/guix.texi:39284 msgid "" "To enable SSH inside a VM you need to add an SSH server like @code{openssh-" "service-type} to your VM (@pxref{Networking Services, @code{openssh-service-" "type}}). In addition you need to forward the SSH port, 22 by default, to " "the host. You can do this with" msgstr "" #. type: example #: doc/guix.texi:39287 #, no-wrap msgid "$(guix system vm config.scm) -nic user,model=virtio-net-pci,hostfwd=tcp::10022-:22\n" msgstr "" #. type: Plain text #: doc/guix.texi:39290 msgid "To connect to the VM you can run" msgstr "" #. type: example #: doc/guix.texi:39293 #, no-wrap msgid "ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p 10022 localhost\n" msgstr "" #. type: Plain text #: doc/guix.texi:39300 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: quotation #: doc/guix.texi:39306 msgid "" "If you find the above @samp{hostfwd} example not to be working (e.g., your " "SSH client hangs attempting to connect to the mapped port of your VM), make " "sure that your Guix System VM has networking support, such as by using the " "@code{dhcp-client-service-type} service type." msgstr "" #. type: subsection #: doc/guix.texi:39308 #, no-wrap msgid "Using @command{virt-viewer} with Spice" msgstr "" #. type: Plain text #: doc/guix.texi:39314 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:39317 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:39323 #, 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:39327 msgid "" "You'll also need to add the @code{(spice-vdagent-service)} to your system " "definition (@pxref{Miscellaneous Services, Spice service})." msgstr "" #. type: Plain text #: doc/guix.texi:39334 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:39347 #, no-wrap msgid "daemons" msgstr "" #. type: Plain text #: doc/guix.texi:39360 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:39361 #, no-wrap msgid "service extensions" msgstr "" #. type: Plain text #: doc/guix.texi:39373 msgid "" "Guix system services are connected by @dfn{extensions}. For instance, the " "secure shell service @emph{extends} the Shepherd---the initialization " "system, running as PID@tie{}1---by giving it the command lines to start and " "stop the secure shell daemon (@pxref{Networking Services, @code{openssh-" "service-type}}); the UPower service extends the D-Bus service by passing it " "its @file{.service} specification, and extends the udev service by passing " "it device management rules (@pxref{Desktop Services, @code{upower-" "service}}); the Guix daemon service extends the Shepherd by passing it the " "command lines to start and stop the daemon, and extends the account service " "by passing it a list of required build user accounts (@pxref{Base Services})." msgstr "" #. type: Plain text #: doc/guix.texi:39377 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:39379 msgid "@image{images/service-graph,,5in,Typical service extension graph.}" msgstr "" #. type: cindex #: doc/guix.texi:39380 #, no-wrap msgid "system service" msgstr "" #. type: Plain text #: doc/guix.texi:39388 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:39389 #, no-wrap msgid "service types" msgstr "" #. type: Plain text #: doc/guix.texi:39395 msgid "" "Technically, developers can define @dfn{service types} to express these " "relations. There can be any number of services of a given type on the " "system---for instance, a system running two instances of the GNU secure " "shell server (lsh) has two instances of @code{lsh-service-type}, with " "different parameters." msgstr "" #. type: Plain text #: doc/guix.texi:39398 msgid "" "The following section describes the programming interface for service types " "and services." msgstr "" #. type: Plain text #: doc/guix.texi:39405 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: lisp #: doc/guix.texi:39415 #, 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:39419 msgid "It defines three things:" msgstr "" #. type: enumerate #: doc/guix.texi:39423 msgid "A name, whose sole purpose is to make inspection and debugging easier." msgstr "" #. type: enumerate #: doc/guix.texi:39428 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:39431 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:39434 msgid "Optionally, a default value for instances of this type." msgstr "" #. type: Plain text #: doc/guix.texi:39437 msgid "In this example, @code{guix-service-type} extends three services:" msgstr "" #. type: item #: doc/guix.texi:39439 #, no-wrap msgid "shepherd-root-service-type" msgstr "" #. type: table #: doc/guix.texi:39444 msgid "" "The @code{guix-shepherd-service} procedure defines how the Shepherd service " "is extended. Namely, it returns a @code{} object that " "defines how @command{guix-daemon} is started and stopped (@pxref{Shepherd " "Services})." msgstr "" #. type: item #: doc/guix.texi:39445 #, no-wrap msgid "account-service-type" msgstr "" #. type: table #: doc/guix.texi:39450 msgid "" "This extension for this service is computed by @code{guix-accounts}, which " "returns a list of @code{user-group} and @code{user-account} objects " "representing the build user accounts (@pxref{Invoking guix-daemon})." msgstr "" #. type: item #: doc/guix.texi:39451 #, no-wrap msgid "activation-service-type" msgstr "" #. type: table #: doc/guix.texi:39455 msgid "" "Here @code{guix-activation} is a procedure that returns a gexp, which is a " "code snippet to run at ``activation time''---e.g., when the service is " "booted." msgstr "" #. type: Plain text #: doc/guix.texi:39458 msgid "A service of this type is instantiated like this:" msgstr "" #. type: lisp #: doc/guix.texi:39464 #, no-wrap msgid "" "(service guix-service-type\n" " (guix-configuration\n" " (build-accounts 5)\n" " (extra-options '(\"--gc-keep-derivations\"))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:39472 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: lisp #: doc/guix.texi:39475 #, no-wrap msgid "(service guix-service-type)\n" msgstr "" #. type: Plain text #: doc/guix.texi:39479 msgid "" "@code{guix-service-type} is quite simple because it extends other services " "but is not extensible itself." msgstr "" #. type: Plain text #: doc/guix.texi:39483 msgid "The service type for an @emph{extensible} service looks like this:" msgstr "" #. type: lisp #: doc/guix.texi:39490 #, 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: lisp #: doc/guix.texi:39498 #, no-wrap msgid "" " (compose concatenate) ;concatenate the list of rules\n" " (extend (lambda (config rules)\n" " (match config\n" " (($ 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:39504 msgid "" "This is the service type for the @uref{https://wiki.gentoo.org/wiki/Project:" "Eudev, eudev device management daemon}. Compared to the previous example, " "in addition to an extension of @code{shepherd-root-service-type}, we see two " "new fields:" msgstr "" #. type: item #: doc/guix.texi:39506 #, no-wrap msgid "compose" msgstr "" #. type: table #: doc/guix.texi:39509 msgid "" "This is the procedure to @dfn{compose} the list of extensions to services of " "this type." msgstr "" #. type: table #: doc/guix.texi:39512 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:39513 #, no-wrap msgid "extend" msgstr "" #. type: table #: doc/guix.texi:39516 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:39521 msgid "" "Udev extensions are composed into a list of rules, but the udev service " "value is itself a @code{} 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:39527 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:39532 msgid "" "There can be only one instance of an extensible service type such as " "@code{udev-service-type}. If there were more, the @code{service-extension} " "specifications would be ambiguous." msgstr "" #. type: Plain text #: doc/guix.texi:39535 msgid "" "Still here? The next section provides a reference of the programming " "interface for services." msgstr "" #. type: Plain text #: doc/guix.texi:39543 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:39544 #, no-wrap msgid "{Scheme Procedure} service @var{type} [@var{value}]" msgstr "" #. type: deffn #: doc/guix.texi:39548 msgid "" "Return a new service of @var{type}, a @code{} object (see " "below). @var{value} can be any object; it represents the parameters of this " "particular service instance." msgstr "" #. type: deffn #: doc/guix.texi:39552 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:39554 msgid "For instance, this:" msgstr "" #. type: lisp #: doc/guix.texi:39557 #, no-wrap msgid "(service openssh-service-type)\n" msgstr "" #. type: deffn #: doc/guix.texi:39561 msgid "is equivalent to this:" msgstr "" #. type: lisp #: doc/guix.texi:39565 #, no-wrap msgid "" "(service openssh-service-type\n" " (openssh-configuration))\n" msgstr "" #. type: deffn #: doc/guix.texi:39569 msgid "" "In both cases the result is an instance of @code{openssh-service-type} with " "the default configuration." msgstr "" #. type: deffn #: doc/guix.texi:39571 #, no-wrap msgid "{Scheme Procedure} service? @var{obj}" msgstr "" #. type: deffn #: doc/guix.texi:39573 msgid "Return true if @var{obj} is a service." msgstr "" #. type: deffn #: doc/guix.texi:39575 #, no-wrap msgid "{Scheme Procedure} service-kind @var{service}" msgstr "" #. type: deffn #: doc/guix.texi:39577 msgid "" "Return the type of @var{service}---i.e., a @code{} object." msgstr "" #. type: deffn #: doc/guix.texi:39579 #, no-wrap msgid "{Scheme Procedure} service-value @var{service}" msgstr "" #. type: deffn #: doc/guix.texi:39582 msgid "" "Return the value associated with @var{service}. It represents its " "parameters." msgstr "" #. type: Plain text #: doc/guix.texi:39585 msgid "Here is an example of how a service is created and manipulated:" msgstr "" #. type: lisp #: doc/guix.texi:39594 #, 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: lisp #: doc/guix.texi:39597 #, no-wrap msgid "" "(service? s)\n" "@result{} #t\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:39600 #, no-wrap msgid "" "(eq? (service-kind s) nginx-service-type)\n" "@result{} #t\n" msgstr "" #. type: Plain text #: doc/guix.texi:39610 msgid "" "The @code{modify-services} form provides a handy way to change the " "parameters of some of the services of a list such as @code{%base-services} " "(@pxref{Base Services, @code{%base-services}}). It evaluates to a list of " "services. Of course, you could always use standard list combinators such as " "@code{map} and @code{fold} to do that (@pxref{SRFI-1, List Library,, guile, " "GNU Guile Reference Manual}); @code{modify-services} simply provides a more " "concise form for this common pattern." msgstr "" #. type: deffn #: doc/guix.texi:39611 #, no-wrap msgid "{Scheme Syntax} modify-services @var{services} @" msgstr "" #. type: deffn #: doc/guix.texi:39613 msgid "(@var{type} @var{variable} => @var{body}) @dots{}" msgstr "" #. type: deffn #: doc/guix.texi:39616 msgid "" "Modify the services listed in @var{services} according to the given " "clauses. Each clause has the form:" msgstr "" #. type: example #: doc/guix.texi:39619 #, no-wrap msgid "(@var{type} @var{variable} => @var{body})\n" msgstr "" #. type: deffn #: doc/guix.texi:39626 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:39633 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:39635 msgid "Clauses can also have the following form:" msgstr "" #. type: lisp #: doc/guix.texi:39638 #, no-wrap msgid "(delete @var{type})\n" msgstr "" #. type: deffn #: doc/guix.texi:39642 msgid "" "Such a clause removes all services of the given @var{type} from " "@var{services}." msgstr "" #. type: deffn #: doc/guix.texi:39644 msgid "@xref{Using the Configuration System}, for example usage." msgstr "" #. type: Plain text #: doc/guix.texi:39651 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:39652 #, no-wrap msgid "{Data Type} service-type" msgstr "" #. type: cindex #: doc/guix.texi:39653 #, no-wrap msgid "service type" msgstr "" #. type: deftp #: doc/guix.texi:39656 msgid "" "This is the representation of a @dfn{service type} (@pxref{Service Types and " "Services})." msgstr "" #. type: table #: doc/guix.texi:39660 msgid "This is a symbol, used only to simplify inspection and debugging." msgstr "" #. type: code{#1} #: doc/guix.texi:39661 #, no-wrap msgid "extensions" msgstr "" #. type: table #: doc/guix.texi:39663 msgid "A non-empty list of @code{} objects (see below)." msgstr "" #. type: item #: doc/guix.texi:39664 #, no-wrap msgid "@code{compose} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:39668 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:39672 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:39673 #, no-wrap msgid "@code{extend} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:39675 msgid "If this is @code{#f}, services of this type cannot be extended." msgstr "" #. type: table #: doc/guix.texi:39681 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: table #: doc/guix.texi:39687 msgid "" "This is a string, possibly using Texinfo markup, describing in a couple of " "sentences what the service is about. This string allows users to find about " "the service through @command{guix system search} (@pxref{Invoking guix " "system})." msgstr "" #. type: item #: doc/guix.texi:39688 #, no-wrap msgid "@code{default-value} (default: @code{&no-default-value})" msgstr "" #. type: table #: doc/guix.texi:39691 msgid "" "The default value associated for instances of this service type. This " "allows users to use the @code{service} form without its second argument:" msgstr "" #. type: lisp #: doc/guix.texi:39694 #, no-wrap msgid "(service @var{type})\n" msgstr "" #. type: table #: doc/guix.texi:39698 msgid "" "The returned service in this case has the default value specified by " "@var{type}." msgstr "" #. type: deftp #: doc/guix.texi:39701 msgid "@xref{Service Types and Services}, for examples." msgstr "" #. type: deffn #: doc/guix.texi:39703 #, no-wrap msgid "{Scheme Procedure} service-extension @var{target-type} @" msgstr "" #. type: deffn #: doc/guix.texi:39709 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:39711 #, no-wrap msgid "{Scheme Procedure} service-extension? @var{obj}" msgstr "" #. type: deffn #: doc/guix.texi:39713 msgid "Return true if @var{obj} is a service extension." msgstr "" #. type: Plain text #: doc/guix.texi:39719 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:39720 #, no-wrap msgid "{Scheme Procedure} simple-service @var{name} @var{target} @var{value}" msgstr "" #. type: deffn #: doc/guix.texi:39724 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:39727 msgid "" "For example, this extends mcron (@pxref{Scheduled Job Execution}) with an " "additional job:" msgstr "" #. type: lisp #: doc/guix.texi:39731 #, 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:39741 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:39742 #, no-wrap msgid "{Scheme Procedure} fold-services @var{services} @" msgstr "" #. type: deffn #: doc/guix.texi:39746 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:39750 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:39751 #, no-wrap msgid "{Scheme Variable} system-service-type" msgstr "" #. type: defvr #: doc/guix.texi:39754 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:39756 #, no-wrap msgid "{Scheme Variable} boot-service-type" msgstr "" #. type: defvr #: doc/guix.texi:39759 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:39761 #, no-wrap msgid "{Scheme Variable} etc-service-type" msgstr "" #. type: defvr #: doc/guix.texi:39765 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: lisp #: doc/guix.texi:39768 #, no-wrap msgid "(list `(\"issue\" ,(plain-file \"issue\" \"Welcome!\\n\")))\n" msgstr "" #. type: defvr #: doc/guix.texi:39772 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:39774 #, no-wrap msgid "{Scheme Variable} setuid-program-service-type" msgstr "" #. type: defvr #: doc/guix.texi:39778 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 " "and setgid programs on the system (@pxref{Setuid Programs})." msgstr "" #. type: defvr #: doc/guix.texi:39780 #, no-wrap msgid "{Scheme Variable} profile-service-type" msgstr "" #. type: defvr #: doc/guix.texi:39784 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: anchor{#1} #: doc/guix.texi:39788 msgid "provenance-service-type" msgstr "" #. type: defvr #: doc/guix.texi:39788 #, no-wrap msgid "{Scheme Variable} provenance-service-type" msgstr "" #. type: defvr #: doc/guix.texi:39792 msgid "" "This is the type of the service that records @dfn{provenance meta-data} in " "the system itself. It creates several files under @file{/run/current-" "system}:" msgstr "" #. type: item #: doc/guix.texi:39794 #, no-wrap msgid "channels.scm" msgstr "" #. type: table #: doc/guix.texi:39799 msgid "" "This is a ``channel file'' that can be passed to @command{guix pull -C} or " "@command{guix time-machine -C}, and which describes the channels used to " "build the system, if that information was available (@pxref{Channels})." msgstr "" #. type: item #: doc/guix.texi:39800 #, no-wrap msgid "configuration.scm" msgstr "" #. type: table #: doc/guix.texi:39805 msgid "" "This is the file that was passed as the value for this @code{provenance-" "service-type} service. By default, @command{guix system reconfigure} " "automatically passes the OS configuration file it received on the command " "line." msgstr "" #. type: item #: doc/guix.texi:39806 #, no-wrap msgid "provenance" msgstr "" #. type: table #: doc/guix.texi:39809 msgid "" "This contains the same information as the two other files but in a format " "that is more readily processable." msgstr "" #. type: defvr #: doc/guix.texi:39813 msgid "" "In general, these two pieces of information (channels and configuration " "file) are enough to reproduce the operating system ``from source''." msgstr "" #. type: quotation #: doc/guix.texi:39814 #, no-wrap msgid "Caveats" msgstr "" #. type: quotation #: doc/guix.texi:39821 msgid "" "This information is necessary to rebuild your operating system, but it is " "not always sufficient. In particular, @file{configuration.scm} itself is " "insufficient if it is not self-contained---if it refers to external Guile " "modules or to extra files. If you want @file{configuration.scm} to be self-" "contained, we recommend that modules or files it refers to be part of a " "channel." msgstr "" #. type: quotation #: doc/guix.texi:39829 msgid "" "Besides, provenance meta-data is ``silent'' in the sense that it does not " "change the bits contained in your system, @emph{except for the meta-data " "bits themselves}. Two different OS configurations or sets of channels can " "lead to the same system, bit-for-bit; when @code{provenance-service-type} is " "used, these two systems will have different meta-data and thus different " "store file names, which makes comparison less trivial." msgstr "" #. type: defvr #: doc/guix.texi:39834 msgid "" "This service is automatically added to your operating system configuration " "when you use @command{guix system reconfigure}, @command{guix system init}, " "or @command{guix deploy}." msgstr "" #. type: defvr #: doc/guix.texi:39836 #, no-wrap msgid "{Scheme Variable} linux-loadable-module-service-type" msgstr "" #. type: defvr #: doc/guix.texi:39840 msgid "" "Type of the service that collects lists of packages containing kernel-" "loadable modules, and adds them to the set of kernel-loadable modules." msgstr "" #. type: defvr #: doc/guix.texi:39843 msgid "" "This service type is intended to be extended by other service types, such as " "below:" msgstr "" #. type: lisp #: doc/guix.texi:39849 #, no-wrap msgid "" "(simple-service 'installing-module\n" " linux-loadable-module-service-type\n" " (list module-to-install-1\n" " module-to-install-2))\n" msgstr "" #. type: defvr #: doc/guix.texi:39853 msgid "" "This does not actually load modules at bootup, only adds it to the kernel " "profile so that it @emph{can} be loaded by other means." msgstr "" #. type: cindex #: doc/guix.texi:39858 #, no-wrap msgid "shepherd services" msgstr "" #. type: cindex #: doc/guix.texi:39859 #, no-wrap msgid "PID 1" msgstr "" #. type: cindex #: doc/guix.texi:39860 #, no-wrap msgid "init system" msgstr "" #. type: Plain text #: doc/guix.texi:39866 msgid "" "The @code{(gnu services shepherd)} module provides a way to define services " "managed by the GNU@tie{}Shepherd, which is the initialization system---the " "first process that is started when the system boots, also known as PID@tie{}" "1 (@pxref{Introduction,,, shepherd, The GNU Shepherd Manual})." msgstr "" #. type: Plain text #: doc/guix.texi:39872 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:39874 msgid "@image{images/shepherd-graph,,5in,Typical shepherd service graph.}" msgstr "" #. type: Plain text #: doc/guix.texi:39878 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:39882 msgid "" "The @code{%shepherd-root-service} is a service object representing PID@tie{}" "1, of type @code{shepherd-root-service-type}; it can be extended by passing " "it lists of @code{} objects." msgstr "" #. type: deftp #: doc/guix.texi:39883 #, no-wrap msgid "{Data Type} shepherd-service" msgstr "" #. type: deftp #: doc/guix.texi:39885 msgid "The data type representing a service managed by the Shepherd." msgstr "" #. type: code{#1} #: doc/guix.texi:39887 #, no-wrap msgid "provision" msgstr "" #. type: table #: doc/guix.texi:39889 msgid "This is a list of symbols denoting what the service provides." msgstr "" #. type: table #: doc/guix.texi:39894 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:39895 #, no-wrap msgid "@code{requirement} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:39897 msgid "List of symbols denoting the Shepherd services this one depends on." msgstr "" #. type: cindex #: doc/guix.texi:39898 #, no-wrap msgid "one-shot services, for the Shepherd" msgstr "" #. type: table #: doc/guix.texi:39903 msgid "" "Whether this service is @dfn{one-shot}. One-shot services stop immediately " "after their @code{start} action has completed. @xref{Slots of services,,, " "shepherd, The GNU Shepherd Manual}, for more info." msgstr "" #. type: item #: doc/guix.texi:39904 #, no-wrap msgid "@code{respawn?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:39907 msgid "" "Whether to restart the service when it stops, for instance when the " "underlying process dies." msgstr "" #. type: code{#1} #: doc/guix.texi:39908 #, no-wrap msgid "start" msgstr "" #. type: itemx #: doc/guix.texi:39909 #, no-wrap msgid "@code{stop} (default: @code{#~(const #f)})" msgstr "" #. type: table #: doc/guix.texi:39915 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: item #: doc/guix.texi:39916 #, no-wrap msgid "@code{actions} (default: @code{'()})" msgstr "" #. type: cindex #: doc/guix.texi:39917 #, no-wrap msgid "actions, of Shepherd services" msgstr "" #. type: table #: doc/guix.texi:39922 msgid "" "This is a list of @code{shepherd-action} objects (see below) defining " "@dfn{actions} supported by the service, in addition to the standard " "@code{start} and @code{stop} actions. Actions listed here become available " "as @command{herd} sub-commands:" msgstr "" #. type: example #: doc/guix.texi:39925 #, no-wrap msgid "herd @var{action} @var{service} [@var{arguments}@dots{}]\n" msgstr "" #. type: item #: doc/guix.texi:39927 #, no-wrap msgid "@code{auto-start?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:39930 msgid "" "Whether this service should be started automatically by the Shepherd. If it " "is @code{#f} the service has to be started manually with @code{herd start}." msgstr "" #. type: table #: doc/guix.texi:39933 msgid "A documentation string, as shown when running:" msgstr "" #. type: example #: doc/guix.texi:39936 #, no-wrap msgid "herd doc @var{service-name}\n" msgstr "" #. type: table #: doc/guix.texi:39940 msgid "" "where @var{service-name} is one of the symbols in @code{provision} " "(@pxref{Invoking herd,,, shepherd, The GNU Shepherd Manual})." msgstr "" #. type: table #: doc/guix.texi:39944 msgid "" "This is the list of modules that must be in scope when @code{start} and " "@code{stop} are evaluated." msgstr "" #. type: Plain text #: doc/guix.texi:39952 msgid "" "The example below defines a Shepherd service that spawns @command{syslogd}, " "the system logger from the GNU Networking Utilities (@pxref{syslogd " "invocation, @command{syslogd},, inetutils, GNU Inetutils}):" msgstr "" #. type: example #: doc/guix.texi:39964 #, no-wrap msgid "" "(let ((config (plain-file \"syslogd.conf\" \"@dots{}\")))\n" " (shepherd-service\n" " (documentation \"Run the syslog daemon (syslogd).\")\n" " (provision '(syslogd))\n" " (requirement '(user-processes))\n" " (start #~(make-forkexec-constructor\n" " (list #$(file-append inetutils \"/libexec/syslogd\")\n" " \"--rcfile\" #$config)\n" " #:pid-file \"/var/run/syslog.pid\"))\n" " (stop #~(make-kill-destructor))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:39979 msgid "" "Key elements in this example are the @code{start} and @code{stop} fields: " "they are @dfn{staged} code snippets that use the @code{make-forkexec-" "constructor} procedure provided by the Shepherd and its dual, @code{make-" "kill-destructor} (@pxref{Service De- and Constructors,,, shepherd, The GNU " "Shepherd Manual}). The @code{start} field will have @command{shepherd} " "spawn @command{syslogd} with the given option; note that we pass " "@code{config} after @option{--rcfile}, which is a configuration file " "declared above (contents of this file are omitted). Likewise, the " "@code{stop} field tells how this service is to be stopped; in this case, it " "is stopped by making the @code{kill} system call on its PID@. Code staging " "is achieved using G-expressions: @code{#~} stages code, while @code{#$} " "``escapes'' back to host code (@pxref{G-Expressions})." msgstr "" #. type: deftp #: doc/guix.texi:39980 #, no-wrap msgid "{Data Type} shepherd-action" msgstr "" #. type: deftp #: doc/guix.texi:39983 msgid "" "This is the data type that defines additional actions implemented by a " "Shepherd service (see above)." msgstr "" #. type: table #: doc/guix.texi:39987 msgid "Symbol naming the action." msgstr "" #. type: table #: doc/guix.texi:39990 msgid "" "This is a documentation string for the action. It can be viewed by running:" msgstr "" #. type: example #: doc/guix.texi:39993 #, no-wrap msgid "herd doc @var{service} action @var{action}\n" msgstr "" #. type: item #: doc/guix.texi:39995 #, no-wrap msgid "procedure" msgstr "" #. type: table #: doc/guix.texi:39999 msgid "" "This should be a gexp that evaluates to a procedure of at least one " "argument, which is the ``running value'' of the service (@pxref{Slots of " "services,,, shepherd, The GNU Shepherd Manual})." msgstr "" #. type: deftp #: doc/guix.texi:40003 msgid "" "The following example defines an action called @code{say-hello} that kindly " "greets the user:" msgstr "" #. type: lisp #: doc/guix.texi:40012 #, no-wrap msgid "" "(shepherd-action\n" " (name 'say-hello)\n" " (documentation \"Say hi!\")\n" " (procedure #~(lambda (running . args)\n" " (format #t \"Hello, friend! arguments: ~s\\n\"\n" " args)\n" " #t)))\n" msgstr "" #. type: deftp #: doc/guix.texi:40015 msgid "" "Assuming this action is added to the @code{example} service, then you can do:" msgstr "" #. type: example #: doc/guix.texi:40021 #, no-wrap msgid "" "# herd say-hello example\n" "Hello, friend! arguments: ()\n" "# herd say-hello example a b c\n" "Hello, friend! arguments: (\"a\" \"b\" \"c\")\n" msgstr "" #. type: deftp #: doc/guix.texi:40026 msgid "" "This, as you can see, is a fairly sophisticated way to say hello. " "@xref{Service Convenience,,, shepherd, The GNU Shepherd Manual}, for more " "info on actions." msgstr "" #. type: cindex #: doc/guix.texi:40028 #, no-wrap msgid "configuration file, of Shepherd services" msgstr "" #. type: deffn #: doc/guix.texi:40029 #, no-wrap msgid "{Scheme Procedure} shepherd-configuration-action" msgstr "" #. type: deffn #: doc/guix.texi:40032 msgid "" "Return a @code{configuration} action to display @var{file}, which should be " "the name of the service's configuration file." msgstr "" #. type: deffn #: doc/guix.texi:40036 msgid "" "It can be useful to equip services with that action. For example, the " "service for the Tor anonymous router (@pxref{Networking Services, @code{tor-" "service-type}}) is defined roughly like this:" msgstr "" #. type: lisp #: doc/guix.texi:40042 #, no-wrap msgid "" "(let ((torrc (plain-file \"torrc\" @dots{})))\n" " (shepherd-service\n" " (provision '(tor))\n" " (requirement '(user-processes loopback syslogd))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:40049 #, no-wrap msgid "" " (start #~(make-forkexec-constructor\n" " (list #$(file-append tor \"/bin/tor\") \"-f\" #$torrc)\n" " #:user \"tor\" #:group \"tor\"))\n" " (stop #~(make-kill-destructor))\n" " (actions (list (shepherd-configuration-action torrc)))\n" " (documentation \"Run the Tor anonymous network overlay.\")))\n" msgstr "" #. type: deffn #: doc/guix.texi:40053 msgid "" "Thanks to this action, administrators can inspect the configuration file " "passed to @command{tor} with this shell command:" msgstr "" #. type: example #: doc/guix.texi:40056 #, no-wrap msgid "cat $(herd configuration tor)\n" msgstr "" #. type: deffn #: doc/guix.texi:40059 msgid "This can come in as a handy debugging tool!" msgstr "" #. type: defvr #: doc/guix.texi:40061 #, no-wrap msgid "{Scheme Variable} shepherd-root-service-type" msgstr "" #. type: defvr #: doc/guix.texi:40063 msgid "The service type for the Shepherd ``root service''---i.e., PID@tie{}1." msgstr "" #. type: defvr #: doc/guix.texi:40068 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{}. Its value " "must be a @code{shepherd-configuration}, as described below." msgstr "" #. type: deftp #: doc/guix.texi:40070 #, no-wrap msgid "{Data Type} shepherd-configuration" msgstr "" #. type: deftp #: doc/guix.texi:40072 doc/guix.texi:41273 msgid "This data type represents the Shepherd's configuration." msgstr "" #. type: item #: doc/guix.texi:40074 doc/guix.texi:41275 #, no-wrap msgid "shepherd (default: @code{shepherd})" msgstr "" #. type: table #: doc/guix.texi:40076 doc/guix.texi:41277 msgid "The Shepherd package to use." msgstr "" #. type: item #: doc/guix.texi:40077 doc/guix.texi:41281 #, no-wrap msgid "services (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:40081 doc/guix.texi:41285 msgid "" "A list of @code{} to start. You should probably use the " "service extension mechanism instead (@pxref{Shepherd Services})." msgstr "" #. type: Plain text #: doc/guix.texi:40086 msgid "" "The following example specifies the Shepherd package for the operating " "system:" msgstr "" #. type: lisp #: doc/guix.texi:40101 #, no-wrap msgid "" "(operating-system\n" " ;; ...\n" " (services (append (list openssh-service-type))\n" " ;; ...\n" " %desktop-services)\n" " ;; ...\n" " ;; Use own Shepherd package.\n" " (essential-services\n" " (modify-services (operating-system-default-essential-services\n" " this-operating-system)\n" " (shepherd-root-service-type config => (shepherd-configuration\n" " (inherit config)\n" " (shepherd my-shepherd))))))\n" msgstr "" #. type: defvr #: doc/guix.texi:40103 #, no-wrap msgid "{Scheme Variable} %shepherd-root-service" msgstr "" #. type: defvr #: doc/guix.texi:40105 msgid "This service represents PID@tie{}1." msgstr "" #. type: cindex #: doc/guix.texi:40109 #, no-wrap msgid "complex configurations" msgstr "" #. type: Plain text #: doc/guix.texi:40114 msgid "" "Some programs might have rather complex configuration files or formats, and " "to make it easier to create Scheme bindings for these configuration files, " "you can use the utilities defined in the @code{(gnu services configuration)} " "module." msgstr "" #. type: Plain text #: doc/guix.texi:40122 msgid "" "The main utility is the @code{define-configuration} macro, which you will " "use to define a Scheme record type (@pxref{Record Overview,,, guile, GNU " "Guile Reference Manual}). The Scheme record will be serialized to a " "configuration file by using @dfn{serializers}, which are procedures that " "take some kind of Scheme value and returns a G-expression (@pxref{G-" "Expressions}), which should, once serialized to the disk, return a string. " "More details are listed below." msgstr "" #. type: deffn #: doc/guix.texi:40123 #, no-wrap msgid "{Scheme Syntax} define-configuration @var{name} @var{clause1} @" msgstr "" #. type: deffn #: doc/guix.texi:40127 msgid "" "@var{clause2} ... Create a record type named @code{@var{name}} that " "contains the fields found in the clauses." msgstr "" #. type: deffn #: doc/guix.texi:40129 msgid "A clause can have one of the following forms:" msgstr "" #. type: example #: doc/guix.texi:40134 #, no-wrap msgid "" "(@var{field-name}\n" " (@var{type} @var{default-value})\n" " @var{documentation})\n" " \n" msgstr "" #. type: example #: doc/guix.texi:40139 #, no-wrap msgid "" "(@var{field-name}\n" " (@var{type} @var{default-value})\n" " @var{documentation}\n" " @var{serializer})\n" "\n" msgstr "" #. type: example #: doc/guix.texi:40143 #, no-wrap msgid "" "(@var{field-name}\n" " (@var{type})\n" " @var{documentation})\n" "\n" msgstr "" #. type: example #: doc/guix.texi:40148 #, no-wrap msgid "" "(@var{field-name}\n" " (@var{type})\n" " @var{documentation}\n" " @var{serializer})\n" msgstr "" #. type: deffn #: doc/guix.texi:40152 msgid "" "@var{field-name} is an identifier that denotes the name of the field in the " "generated record." msgstr "" #. type: deffn #: doc/guix.texi:40160 msgid "" "@var{type} is the type of the value corresponding to @var{field-name}; since " "Guile is untyped, a predicate procedure---@code{@var{type}?}---will be " "called on the value corresponding to the field to ensure that the value is " "of the correct type. This means that if say, @var{type} is @code{package}, " "then a procedure named @code{package?} will be applied on the value to make " "sure that it is indeed a @code{} object." msgstr "" #. type: deffn #: doc/guix.texi:40164 msgid "" "@var{default-value} is the default value corresponding to the field; if none " "is specified, the user is forced to provide a value when creating an object " "of the record type." msgstr "" #. type: deffn #: doc/guix.texi:40169 msgid "" "@var{documentation} is a string formatted with Texinfo syntax which should " "provide a description of what setting this field does." msgstr "" #. type: deffn #: doc/guix.texi:40176 msgid "" "@var{serializer} is the name of a procedure which takes two arguments, the " "first is the name of the field, and the second is the value corresponding to " "the field. The procedure should return a string or G-expression (@pxref{G-" "Expressions}) that represents the content that will be serialized to the " "configuration file. If none is specified, a procedure of the name " "@code{serialize-@var{type}} will be used." msgstr "" #. type: deffn #: doc/guix.texi:40178 msgid "A simple serializer procedure could look like this:" msgstr "" #. type: lisp #: doc/guix.texi:40183 #, no-wrap msgid "" "(define (serialize-boolean field-name value)\n" " (let ((value (if value \"true\" \"false\")))\n" " #~(string-append #$field-name #$value)))\n" msgstr "" #. type: deffn #: doc/guix.texi:40194 msgid "" "In some cases multiple different configuration records might be defined in " "the same file, but their serializers for the same type might have to be " "different, because they have different configuration formats. For example, " "the @code{serialize-boolean} procedure for the Getmail service would have to " "be different from the one for the Transmission service. To make it easier " "to deal with this situation, one can specify a serializer prefix by using " "the @code{prefix} literal in the @code{define-configuration} form. This " "means that one doesn't have to manually specify a custom @var{serializer} " "for every field." msgstr "" #. type: lisp #: doc/guix.texi:40198 #, no-wrap msgid "" "(define (foo-serialize-string field-name value)\n" " @dots{})\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:40201 #, no-wrap msgid "" "(define (bar-serialize-string field-name value)\n" " @dots{})\n" " \n" msgstr "" #. type: lisp #: doc/guix.texi:40207 #, no-wrap msgid "" "(define-configuration foo-configuration\n" " (label\n" " (string)\n" " \"The name of label.\")\n" " (prefix foo-))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:40213 #, no-wrap msgid "" "(define-configuration bar-configuration\n" " (ip-address\n" " (string)\n" " \"The IPv4 address for this device.\")\n" " (prefix bar-))\n" msgstr "" #. type: deffn #: doc/guix.texi:40219 msgid "" "However, in some cases you might not want to serialize any of the values of " "the record, to do this, you can use the @code{no-serialization} literal. " "There is also the @code{define-configuration/no-serialization} macro which " "is a shorthand of this." msgstr "" #. type: lisp #: doc/guix.texi:40227 #, no-wrap msgid "" ";; Nothing will be serialized to disk.\n" "(define-configuration foo-configuration\n" " (field\n" " (string \"test\")\n" " \"Some documentation.\")\n" " (no-serialization))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:40233 #, no-wrap msgid "" ";; The same thing as above.\n" "(define-configuration/no-serialization bar-configuration\n" " (field\n" " (string \"test\")\n" " \"Some documentation.\"))\n" msgstr "" #. type: deffn #: doc/guix.texi:40236 #, no-wrap msgid "{Scheme Syntax} define-maybe @var{type}" msgstr "" #. type: deffn #: doc/guix.texi:40241 msgid "" "Sometimes a field should not be serialized if the user doesn’t specify a " "value. To achieve this, you can use the @code{define-maybe} macro to define " "a ``maybe type''; if the value of a maybe type is left unset, or is set to " "the @code{%unset-value} value, then it will not be serialized." msgstr "" #. type: deffn #: doc/guix.texi:40248 msgid "" "When defining a ``maybe type'', the corresponding serializer for the regular " "type will be used by default. For example, a field of type @code{maybe-" "string} will be serialized using the @code{serialize-string} procedure by " "default, you can of course change this by specifying a custom serializer " "procedure. Likewise, the type of the value would have to be a string, or " "left unspecified." msgstr "" #. type: lisp #: doc/guix.texi:40251 #, no-wrap msgid "" "(define-maybe string)\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:40254 #, no-wrap msgid "" "(define (serialize-string field-name value)\n" " @dots{})\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:40261 #, no-wrap msgid "" "(define-configuration baz-configuration\n" " (name\n" " ;; If set to a string, the `serialize-string' procedure will be used\n" " ;; to serialize the string. Otherwise this field is not serialized.\n" " maybe-string\n" " \"The name of this module.\"))\n" msgstr "" #. type: deffn #: doc/guix.texi:40265 msgid "" "Like with @code{define-configuration}, one can set a prefix for the " "serializer name by using the @code{prefix} literal." msgstr "" #. type: lisp #: doc/guix.texi:40269 #, no-wrap msgid "" "(define-maybe integer\n" " (prefix baz-))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:40272 #, no-wrap msgid "" "(define (baz-serialize-integer field-name value)\n" " @dots{})\n" msgstr "" #. type: deffn #: doc/guix.texi:40279 msgid "" "There is also the @code{no-serialization} literal, which when set means that " "no serializer will be defined for the ``maybe type'', regardless of whether " "its value is set or not. @code{define-maybe/no-serialization} is a " "shorthand for specifying the @code{no-serialization} literal." msgstr "" #. type: lisp #: doc/guix.texi:40282 #, no-wrap msgid "" "(define-maybe/no-serialization symbol)\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:40287 #, no-wrap msgid "" "(define-configuration/no-serialization test-configuration\n" " (mode\n" " maybe-symbol\n" " \"Docstring.\"))\n" msgstr "" #. type: deffn #: doc/guix.texi:40290 #, no-wrap msgid "(Scheme Procedure) maybe-value-set? @var{value}" msgstr "" #. type: deffn #: doc/guix.texi:40293 msgid "" "Predicate to check whether a user explicitly specified the value of a maybe " "field." msgstr "" #. type: deffn #: doc/guix.texi:40295 #, no-wrap msgid "{Scheme Procedure} serialize-configuration @var{configuration} @" msgstr "" #. type: deffn #: doc/guix.texi:40301 msgid "" "@var{fields} Return a G-expression that contains the values corresponding to " "the @var{fields} of @var{configuration}, a record that has been generated by " "@code{define-configuration}. The G-expression can then be serialized to " "disk by using something like @code{mixed-text-file}." msgstr "" #. type: deffn #: doc/guix.texi:40303 #, no-wrap msgid "{Scheme Procedure} empty-serializer @var{field-name} @var{value}" msgstr "" #. type: deffn #: doc/guix.texi:40306 msgid "" "A serializer that just returns an empty string. The @code{serialize-" "package} procedure is an alias for this." msgstr "" #. type: Plain text #: doc/guix.texi:40311 msgid "" "Once you have defined a configuration record, you will most likely also want " "to document it so that other people know to use it. To help with that, " "there are two procedures, both of which are documented below." msgstr "" #. type: deffn #: doc/guix.texi:40312 #, no-wrap msgid "{Scheme Procedure} generate-documentation @var{documentation} @" msgstr "" #. type: deffn #: doc/guix.texi:40319 msgid "" "@var{documentation-name} Generate a Texinfo fragment from the docstrings in " "@var{documentation}, a list of @code{(@var{label} @var{fields} @var{sub-" "documentation} ...)}. @var{label} should be a symbol and should be the name " "of the configuration record. @var{fields} should be a list of all the " "fields available for the configuration record." msgstr "" #. type: deffn #: doc/guix.texi:40324 msgid "" "@var{sub-documentation} is a @code{(@var{field-name} @var{configuration-" "name})} tuple. @var{field-name} is the name of the field which takes " "another configuration record as its value, and @var{configuration-name} is " "the name of that configuration record." msgstr "" #. type: deffn #: doc/guix.texi:40331 msgid "" "@var{sub-documentation} is only needed if there are nested configuration " "records. For example, the @code{getmail-configuration} record (@pxref{Mail " "Services}) accepts a @code{getmail-configuration-file} record in one of its " "@code{rcfile} field, therefore documentation for @code{getmail-configuration-" "file} is nested in @code{getmail-configuration}." msgstr "" #. type: lisp #: doc/guix.texi:40338 #, no-wrap msgid "" "(generate-documentation\n" " `((getmail-configuration ,getmail-configuration-fields\n" " (rcfile getmail-configuration-file))\n" " @dots{})\n" " 'getmail-configuration)\n" msgstr "" #. type: deffn #: doc/guix.texi:40342 msgid "" "@var{documentation-name} should be a symbol and should be the name of the " "configuration record." msgstr "" #. type: deffn #: doc/guix.texi:40345 #, no-wrap msgid "{Scheme Procedure} configuration->documentation" msgstr "" #. type: deffn #: doc/guix.texi:40352 msgid "" "@var{configuration-symbol} Take @var{configuration-symbol}, the symbol " "corresponding to the name used when defining a configuration record with " "@code{define-configuration}, and print the Texinfo documentation of its " "fields. This is useful if there aren’t any nested configuration records " "since it only prints the documentation for the top-level fields." msgstr "" #. type: Plain text #: doc/guix.texi:40360 msgid "" "As of right now, there is no automated way to generate documentation for " "configuration records and put them in the manual. Instead, every time you " "make a change to the docstrings of a configuration record, you have to " "manually call @code{generate-documentation} or @code{configuration-" ">documentation}, and paste the output into the @file{doc/guix.texi} file." msgstr "" #. type: Plain text #: doc/guix.texi:40364 msgid "" "Below is an example of a record type created using @code{define-" "configuration} and friends." msgstr "" #. type: lisp #: doc/guix.texi:40371 #, no-wrap msgid "" "(use-modules (gnu services)\n" " (guix gexp)\n" " (gnu services configuration)\n" " (srfi srfi-26)\n" " (srfi srfi-1))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:40379 #, no-wrap msgid "" ";; Turn field names, which are Scheme symbols into strings\n" "(define (uglify-field-name field-name)\n" " (let ((str (symbol->string field-name)))\n" " ;; field? -> is-field\n" " (if (string-suffix? \"?\" str)\n" " (string-append \"is-\" (string-drop-right str 1))\n" " str)))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:40382 #, no-wrap msgid "" "(define (serialize-string field-name value)\n" " #~(string-append #$(uglify-field-name field-name) \" = \" #$value \"\\n\"))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:40385 #, no-wrap msgid "" "(define (serialize-integer field-name value)\n" " (serialize-string field-name (number->string value)))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:40388 #, no-wrap msgid "" "(define (serialize-boolean field-name value)\n" " (serialize-string field-name (if value \"true\" \"false\")))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:40391 #, no-wrap msgid "" "(define (serialize-contact-name field-name value)\n" " #~(string-append \"\\n[\" #$value \"]\\n\"))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:40394 #, no-wrap msgid "" "(define (list-of-contact-configurations? lst)\n" " (every contact-configuration? lst))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:40399 #, no-wrap msgid "" "(define (serialize-list-of-contact-configurations field-name value)\n" " #~(string-append #$@@(map (cut serialize-configuration <>\n" " contact-configuration-fields)\n" " value)))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:40406 #, no-wrap msgid "" "(define (serialize-contacts-list-configuration configuration)\n" " (mixed-text-file\n" " \"contactrc\"\n" " #~(string-append \"[Owner]\\n\"\n" " #$(serialize-configuration\n" " configuration contacts-list-configuration-fields))))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:40409 #, no-wrap msgid "" "(define-maybe integer)\n" "(define-maybe string)\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:40424 #, no-wrap msgid "" "(define-configuration contact-configuration\n" " (name\n" " (string)\n" " \"The name of the contact.\"\n" " serialize-contact-name)\n" " (phone-number\n" " maybe-integer\n" " \"The person's phone number.\")\n" " (email\n" " maybe-string\n" " \"The person's email address.\")\n" " (married?\n" " (boolean)\n" " \"Whether the person is married.\"))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:40436 #, no-wrap msgid "" "(define-configuration contacts-list-configuration\n" " (name\n" " (string)\n" " \"The name of the owner of this contact list.\")\n" " (email\n" " (string)\n" " \"The owner's email address.\")\n" " (contacts\n" " (list-of-contact-configurations '())\n" " \"A list of @@code@{contact-configuation@} records which contain\n" "information about all your contacts.\"))\n" msgstr "" #. type: Plain text #: doc/guix.texi:40439 msgid "A contacts list configuration could then be created like this:" msgstr "" #. type: lisp #: doc/guix.texi:40455 #, no-wrap msgid "" "(define my-contacts\n" " (contacts-list-configuration\n" " (name \"Alice\")\n" " (email \"alice@@example.org\")\n" " (contacts\n" " (list (contact-configuration\n" " (name \"Bob\")\n" " (phone-number 1234)\n" " (email \"bob@@gnu.org\")\n" " (married? #f))\n" " (contact-configuration\n" " (name \"Charlie\")\n" " (phone-number 0000)\n" " (married? #t))))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:40459 msgid "" "After serializing the configuration to disk, the resulting file would look " "like this:" msgstr "" #. type: example #: doc/guix.texi:40464 #, no-wrap msgid "" "[owner]\n" "name = Alice\n" "email = alice@@example.org\n" "\n" msgstr "" #. type: example #: doc/guix.texi:40469 #, no-wrap msgid "" "[Bob]\n" "phone-number = 1234\n" "email = bob@@gnu.org\n" "is-married = false\n" "\n" msgstr "" #. type: example #: doc/guix.texi:40473 #, no-wrap msgid "" "[Charlie]\n" "phone-number = 0\n" "is-married = true\n" msgstr "" #. type: cindex #: doc/guix.texi:40478 #, no-wrap msgid "home configuration" msgstr "" #. type: Plain text #: doc/guix.texi:40490 msgid "" "Guix supports declarative configuration of @dfn{home environments} by " "utilizing the configuration mechanism described in the previous chapter " "(@pxref{Defining Services}), but for user's dotfiles and packages. It works " "both on Guix System and foreign distros and allows users to declare all the " "packages and services that should be installed and configured for the user. " "Once a user has written a file containing @code{home-environment} record, " "such a configuration can be @dfn{instantiated} by an unprivileged user with " "the @command{guix home} command (@pxref{Invoking guix home})." msgstr "" #. type: Plain text #: doc/guix.texi:40507 msgid "" "The user's home environment usually consists of three basic parts: software, " "configuration, and state. Software in mainstream distros are usually " "installed system-wide, but with GNU Guix most software packages can be " "installed on a per-user basis without needing root privileges, and are thus " "considered part of the user’s @dfn{home environment}. Packages on their own " "are not very useful in many cases, because often they require some " "additional configuration, usually config files that reside in " "@env{XDG_CONFIG_HOME} (@file{~/.config} by default) or other directories. " "Everything else can be considered state, like media files, application " "databases, and logs." msgstr "" #. type: Plain text #: doc/guix.texi:40510 msgid "" "Using Guix for managing home environments provides a number of advantages:" msgstr "" #. type: item #: doc/guix.texi:40513 #, no-wrap msgid "All software can be configured in one language (Guile Scheme)," msgstr "" #. type: itemize #: doc/guix.texi:40516 msgid "" "this gives users the ability to share values between configurations of " "different programs." msgstr "" #. type: item #: doc/guix.texi:40517 #, no-wrap msgid "A well-defined home environment is self-contained and can be" msgstr "" #. type: itemize #: doc/guix.texi:40520 msgid "" "created in a declarative and reproducible way---there is no need to grab " "external binaries or manually edit some configuration file." msgstr "" #. type: item #: doc/guix.texi:40521 #, no-wrap msgid "After every @command{guix home reconfigure} invocation, a new home" msgstr "" #. type: itemize #: doc/guix.texi:40525 msgid "" "environment generation will be created. This means that users can rollback " "to a previous home environment generation so they don’t have to worry about " "breaking their configuration." msgstr "" #. type: item #: doc/guix.texi:40526 #, no-wrap msgid "It is possible to manage stateful data with Guix Home, this" msgstr "" #. type: itemize #: doc/guix.texi:40531 msgid "" "includes the ability to automatically clone Git repositories on the initial " "setup of the machine, and periodically running commands like @command{rsync} " "to sync data with another host. This functionality is still in an " "experimental stage, though." msgstr "" #. type: section #: doc/guix.texi:40539 doc/guix.texi:40541 doc/guix.texi:40542 #, no-wrap msgid "Declaring the Home Environment" msgstr "" #. type: menuentry #: doc/guix.texi:40539 msgid "Customizing your Home." msgstr "" #. type: section #: doc/guix.texi:40539 doc/guix.texi:40624 doc/guix.texi:40625 #, no-wrap msgid "Configuring the Shell" msgstr "" #. type: menuentry #: doc/guix.texi:40539 msgid "Enabling home environment." msgstr "" #. type: section #: doc/guix.texi:40539 doc/guix.texi:40671 doc/guix.texi:40672 #, no-wrap msgid "Home Services" msgstr "" #. type: menuentry #: doc/guix.texi:40539 msgid "Specifying home services." msgstr "" #. type: menuentry #: doc/guix.texi:40539 msgid "Instantiating a home configuration." msgstr "" #. type: Plain text #: doc/guix.texi:40548 msgid "" "The home environment is configured by providing a @code{home-environment} " "declaration in a file that can be passed to the @command{guix home} command " "(@pxref{Invoking guix home}). The easiest way to get started is by " "generating an initial configuration with @command{guix home import}:" msgstr "" #. type: example #: doc/guix.texi:40551 #, no-wrap msgid "guix home import ~/src/guix-config\n" msgstr "" #. type: Plain text #: doc/guix.texi:40559 msgid "" "The @command{guix home import} command reads some of the ``dot files'' such " "as @file{~/.bashrc} found in your home directory and copies them to the " "given directory, @file{~/src/guix-config} in this case; it also reads the " "contents of your profile, @file{~/.guix-profile}, and, based on that, it " "populates @file{~/src/guix-config/home-configuration.scm} with a Home " "configuration that resembles your current configuration." msgstr "" #. type: Plain text #: doc/guix.texi:40565 msgid "" "A simple setup can include Bash and a custom text configuration, like in the " "example below. Don't be afraid to declare home environment parts, which " "overlaps with your current dot files: before installing any configuration " "files, Guix Home will back up existing config files to a separate place in " "the home directory." msgstr "" #. type: quotation #: doc/guix.texi:40571 msgid "" "It is highly recommended that you manage your shell or shells with Guix " "Home, because it will make sure that all the necessary scripts are sourced " "by the shell configuration file. Otherwise you will need to do it manually. " "(@pxref{Configuring the Shell})." msgstr "" #. type: findex #: doc/guix.texi:40573 #, no-wrap msgid "home-environment" msgstr "" #. type: include #: doc/guix.texi:40575 #, no-wrap msgid "he-config-bare-bones.scm" msgstr "" #. type: Plain text #: doc/guix.texi:40582 msgid "" "The @code{packages} field should be self-explanatory, it will install the " "list of packages into the user's profile. The most important field is " "@code{services}, it contains a list of @dfn{home services}, which are the " "basic building blocks of a home environment." msgstr "" #. type: Plain text #: doc/guix.texi:40590 msgid "" "There is no daemon (at least not necessarily) related to a home service, a " "home service is just an element that is used to declare part of home " "environment and extend other parts of it. The extension mechanism discussed " "in the previous chapter (@pxref{Defining Services}) should not be confused " "with Shepherd services (@pxref{Shepherd Services}). Using this extension " "mechanism and some Scheme code that glues things together gives the user the " "freedom to declare their own, very custom, home environments." msgstr "" #. type: cindex #: doc/guix.texi:40591 doc/guix.texi:41649 #, no-wrap msgid "container, for @command{guix home}" msgstr "" #. type: Plain text #: doc/guix.texi:40594 msgid "" "Once the configuration looks good, you can first test it in a throw-away " "``container'':" msgstr "" #. type: example #: doc/guix.texi:40597 doc/guix.texi:41659 #, no-wrap msgid "guix home container config.scm\n" msgstr "" #. type: Plain text #: doc/guix.texi:40605 msgid "" "The command above spawns a shell where your home environment is running. " "The shell runs in a container, meaning it's isolated from the rest of the " "system, so it's a good way to try out your configuration---you can see if " "configuration bits are missing or misbehaving, if daemons get started, and " "so on. Once you exit that shell, you're back to the prompt of your original " "shell ``in the real world''." msgstr "" #. type: Plain text #: doc/guix.texi:40608 msgid "" "Once you have a configuration file that suits your needs, you can " "reconfigure your home by running:" msgstr "" #. type: example #: doc/guix.texi:40611 #, no-wrap msgid "guix home reconfigure config.scm\n" msgstr "" #. type: Plain text #: doc/guix.texi:40615 msgid "" "This ``builds'' your home environment and creates @file{~/.guix-home} " "pointing to it. Voilà!" msgstr "" #. type: quotation #: doc/guix.texi:40622 msgid "" "Make sure the operating system has elogind, systemd, or a similar mechanism " "to create the XDG run-time directory and has the @env{XDG_RUNTIME_DIR} " "variable set. Failing that, the @file{on-first-login} script will not " "execute anything, and processes like user Shepherd and its descendants will " "not start." msgstr "" #. type: Plain text #: doc/guix.texi:40628 msgid "" "This section is safe to skip if your shell or shells are managed by Guix " "Home. Otherwise, read it carefully." msgstr "" #. type: Plain text #: doc/guix.texi:40635 msgid "" "There are a few scripts that must be evaluated by a login shell to activate " "the home environment. The shell startup files only read by login shells " "often have @code{profile} suffix. For more information about login shells " "see @ref{Invoking Bash,,, bash, The GNU Bash Reference Manual} and see " "@ref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}." msgstr "" #. type: Plain text #: doc/guix.texi:40642 msgid "" "The first script that needs to be sourced is @file{setup-environment}, which " "sets all the necessary environment variables (including variables declared " "by the user) and the second one is @file{on-first-login}, which starts " "Shepherd for the current user and performs actions declared by other home " "services that extends @code{home-run-on-first-login-service-type}." msgstr "" #. type: Plain text #: doc/guix.texi:40645 msgid "" "Guix Home will always create @file{~/.profile}, which contains the following " "lines:" msgstr "" #. type: example #: doc/guix.texi:40650 #, no-wrap msgid "" "HOME_ENVIRONMENT=$HOME/.guix-home\n" ". $HOME_ENVIRONMENT/setup-environment\n" "$HOME_ENVIRONMENT/on-first-login\n" msgstr "" #. type: Plain text #: doc/guix.texi:40660 msgid "" "This makes POSIX compliant login shells activate the home environment. " "However, in most cases this file won't be read by most modern shells, " "because they are run in non POSIX mode by default and have their own " "@file{*profile} startup files. For example Bash will prefer @file{~/." "bash_profile} in case it exists and only if it doesn't will it fallback to " "@file{~/.profile}. Zsh (if no additional options are specified) will ignore " "@file{~/.profile}, even if @file{~/.zprofile} doesn't exist." msgstr "" #. type: Plain text #: doc/guix.texi:40665 msgid "" "To make your shell respect @file{~/.profile}, add @code{. ~/.profile} or " "@code{source ~/.profile} to the startup file for the login shell. In case " "of Bash, it is @file{~/.bash_profile}, and in case of Zsh, it is @file{~/." "zprofile}." msgstr "" #. type: quotation #: doc/guix.texi:40669 msgid "" "This step is only required if your shell is @emph{not} managed by Guix " "Home. Otherwise, everything will be done automatically." msgstr "" #. type: cindex #: doc/guix.texi:40673 #, no-wrap msgid "home services" msgstr "" #. type: Plain text #: doc/guix.texi:40682 msgid "" "A @dfn{home service} is not necessarily something that has a daemon and is " "managed by Shepherd (@pxref{Jump Start,,, shepherd, The GNU Shepherd " "Manual}), in most cases it doesn't. It's a simple building block of the " "home environment, often declaring a set of packages to be installed in the " "home environment profile, a set of config files to be symlinked into " "@env{XDG_CONFIG_HOME} (@file{~/.config} by default), and environment " "variables to be set by a login shell." msgstr "" #. type: Plain text #: doc/guix.texi:40690 msgid "" "There is a service extension mechanism (@pxref{Service Composition}) which " "allows home services to extend other home services and utilize capabilities " "they provide; for example: declare mcron jobs (@pxref{Top,,, mcron, GNU@tie{}" "Mcron}) by extending @ref{Mcron Home Service}; declare daemons by extending " "@ref{Shepherd Home Service}; add commands, which will be invoked on by the " "Bash by extending @ref{Shells Home Services, @code{home-bash-service-type}}." msgstr "" #. type: Plain text #: doc/guix.texi:40701 msgid "" "A good way to discover available home services is using the @command{guix " "home search} command (@pxref{Invoking guix home}). After the required home " "services are found, include its module with the @code{use-modules} form " "(@pxref{use-modules,, Using Guile Modules, guile, The GNU Guile Reference " "Manual}), or the @code{#:use-modules} directive (@pxref{define-module,, " "Creating Guile Modules, guile, The GNU Guile Reference Manual}) and declare " "a home service using the @code{service} function, or extend a service type " "by declaring a new service with the @code{simple-service} procedure from " "@code{(gnu services)}." msgstr "" #. type: subsection #: doc/guix.texi:40711 doc/guix.texi:40714 doc/guix.texi:40715 #, no-wrap msgid "Essential Home Services" msgstr "" #. type: menuentry #: doc/guix.texi:40711 msgid "Environment variables, packages, on-* scripts." msgstr "" #. type: menuentry #: doc/guix.texi:40711 msgid "Shells: Shells Home Services" msgstr "" #. type: menuentry #: doc/guix.texi:40711 msgid "POSIX shells, Bash, Zsh." msgstr "" #. type: menuentry #: doc/guix.texi:40711 msgid "Mcron: Mcron Home Service" msgstr "" #. type: menuentry #: doc/guix.texi:40711 msgid "Scheduled User's Job Execution." msgstr "" #. type: menuentry #: doc/guix.texi:40711 msgid "Power Management: Power Management Home Services" msgstr "" #. type: menuentry #: doc/guix.texi:40711 msgid "Services for battery power." msgstr "" #. type: menuentry #: doc/guix.texi:40711 msgid "Shepherd: Shepherd Home Service" msgstr "" #. type: menuentry #: doc/guix.texi:40711 msgid "Managing User's Daemons." msgstr "" #. type: menuentry #: doc/guix.texi:40711 msgid "SSH: Secure Shell" msgstr "" #. type: menuentry #: doc/guix.texi:40711 msgid "Setting up the secure shell client." msgstr "" #. type: menuentry #: doc/guix.texi:40711 msgid "Desktop: Desktop Home Services" msgstr "" #. type: menuentry #: doc/guix.texi:40711 msgid "Services for graphical environments." msgstr "" #. type: menuentry #: doc/guix.texi:40711 msgid "Guix: Guix Home Services" msgstr "" #. type: menuentry #: doc/guix.texi:40711 msgid "Services for Guix." msgstr "" #. type: Plain text #: doc/guix.texi:40720 msgid "" "There are a few essential home services defined in @code{(gnu services)}, " "they are mostly for internal use and are required to build a home " "environment, but some of them will be useful for the end user." msgstr "" #. type: cindex #: doc/guix.texi:40721 #, no-wrap msgid "environment variables" msgstr "" #. type: defvr #: doc/guix.texi:40723 #, no-wrap msgid "{Scheme Variable} home-environment-variables-service-type" msgstr "" #. type: defvr #: doc/guix.texi:40728 msgid "" "The service of this type will be instantiated by every home environment " "automatically by default, there is no need to define it, but someone may " "want to extend it with a list of pairs to set some environment variables." msgstr "" #. type: lisp #: doc/guix.texi:40732 #, no-wrap msgid "" "(list (\"ENV_VAR1\" . \"value1\")\n" " (\"ENV_VAR2\" . \"value2\"))\n" msgstr "" #. type: defvr #: doc/guix.texi:40737 msgid "" "The easiest way to extend a service type, without defining a new service " "type is to use the @code{simple-service} helper from @code{(gnu services)}." msgstr "" #. type: lisp #: doc/guix.texi:40745 #, no-wrap msgid "" "(simple-service 'some-useful-env-vars-service\n" "\t\thome-environment-variables-service-type\n" "\t\t`((\"LESSHISTFILE\" . \"$XDG_CACHE_HOME/.lesshst\")\n" " (\"SHELL\" . ,(file-append zsh \"/bin/zsh\"))\n" " (\"USELESS_VAR\" . #f)\n" " (\"_JAVA_AWT_WM_NONREPARENTING\" . #t)))\n" msgstr "" #. type: defvr #: doc/guix.texi:40750 msgid "" "If you include such a service in you home environment definition, it will " "add the following content to the @file{setup-environment} script (which is " "expected to be sourced by the login shell):" msgstr "" #. type: example #: doc/guix.texi:40755 #, no-wrap msgid "" "export LESSHISTFILE=$XDG_CACHE_HOME/.lesshst\n" "export SHELL=/gnu/store/2hsg15n644f0glrcbkb1kqknmmqdar03-zsh-5.8/bin/zsh\n" "export _JAVA_AWT_WM_NONREPARENTING\n" msgstr "" #. type: quotation #: doc/guix.texi:40762 msgid "" "Make sure that module @code{(gnu packages shells)} is imported with " "@code{use-modules} or any other way, this namespace contains the definition " "of the @code{zsh} package, which is used in the example above." msgstr "" #. type: defvr #: doc/guix.texi:40775 msgid "" "The association list (@pxref{Association Lists, alists, Association Lists, " "guile, The GNU Guile Reference manual}) is a data structure containing key-" "value pairs, for @code{home-environment-variables-service-type} the key is " "always a string, the value can be a string, string-valued gexp (@pxref{G-" "Expressions}), file-like object (@pxref{G-Expressions, file-like object}) or " "boolean. For gexps, the variable will be set to the value of the gexp; for " "file-like objects, it will be set to the path of the file in the store " "(@pxref{The Store}); for @code{#t}, it will export the variable without any " "value; and for @code{#f}, it will omit variable." msgstr "" #. type: defvr #: doc/guix.texi:40778 #, no-wrap msgid "{Scheme Variable} home-profile-service-type" msgstr "" #. type: defvr #: doc/guix.texi:40784 msgid "" "The service of this type will be instantiated by every home environment " "automatically, there is no need to define it, but you may want to extend it " "with a list of packages if you want to install additional packages into your " "profile. Other services, which need to make some programs available to the " "user will also extend this service type." msgstr "" #. type: defvr #: doc/guix.texi:40786 msgid "The extension value is just a list of packages:" msgstr "" #. type: lisp #: doc/guix.texi:40789 #, no-wrap msgid "(list htop vim emacs)\n" msgstr "" #. type: defvr #: doc/guix.texi:40799 msgid "" "The same approach as @code{simple-service} (@pxref{Service Reference, simple-" "service}) for @code{home-environment-variables-service-type} can be used " "here, too. Make sure that modules containing the specified packages are " "imported with @code{use-modules}. To find a package or information about " "its module use @command{guix search} (@pxref{Invoking guix package}). " "Alternatively, @code{specification->package} can be used to get the package " "record from string without importing related module." msgstr "" #. type: Plain text #: doc/guix.texi:40803 msgid "" "There are few more essential services, but users are not expected to extend " "them." msgstr "" #. type: defvr #: doc/guix.texi:40804 #, no-wrap msgid "{Scheme Variable} home-service-type" msgstr "" #. type: defvr #: doc/guix.texi:40809 msgid "" "The root of home services DAG, it generates a folder, which later will be " "symlinked to @file{~/.guix-home}, it contains configurations, profile with " "binaries and libraries, and some necessary scripts to glue things together." msgstr "" #. type: defvr #: doc/guix.texi:40811 #, no-wrap msgid "{Scheme Variable} home-run-on-first-login-service-type" msgstr "" #. type: defvr #: doc/guix.texi:40816 msgid "" "The service of this type generates a Guile script, which is expected to be " "executed by the login shell. It is only executed if the special flag file " "inside @env{XDG_RUNTIME_DIR} hasn't been created, this prevents redundant " "executions of the script if multiple login shells are spawned." msgstr "" #. type: defvr #: doc/guix.texi:40822 msgid "" "It can be extended with a gexp. However, to autostart an application, users " "@emph{should not} use this service, in most cases it's better to extend " "@code{home-shepherd-service-type} with a Shepherd service (@pxref{Shepherd " "Services}), or extend the shell's startup file with the required command " "using the appropriate service type." msgstr "" #. type: defvr #: doc/guix.texi:40824 #, no-wrap msgid "{Scheme Variable} home-files-service-type" msgstr "" #. type: defvr #: doc/guix.texi:40831 msgid "" "The service of this type allows to specify a list of files, which will go to " "@file{~/.guix-home/files}, usually this directory contains configuration " "files (to be more precise it contains symlinks to files in @file{/gnu/" "store}), which should be placed in @file{$XDG_CONFIG_DIR} or in rare cases " "in @file{$HOME}. It accepts extension values in the following format:" msgstr "" #. type: lisp #: doc/guix.texi:40835 #, no-wrap msgid "" "`((\".sway/config\" ,sway-file-like-object)\n" " (\".tmux.conf\" ,(local-file \"./tmux.conf\")))\n" msgstr "" #. type: defvr #: doc/guix.texi:40848 msgid "" "Each nested list contains two values: a subdirectory and file-like object. " "After building a home environment @file{~/.guix-home/files} will be " "populated with apropiate content and all nested directories will be created " "accordingly, however, those files won't go any further until some other " "service will do it. By default a @code{home-symlink-manager-service-type}, " "which creates necessary symlinks in home folder to files from @file{~/.guix-" "home/files} and backs up already existing, but clashing configs and other " "things, is a part of essential home services (enabled by default), but it's " "possible to use alternative services to implement more advanced use cases " "like read-only home. Feel free to experiment and share your results." msgstr "" #. type: defvr #: doc/guix.texi:40850 #, no-wrap msgid "{Scheme Variable} home-xdg-configuration-files-service-type" msgstr "" #. type: defvr #: doc/guix.texi:40857 msgid "" "The service is very similiar to @code{home-files-service-type} (and actually " "extends it), but used for defining files, which will go to @file{~/.guix-" "home/files/.config}, which will be symlinked to @file{$XDG_CONFIG_DIR} by " "@code{home-symlink-manager-service-type} (for example) during activation. " "It accepts extension values in the following format:" msgstr "" #. type: lisp #: doc/guix.texi:40863 #, no-wrap msgid "" "`((\"sway/config\" ,sway-file-like-object)\n" " ;; -> ~/.guix-home/files/.config/sway/config\n" " ;; -> $XDG_CONFIG_DIR/sway/config (by symlink-manager)\n" " (\"tmux/tmux.conf\" ,(local-file \"./tmux.conf\")))\n" msgstr "" #. type: defvr #: doc/guix.texi:40866 #, no-wrap msgid "{Scheme Variable} home-activation-service-type" msgstr "" #. type: defvr #: doc/guix.texi:40870 msgid "" "The service of this type generates a guile script, which runs on every " "@command{guix home reconfigure} invocation or any other action, which leads " "to the activation of the home environment." msgstr "" #. type: defvr #: doc/guix.texi:40872 #, no-wrap msgid "{Scheme Variable} home-symlink-manager-service-type" msgstr "" #. type: defvr #: doc/guix.texi:40876 msgid "" "The service of this type generates a guile script, which will be executed " "during activation of home environment, and do a few following steps:" msgstr "" #. type: enumerate #: doc/guix.texi:40881 msgid "" "Reads the content of @file{files/} directory of current and pending home " "environments." msgstr "" #. type: enumerate #: doc/guix.texi:40886 msgid "" "Cleans up all symlinks created by symlink-manager on previous activation. " "Also, sub-directories, which become empty also will be cleaned up." msgstr "" #. type: enumerate #: doc/guix.texi:40899 msgid "" "Creates new symlinks the following way: It looks @file{files/} directory " "(usually defined with @code{home-files-service-type}, @code{home-xdg-" "configuration-files-service-type} and maybe some others), takes the files " "from @file{files/.config/} subdirectory and put respective links in " "@env{XDG_CONFIG_DIR}. For example symlink for @file{files/.config/sway/" "config} will end up in @file{$XDG_CONFIG_DIR/sway/config}. The rest files " "in @file{files/} outside of @file{files/.config/} subdirectory will be " "treated slightly different: symlink will just go to @file{$HOME}. " "@file{files/.some-program/config} will end up in @file{$HOME/.some-program/" "config}." msgstr "" #. type: enumerate #: doc/guix.texi:40902 msgid "If some sub-directories are missing, they will be created." msgstr "" #. type: enumerate #: doc/guix.texi:40905 msgid "If there is a clashing files on the way, they will be backed up." msgstr "" #. type: defvr #: doc/guix.texi:40910 msgid "" "symlink-manager is a part of essential home services and is enabled and used " "by default." msgstr "" #. type: node #: doc/guix.texi:40913 #, no-wrap msgid "Shells Home Services" msgstr "" #. type: subsection #: doc/guix.texi:40914 #, no-wrap msgid "Shells" msgstr "" #. type: cindex #: doc/guix.texi:40916 doc/guix.texi:41611 #, no-wrap msgid "shell" msgstr "" #. type: cindex #: doc/guix.texi:40917 #, no-wrap msgid "login shell" msgstr "" #. type: cindex #: doc/guix.texi:40918 #, no-wrap msgid "interactive shell" msgstr "" #. type: cindex #: doc/guix.texi:40919 doc/guix.texi:41613 #, no-wrap msgid "bash" msgstr "" #. type: cindex #: doc/guix.texi:40920 doc/guix.texi:41614 #, no-wrap msgid "zsh" msgstr "" #. type: Plain text #: doc/guix.texi:40926 msgid "" "Shells play a quite important role in the environment initialization " "process, you can configure them manually as described in section " "@ref{Configuring the Shell}, but the recommended way is to use home services " "listed below. It's both easier and more reliable." msgstr "" #. type: Plain text #: doc/guix.texi:40936 msgid "" "Each home environment instantiates @code{home-shell-profile-service-type}, " "which creates a @file{~/.profile} startup file for all POSIX-compatible " "shells. This file contains all the necessary steps to properly initialize " "the environment, but many modern shells like Bash or Zsh prefer their own " "startup files, that's why the respective home services (@code{home-bash-" "service-type} and @code{home-zsh-service-type}) ensure that @file{~/." "profile} is sourced by @file{~/.bash_profile} and @file{~/.zprofile}, " "respectively." msgstr "" #. type: subsubheading #: doc/guix.texi:40937 #, no-wrap msgid "Shell Profile Service" msgstr "" #. type: deftp #: doc/guix.texi:40939 #, no-wrap msgid "{Data Type} home-shell-profile-configuration" msgstr "" #. type: deftp #: doc/guix.texi:40941 msgid "Available @code{home-shell-profile-configuration} fields are:" msgstr "" #. type: item #: doc/guix.texi:40943 #, no-wrap msgid "@code{profile} (default: @code{()}) (type: text-config)" msgstr "" #. type: table #: doc/guix.texi:40953 msgid "" "@code{home-shell-profile} is instantiated automatically by @code{home-" "environment}, DO NOT create this service manually, it can only be extended. " "@code{profile} is a list of file-like objects, which will go to @file{~/." "profile}. By default @file{~/.profile} contains the initialization code " "which must be evaluated by the login shell to make home-environment's " "profile available to the user, but other commands can be added to the file " "if it is really necessary. In most cases shell's configuration files are " "preferred places for user's customizations. Extend home-shell-profile " "service only if you really know what you do." msgstr "" #. type: subsubheading #: doc/guix.texi:40958 #, no-wrap msgid "Bash Home Service" msgstr "" #. type: anchor{#1} #: doc/guix.texi:40961 msgid "home-bash-configuration" msgstr "" #. type: deftp #: doc/guix.texi:40961 #, no-wrap msgid "{Data Type} home-bash-configuration" msgstr "" #. type: deftp #: doc/guix.texi:40963 msgid "Available @code{home-bash-configuration} fields are:" msgstr "" #. type: item #: doc/guix.texi:40965 #, no-wrap msgid "@code{package} (default: @code{bash}) (type: package)" msgstr "" #. type: table #: doc/guix.texi:40967 msgid "The Bash package to use." msgstr "" #. type: item #: doc/guix.texi:40968 #, no-wrap msgid "@code{guix-defaults?} (default: @code{#t}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:40971 msgid "" "Add sane defaults like reading @file{/etc/bashrc} and coloring the output of " "@command{ls} to the top of the @file{.bashrc} file." msgstr "" #. type: item #: doc/guix.texi:40972 doc/guix.texi:41043 doc/guix.texi:41082 #, no-wrap msgid "@code{environment-variables} (default: @code{()}) (type: alist)" msgstr "" #. type: table #: doc/guix.texi:40977 msgid "" "Association list of environment variables to set for the Bash session. The " "rules for the @code{home-environment-variables-service-type} apply here " "(@pxref{Essential Home Services}). The contents of this field will be added " "after the contents of the @code{bash-profile} field." msgstr "" #. type: item #: doc/guix.texi:40978 doc/guix.texi:41048 #, no-wrap msgid "@code{aliases} (default: @code{()}) (type: alist)" msgstr "" #. type: table #: doc/guix.texi:40983 msgid "" "Association list of aliases to set for the Bash session. The aliases will " "be defined after the contents of the @code{bashrc} field has been put in the " "@file{.bashrc} file. The alias will automatically be quoted, so something " "like this:" msgstr "" #. type: lisp #: doc/guix.texi:40986 #, no-wrap msgid "'((\"ls\" . \"ls -alF\"))\n" msgstr "" #. type: table #: doc/guix.texi:40989 msgid "turns into" msgstr "" #. type: example #: doc/guix.texi:40992 #, no-wrap msgid "alias ls=\"ls -alF\"\n" msgstr "" #. type: item #: doc/guix.texi:40994 doc/guix.texi:41052 #, no-wrap msgid "@code{bash-profile} (default: @code{()}) (type: text-config)" msgstr "" #. type: table #: doc/guix.texi:40999 msgid "" "List of file-like objects, which will be added to @file{.bash_profile}. " "Used for executing user's commands at start of login shell (In most cases " "the shell started on tty just after login). @file{.bash_login} won't be " "ever read, because @file{.bash_profile} always present." msgstr "" #. type: item #: doc/guix.texi:41000 doc/guix.texi:41056 #, no-wrap msgid "@code{bashrc} (default: @code{()}) (type: text-config)" msgstr "" #. type: table #: doc/guix.texi:41005 msgid "" "List of file-like objects, which will be added to @file{.bashrc}. Used for " "executing user's commands at start of interactive shell (The shell for " "interactive usage started by typing @code{bash} or by terminal app or any " "other program)." msgstr "" #. type: item #: doc/guix.texi:41006 doc/guix.texi:41060 #, no-wrap msgid "@code{bash-logout} (default: @code{()}) (type: text-config)" msgstr "" #. type: table #: doc/guix.texi:41011 msgid "" "List of file-like objects, which will be added to @file{.bash_logout}. Used " "for executing user's commands at the exit of login shell. It won't be read " "in some cases (if the shell terminates by exec'ing another process for " "example)." msgstr "" #. type: Plain text #: doc/guix.texi:41021 msgid "" "You can extend the Bash service by using the @code{home-bash-extension} " "configuration record, whose fields must mirror that of @code{home-bash-" "configuration} (@pxref{home-bash-configuration}). The contents of the " "extensions will be added to the end of the corresponding Bash configuration " "files (@pxref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}." msgstr "" #. type: Plain text #: doc/guix.texi:41025 msgid "" "For example, here is how you would define a service that extends the Bash " "service such that @file{~/.bash_profile} defines an additional environment " "variable, @env{PS1}:" msgstr "" #. type: lisp #: doc/guix.texi:41033 #, no-wrap msgid "" "(define bash-fancy-prompt-service\n" " (simple-service 'bash-fancy-prompt\n" " home-bash-service-type\n" " (home-bash-extension\n" " (environment-variables\n" " '((\"PS1\" . \"\\\\u \\\\wλ \"))))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:41038 msgid "" "You would then add @code{bash-fancy-prompt-service} to the list in the " "@code{services} field of your @code{home-environment}. The reference of " "@code{home-bash-extension} follows." msgstr "" #. type: deftp #: doc/guix.texi:41039 #, no-wrap msgid "{Data Type} home-bash-extension" msgstr "" #. type: deftp #: doc/guix.texi:41041 msgid "Available @code{home-bash-extension} fields are:" msgstr "" #. type: table #: doc/guix.texi:41047 msgid "" "Additional environment variables to set. These will be combined with the " "environment variables from other extensions and the base service to form one " "coherent block of environment variables." msgstr "" #. type: table #: doc/guix.texi:41051 msgid "" "Additional aliases to set. These will be combined with the aliases from " "other extensions and the base service." msgstr "" #. type: table #: doc/guix.texi:41055 msgid "" "Additional text blocks to add to @file{.bash_profile}, which will be " "combined with text blocks from other extensions and the base service." msgstr "" #. type: table #: doc/guix.texi:41059 msgid "" "Additional text blocks to add to @file{.bashrc}, which will be combined with " "text blocks from other extensions and the base service." msgstr "" #. type: table #: doc/guix.texi:41063 msgid "" "Additional text blocks to add to @file{.bash_logout}, which will be combined " "with text blocks from other extensions and the base service." msgstr "" #. type: subsubheading #: doc/guix.texi:41067 #, no-wrap msgid "Zsh Home Service" msgstr "" #. type: deftp #: doc/guix.texi:41069 #, no-wrap msgid "{Data Type} home-zsh-configuration" msgstr "" #. type: deftp #: doc/guix.texi:41071 msgid "Available @code{home-zsh-configuration} fields are:" msgstr "" #. type: item #: doc/guix.texi:41073 #, no-wrap msgid "@code{package} (default: @code{zsh}) (type: package)" msgstr "" #. type: table #: doc/guix.texi:41075 msgid "The Zsh package to use." msgstr "" #. type: item #: doc/guix.texi:41076 #, no-wrap msgid "@code{xdg-flavor?} (default: @code{#t}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:41081 msgid "" "Place all the configs to @file{$XDG_CONFIG_HOME/zsh}. Makes @file{~/." "zshenv} to set @env{ZDOTDIR} to @file{$XDG_CONFIG_HOME/zsh}. Shell startup " "process will continue with @file{$XDG_CONFIG_HOME/zsh/.zshenv}." msgstr "" #. type: table #: doc/guix.texi:41084 msgid "Association list of environment variables to set for the Zsh session." msgstr "" #. type: item #: doc/guix.texi:41085 #, no-wrap msgid "@code{zshenv} (default: @code{()}) (type: text-config)" msgstr "" #. type: table #: doc/guix.texi:41090 msgid "" "List of file-like objects, which will be added to @file{.zshenv}. Used for " "setting user's shell environment variables. Must not contain commands " "assuming the presence of tty or producing output. Will be read always. " "Will be read before any other file in @env{ZDOTDIR}." msgstr "" #. type: item #: doc/guix.texi:41091 #, no-wrap msgid "@code{zprofile} (default: @code{()}) (type: text-config)" msgstr "" #. type: table #: doc/guix.texi:41096 msgid "" "List of file-like objects, which will be added to @file{.zprofile}. Used " "for executing user's commands at start of login shell (In most cases the " "shell started on tty just after login). Will be read before @file{.zlogin}." msgstr "" #. type: item #: doc/guix.texi:41097 #, no-wrap msgid "@code{zshrc} (default: @code{()}) (type: text-config)" msgstr "" #. type: table #: doc/guix.texi:41102 msgid "" "List of file-like objects, which will be added to @file{.zshrc}. Used for " "executing user's commands at start of interactive shell (The shell for " "interactive usage started by typing @code{zsh} or by terminal app or any " "other program)." msgstr "" #. type: item #: doc/guix.texi:41103 #, no-wrap msgid "@code{zlogin} (default: @code{()}) (type: text-config)" msgstr "" #. type: table #: doc/guix.texi:41107 msgid "" "List of file-like objects, which will be added to @file{.zlogin}. Used for " "executing user's commands at the end of starting process of login shell." msgstr "" #. type: item #: doc/guix.texi:41108 #, no-wrap msgid "@code{zlogout} (default: @code{()}) (type: text-config)" msgstr "" #. type: table #: doc/guix.texi:41113 msgid "" "List of file-like objects, which will be added to @file{.zlogout}. Used for " "executing user's commands at the exit of login shell. It won't be read in " "some cases (if the shell terminates by exec'ing another process for example)." msgstr "" #. type: node #: doc/guix.texi:41118 #, no-wrap msgid "Mcron Home Service" msgstr "" #. type: subsection #: doc/guix.texi:41119 #, no-wrap msgid "Scheduled User's Job Execution" msgstr "" #. type: Plain text #: doc/guix.texi:41132 msgid "" "The @code{(gnu home services mcron)} module provides an interface to " "GNU@tie{}mcron, a daemon to run jobs at scheduled times (@pxref{Top,,, " "mcron, GNU@tie{}mcron}). The information about system's mcron is applicable " "here (@pxref{Scheduled Job Execution}), the only difference for home " "services is that they have to be declared in a @code{home-environment} " "record instead of an @code{operating-system} record." msgstr "" #. type: defvr #: doc/guix.texi:41133 #, no-wrap msgid "{Scheme Variable} home-mcron-service-type" msgstr "" #. type: defvr #: doc/guix.texi:41137 msgid "" "This is the type of the @code{mcron} home service, whose value is an " "@code{home-mcron-configuration} object. It allows to manage scheduled tasks." msgstr "" #. type: deftp #: doc/guix.texi:41144 #, no-wrap msgid "{Data Type} home-mcron-configuration" msgstr "" #. type: deftp #: doc/guix.texi:41146 msgid "Available @code{home-mcron-configuration} fields are:" msgstr "" #. type: subsection #: doc/guix.texi:41172 doc/guix.texi:41173 #, no-wrap msgid "Power Management Home Services" msgstr "" #. type: cindex #: doc/guix.texi:41175 #, no-wrap msgid "power management" msgstr "" #. type: Plain text #: doc/guix.texi:41178 msgid "" "The @code{(gnu home services pm)} module provides home services pertaining " "to battery power." msgstr "" #. type: defvr #: doc/guix.texi:41179 #, no-wrap msgid "{Scheme Variable} home-batsignal-service-type" msgstr "" #. type: defvr #: doc/guix.texi:41185 msgid "" "Service for @code{batsignal}, a program that monitors battery levels and " "warns the user through desktop notifications when their battery is getting " "low. You can also configure a command to be run when the battery level " "passes a point deemed ``dangerous''. This service is configured with the " "@code{home-batsignal-configuration} record." msgstr "" #. type: deftp #: doc/guix.texi:41187 #, no-wrap msgid "{Data Type} home-batsignal-configuration" msgstr "" #. type: deftp #: doc/guix.texi:41189 msgid "Data type representing the configuration for batsignal." msgstr "" #. type: item #: doc/guix.texi:41191 #, no-wrap msgid "@code{warning-level} (default: @code{15})" msgstr "" #. type: table #: doc/guix.texi:41193 msgid "The battery level to send a warning message at." msgstr "" #. type: item #: doc/guix.texi:41194 #, no-wrap msgid "@code{warning-message} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:41198 msgid "" "The message to send as a notification when the battery level reaches the " "@code{warning-level}. Setting to @code{#f} uses the default message." msgstr "" #. type: item #: doc/guix.texi:41199 #, no-wrap msgid "@code{critical-level} (default: @code{5})" msgstr "" #. type: table #: doc/guix.texi:41201 msgid "The battery level to send a critical message at." msgstr "" #. type: item #: doc/guix.texi:41202 #, no-wrap msgid "@code{critical-message} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:41206 msgid "" "The message to send as a notification when the battery level reaches the " "@code{critical-level}. Setting to @code{#f} uses the default message." msgstr "" #. type: item #: doc/guix.texi:41207 #, no-wrap msgid "@code{danger-level} (default: @code{2})" msgstr "" #. type: table #: doc/guix.texi:41209 msgid "The battery level to run the @code{danger-command} at." msgstr "" #. type: item #: doc/guix.texi:41210 #, no-wrap msgid "@code{danger-command} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:41213 msgid "" "The command to run when the battery level reaches the @code{danger-level}. " "Setting to @code{#f} disables running the command entirely." msgstr "" #. type: item #: doc/guix.texi:41214 #, no-wrap msgid "@code{full-level} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:41217 msgid "" "The battery level to send a full message at. Setting to @code{#f} disables " "sending the full message entirely." msgstr "" #. type: item #: doc/guix.texi:41218 #, no-wrap msgid "@code{full-message} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:41221 msgid "" "The message to send as a notification when the battery level reaches the " "@code{full-level}. Setting to @code{#f} uses the default message." msgstr "" #. type: item #: doc/guix.texi:41222 #, no-wrap msgid "@code{batteries} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:41225 msgid "" "The batteries to monitor. Setting to @code{'()} tries to find batteries " "automatically." msgstr "" #. type: item #: doc/guix.texi:41226 #, no-wrap msgid "@code{poll-delay} (default: @code{60})" msgstr "" #. type: table #: doc/guix.texi:41228 msgid "The time in seconds to wait before checking the batteries again." msgstr "" #. type: item #: doc/guix.texi:41229 #, no-wrap msgid "@code{icon} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:41232 msgid "" "A file-like object to use as the icon for battery notifications. Setting to " "@code{#f} disables notification icons entirely." msgstr "" #. type: item #: doc/guix.texi:41233 #, no-wrap msgid "@code{notifications?} (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:41235 msgid "Whether to send any notifications." msgstr "" #. type: item #: doc/guix.texi:41236 #, no-wrap msgid "@code{notifications-expire?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:41238 msgid "Whether notifications sent expire after a time." msgstr "" #. type: item #: doc/guix.texi:41239 #, no-wrap msgid "@code{notification-command} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:41242 msgid "" "Command to use to send messages. Setting to @code{#f} sends a notification " "through @code{libnotify}." msgstr "" #. type: item #: doc/guix.texi:41243 #, no-wrap msgid "@code{ignore-missing?} (default: @code{#f})" msgstr "" #. type: table #: doc/guix.texi:41245 msgid "Whether to ignore missing battery errors." msgstr "" #. type: node #: doc/guix.texi:41248 #, no-wrap msgid "Shepherd Home Service" msgstr "" #. type: subsection #: doc/guix.texi:41249 #, no-wrap msgid "Managing User Daemons" msgstr "" #. type: cindex #: doc/guix.texi:41251 #, no-wrap msgid "shepherd services, for users" msgstr "" #. type: Plain text #: doc/guix.texi:41258 msgid "" "The @code{(gnu home services shepherd)} module supports the definitions of " "per-user Shepherd services (@pxref{Introduction,,, shepherd, The GNU " "Shepherd Manual}). You extend @code{home-shepherd-service-type} with new " "services; Guix Home then takes care of starting the @code{shepherd} daemon " "for you when you log in, which in turns starts the services you asked for." msgstr "" #. type: defvr #: doc/guix.texi:41259 #, no-wrap msgid "{Scheme Variable} home-shepherd-service-type" msgstr "" #. type: defvr #: doc/guix.texi:41264 msgid "" "The service type for the userland Shepherd, which allows one to manage long-" "running processes or one-shot tasks. User's Shepherd is not an init process " "(PID 1), but almost all other information described in (@pxref{Shepherd " "Services}) is applicable here too." msgstr "" #. type: defvr #: doc/guix.texi:41269 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{}. Its value " "must be a @code{home-shepherd-configuration}, as described below." msgstr "" #. type: deftp #: doc/guix.texi:41271 #, no-wrap msgid "{Data Type} home-shepherd-configuration" msgstr "" #. type: item #: doc/guix.texi:41278 #, no-wrap msgid "auto-start? (default: @code{#t})" msgstr "" #. type: table #: doc/guix.texi:41280 msgid "Whether or not to start Shepherd on first login." msgstr "" #. type: subsection #: doc/guix.texi:41288 doc/guix.texi:41289 #, no-wrap msgid "Secure Shell" msgstr "" #. type: cindex #: doc/guix.texi:41291 #, no-wrap msgid "secure shell client, configuration" msgstr "" #. type: cindex #: doc/guix.texi:41292 #, no-wrap msgid "SSH client, configuration" msgstr "" #. type: Plain text #: doc/guix.texi:41300 msgid "" "The @uref{https://www.openssh.com, OpenSSH package} includes a client, the " "@command{ssh} command, that allows you to connect to remote machines using " "the @acronym{SSH, secure shell} protocol. With the @code{(gnu home services " "ssh)} module, you can set up OpenSSH so that it works in a predictable " "fashion, almost independently of state on the local machine. To do that, " "you instantiate @code{home-openssh-service-type} in your Home configuration, " "as explained below." msgstr "" #. type: defvr #: doc/guix.texi:41301 #, no-wrap msgid "{Scheme Variable} home-openssh-service-type" msgstr "" #. type: defvr #: doc/guix.texi:41304 msgid "" "This is the type of the service to set up the OpenSSH client. It takes care " "of several things:" msgstr "" #. type: itemize #: doc/guix.texi:41310 msgid "" "providing a @file{~/.ssh/config} file based on your configuration so that " "@command{ssh} knows about hosts you regularly connect to and their " "associated parameters;" msgstr "" #. type: itemize #: doc/guix.texi:41315 msgid "" "providing a @file{~/.ssh/authorized_keys}, which lists public keys that the " "local SSH server, @command{sshd}, may accept to connect to this user account;" msgstr "" #. type: itemize #: doc/guix.texi:41319 msgid "" "optionally providing a @file{~/.ssh/known_hosts} file so that @file{ssh} can " "authenticate hosts you connect to." msgstr "" #. type: defvr #: doc/guix.texi:41323 msgid "" "Here is an example of a service and its configuration that you could add to " "the @code{services} field of your @code{home-environment}:" msgstr "" #. type: lisp #: doc/guix.texi:41335 #, no-wrap msgid "" "(service home-openssh-service-type\n" " (home-openssh-configuration\n" " (hosts\n" " (list (openssh-host (name \"ci.guix.gnu.org\")\n" " (user \"charlie\"))\n" " (openssh-host (name \"chbouib\")\n" " (host-name \"chbouib.example.org\")\n" " (user \"supercharlie\")\n" " (port 10022))))\n" " (authorized-keys (list (local-file \"alice.pub\")))))\n" msgstr "" #. type: defvr #: doc/guix.texi:41342 msgid "" "The example above lists two hosts and their parameters. For instance, " "running @command{ssh chbouib} will automatically connect to @code{chbouib." "example.org} on port 10022, logging in as user @samp{supercharlie}. " "Further, it marks the public key in @file{alice.pub} as authorized for " "incoming connections." msgstr "" #. type: defvr #: doc/guix.texi:41345 msgid "" "The value associated with a @code{home-openssh-service-type} instance must " "be a @code{home-openssh-configuration} record, as describe below." msgstr "" #. type: deftp #: doc/guix.texi:41347 #, no-wrap msgid "{Data Type} home-openssh-configuration" msgstr "" #. type: deftp #: doc/guix.texi:41351 msgid "" "This is the datatype representing the OpenSSH client and server " "configuration in one's home environment. It contains the following fields:" msgstr "" #. type: item #: doc/guix.texi:41353 #, no-wrap msgid "@code{hosts} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:41357 msgid "" "A list of @code{openssh-host} records specifying host names and associated " "connection parameters (see below). This host list goes into @file{~/.ssh/" "config}, which @command{ssh} reads at startup." msgstr "" #. type: item #: doc/guix.texi:41358 #, no-wrap msgid "@code{known-hosts} (default: @code{*unspecified*})" msgstr "" #. type: table #: doc/guix.texi:41360 msgid "This must be either:" msgstr "" #. type: itemize #: doc/guix.texi:41366 msgid "" "@code{*unspecified*}, in which case @code{home-openssh-service-type} leaves " "it up to @command{ssh} and to the user to maintain the list of known hosts " "at @file{~/.ssh/known_hosts}, or" msgstr "" #. type: itemize #: doc/guix.texi:41370 msgid "" "a list of file-like objects, in which case those are concatenated and " "emitted as @file{~/.ssh/known_hosts}." msgstr "" #. type: table #: doc/guix.texi:41379 msgid "" "The @file{~/.ssh/known_hosts} contains a list of host name/host key pairs " "that allow @command{ssh} to authenticate hosts you connect to and to detect " "possible impersonation attacks. By default, @command{ssh} updates it in a " "@dfn{TOFU, trust-on-first-use} fashion, meaning that it records the host's " "key in that file the first time you connect to it. This behavior is " "preserved when @code{known-hosts} is set to @code{*unspecified*}." msgstr "" #. type: table #: doc/guix.texi:41385 msgid "" "If you instead provide a list of host keys upfront in the @code{known-hosts} " "field, your configuration becomes self-contained and stateless: it can be " "replicated elsewhere or at another point in time. Preparing this list can " "be relatively tedious though, which is why @code{*unspecified*} is kept as a " "default." msgstr "" #. type: table #: doc/guix.texi:41389 msgid "" "This must be a list of file-like objects, each of which containing an SSH " "public key that should be authorized to connect to this machine." msgstr "" #. type: table #: doc/guix.texi:41395 msgid "" "Concretely, these files are concatenated and made available as @file{~/.ssh/" "authorized_keys}. If an OpenSSH server, @command{sshd}, is running on this " "machine, then it @emph{may} take this file into account: this is what " "@command{sshd} does by default, but be aware that it can also be configured " "to ignore it." msgstr "" #. type: deftp #: doc/guix.texi:41400 #, no-wrap msgid "{Data Type} openssh-host" msgstr "" #. type: deftp #: doc/guix.texi:41402 msgid "Available @code{openssh-host} fields are:" msgstr "" #. type: table #: doc/guix.texi:41406 msgid "Name of this host declaration." msgstr "" #. type: item #: doc/guix.texi:41407 #, no-wrap msgid "@code{host-name} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:41409 msgid "Host name---e.g., @code{\"foo.example.org\"} or @code{\"192.168.1.2\"}." msgstr "" #. type: item #: doc/guix.texi:41410 #, no-wrap msgid "@code{address-family} (type: address-family)" msgstr "" #. type: table #: doc/guix.texi:41414 msgid "" "Address family to use when connecting to this host: one of @code{AF_INET} " "(for IPv4 only), @code{AF_INET6} (for IPv6 only), or @code{*unspecified*} " "(allowing any address family)." msgstr "" #. type: item #: doc/guix.texi:41415 #, no-wrap msgid "@code{identity-file} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:41417 msgid "" "The identity file to use---e.g., @code{\"/home/charlie/.ssh/id_ed25519\"}." msgstr "" #. type: item #: doc/guix.texi:41418 #, no-wrap msgid "@code{port} (type: maybe-natural-number)" msgstr "" #. type: table #: doc/guix.texi:41420 msgid "TCP port number to connect to." msgstr "" #. type: item #: doc/guix.texi:41421 #, no-wrap msgid "@code{user} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:41423 msgid "User name on the remote host." msgstr "" #. type: item #: doc/guix.texi:41424 #, no-wrap msgid "@code{forward-x11?} (default: @code{#f}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:41427 msgid "" "Whether to forward remote client connections to the local X11 graphical " "display." msgstr "" #. type: item #: doc/guix.texi:41428 #, no-wrap msgid "@code{forward-x11-trusted?} (default: @code{#f}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:41431 msgid "" "Whether remote X11 clients have full access to the original X11 graphical " "display." msgstr "" #. type: item #: doc/guix.texi:41432 #, no-wrap msgid "@code{forward-agent?} (default: @code{#f}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:41435 msgid "" "Whether the authentication agent (if any) is forwarded to the remote machine." msgstr "" #. type: item #: doc/guix.texi:41436 #, no-wrap msgid "@code{compression?} (default: @code{#f}) (type: boolean)" msgstr "" #. type: table #: doc/guix.texi:41438 msgid "Whether to compress data in transit." msgstr "" #. type: item #: doc/guix.texi:41439 #, no-wrap msgid "@code{proxy-command} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:41443 msgid "" "The command to use to connect to the server. As an example, a command to " "connect via an HTTP proxy at 192.0.2.0 would be: @code{\"nc -X connect -x " "192.0.2.0:8080 %h %p\"}." msgstr "" #. type: item #: doc/guix.texi:41444 #, no-wrap msgid "@code{host-key-algorithms} (type: maybe-string-list)" msgstr "" #. type: table #: doc/guix.texi:41447 msgid "" "The list of accepted host key algorithms---e.g., @code{'(\"ssh-ed25519\")}." msgstr "" #. type: item #: doc/guix.texi:41448 #, no-wrap msgid "@code{accepted-key-types} (type: maybe-string-list)" msgstr "" #. type: table #: doc/guix.texi:41450 msgid "The list of accepted user public key types." msgstr "" #. type: item #: doc/guix.texi:41451 doc/guix.texi:41532 #, no-wrap msgid "@code{extra-content} (default: @code{\"\"}) (type: raw-configuration-string)" msgstr "" #. type: table #: doc/guix.texi:41454 msgid "" "Extra content appended as-is to this @code{Host} block in @file{~/.ssh/" "config}." msgstr "" #. type: subsection #: doc/guix.texi:41463 doc/guix.texi:41464 #, no-wrap msgid "Desktop Home Services" msgstr "" #. type: Plain text #: doc/guix.texi:41469 msgid "" "The @code{(gnu home services desktop)} module provides services that you may " "find useful on ``desktop'' systems running a graphical user environment such " "as Xorg." msgstr "" #. type: defvr #: doc/guix.texi:41470 #, no-wrap msgid "{Scheme Variable} home-redshift-service-type" msgstr "" #. type: defvr #: doc/guix.texi:41475 msgid "" "This is the service type for @uref{https://github.com/jonls/redshift, " "Redshift}, a program that adjusts the display color temperature according to " "the time of day. Its associated value must be a @code{home-redshift-" "configuration} record, as shown below." msgstr "" #. type: defvr #: doc/guix.texi:41478 msgid "" "A typical configuration, where we manually specify the latitude and " "longitude, might look like this:" msgstr "" #. type: lisp #: doc/guix.texi:41485 #, no-wrap msgid "" "(service home-redshift-service-type\n" " (home-redshift-configuration\n" " (location-provider 'manual)\n" " (latitude 35.81) ;northern hemisphere\n" " (longitude -0.80))) ;west of Greenwich\n" msgstr "" #. type: deftp #: doc/guix.texi:41488 #, no-wrap msgid "{Data Type} home-redshift-configuration" msgstr "" #. type: deftp #: doc/guix.texi:41490 msgid "Available @code{home-redshift-configuration} fields are:" msgstr "" #. type: item #: doc/guix.texi:41492 #, no-wrap msgid "@code{redshift} (default: @code{redshift}) (type: file-like)" msgstr "" #. type: table #: doc/guix.texi:41494 msgid "Redshift package to use." msgstr "" #. type: item #: doc/guix.texi:41495 #, no-wrap msgid "@code{location-provider} (default: @code{geoclue2}) (type: symbol)" msgstr "" #. type: table #: doc/guix.texi:41501 msgid "" "Geolocation provider---@code{'manual} or @code{'geoclue2}. In the former " "case, you must also specify the @code{latitude} and @code{longitude} fields " "so Redshift can determine daytime at your place. In the latter case, the " "Geoclue system service must be running; it will be queried for location " "information." msgstr "" #. type: item #: doc/guix.texi:41502 #, no-wrap msgid "@code{adjustment-method} (default: @code{randr}) (type: symbol)" msgstr "" #. type: table #: doc/guix.texi:41504 msgid "Color adjustment method." msgstr "" #. type: item #: doc/guix.texi:41505 #, no-wrap msgid "@code{daytime-temperature} (default: @code{6500}) (type: integer)" msgstr "" #. type: table #: doc/guix.texi:41507 msgid "Daytime color temperature (kelvins)." msgstr "" #. type: item #: doc/guix.texi:41508 #, no-wrap msgid "@code{nighttime-temperature} (default: @code{4500}) (type: integer)" msgstr "" #. type: table #: doc/guix.texi:41510 msgid "Nighttime color temperature (kelvins)." msgstr "" #. type: item #: doc/guix.texi:41511 #, no-wrap msgid "@code{daytime-brightness} (type: maybe-inexact-number)" msgstr "" #. type: table #: doc/guix.texi:41513 msgid "Daytime screen brightness, between 0.1 and 1.0, or left unspecified." msgstr "" #. type: item #: doc/guix.texi:41514 #, no-wrap msgid "@code{nighttime-brightness} (type: maybe-inexact-number)" msgstr "" #. type: table #: doc/guix.texi:41516 msgid "Nighttime screen brightness, between 0.1 and 1.0, or left unspecified." msgstr "" #. type: item #: doc/guix.texi:41517 #, no-wrap msgid "@code{latitude} (type: maybe-inexact-number)" msgstr "" #. type: table #: doc/guix.texi:41519 msgid "Latitude, when @code{location-provider} is @code{'manual}." msgstr "" #. type: item #: doc/guix.texi:41520 #, no-wrap msgid "@code{longitude} (type: maybe-inexact-number)" msgstr "" #. type: table #: doc/guix.texi:41522 msgid "Longitude, when @code{location-provider} is @code{'manual}." msgstr "" #. type: item #: doc/guix.texi:41523 #, no-wrap msgid "@code{dawn-time} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:41527 msgid "" "Custom time for the transition from night to day in the morning---@code{\"HH:" "MM\"} format. When specified, solar elevation is not used to determine the " "daytime/nighttime period." msgstr "" #. type: item #: doc/guix.texi:41528 #, no-wrap msgid "@code{dusk-time} (type: maybe-string)" msgstr "" #. type: table #: doc/guix.texi:41531 msgid "" "Likewise, custom time for the transition from day to night in the evening." msgstr "" #. type: table #: doc/guix.texi:41536 msgid "" "Extra content appended as-is to the Redshift configuration file. Run " "@command{man redshift} for more information about the configuration file " "format." msgstr "" #. type: defvr #: doc/guix.texi:41541 #, no-wrap msgid "{Scheme Variable} home-dbus-service-type" msgstr "" #. type: defvr #: doc/guix.texi:41544 msgid "" "This is the service type for running a session-specific D-Bus, for " "unprivileged applications that require D-Bus to be running." msgstr "" #. type: deftp #: doc/guix.texi:41546 #, no-wrap msgid "{Data Type} home-dbus-configuration" msgstr "" #. type: deftp #: doc/guix.texi:41548 msgid "The configuration record for @code{home-dbus-service-type}." msgstr "" #. type: item #: doc/guix.texi:41550 #, no-wrap msgid "@code{dbus} (default: @code{dbus})" msgstr "" #. type: table #: doc/guix.texi:41552 msgid "The package providing the @code{/bin/dbus-daemon} command." msgstr "" #. type: subsection #: doc/guix.texi:41555 doc/guix.texi:41556 #, no-wrap msgid "Guix Home Services" msgstr "" #. type: Plain text #: doc/guix.texi:41560 msgid "" "The @code{(gnu home services guix)} module provides services for user-" "specific Guix configuration." msgstr "" #. type: defvr #: doc/guix.texi:41561 #, no-wrap msgid "{Scheme Variable} home-channels-service-type" msgstr "" #. type: defvr #: doc/guix.texi:41567 msgid "" "This is the service type for managing @file{$XDG_CONFIG_HOME/guix/channels." "scm}, the file that controls the channels received on @command{guix pull} " "(@pxref{Channels}). Its associated value is a list of @code{channel} " "records, defined in the @code{(guix channels)} module." msgstr "" #. type: defvr #: doc/guix.texi:41574 msgid "" "Generally, it is better to extend this service than to directly configure " "it, as its default value is the default guix channel(s) defined by " "@code{%default-channels}. If you configure this service directly, be sure " "to include a guix channel. @xref{Specifying Additional Channels} and " "@ref{Using a Custom Guix Channel} for more details." msgstr "" #. type: defvr #: doc/guix.texi:41576 msgid "A typical extension for adding a channel might look like this:" msgstr "" #. type: lisp #: doc/guix.texi:41584 #, no-wrap msgid "" "(simple-service 'variant-packages-service\n" " home-channels-service-type\n" " (list\n" " (channel\n" " (name 'variant-packages)\n" " (url \"https://example.org/variant-packages.git\"))))\n" msgstr "" #. type: section #: doc/guix.texi:41588 #, no-wrap msgid "Invoking @command{guix home}" msgstr "" #. type: command{#1} #: doc/guix.texi:41590 #, no-wrap msgid "guix home" msgstr "" #. type: Plain text #: doc/guix.texi:41595 msgid "" "Once you have written a home environment declaration (@pxref{Declaring the " "Home Environment,,,,}, it can be @dfn{instantiated} using the @command{guix " "home} command. The synopsis is:" msgstr "" #. type: example #: doc/guix.texi:41598 #, no-wrap msgid "guix home @var{options}@dots{} @var{action} @var{file}\n" msgstr "" #. type: Plain text #: doc/guix.texi:41605 msgid "" "@var{file} must be the name of a file containing a @code{home-environment} " "declaration. @var{action} specifies how the home environment is " "instantiated, but there are few auxiliary actions which don't instantiate " "it. Currently the following values are supported:" msgstr "" #. type: table #: doc/guix.texi:41610 msgid "" "Display available home service type definitions that match the given regular " "expressions, sorted by relevance:" msgstr "" #. type: cindex #: doc/guix.texi:41612 #, no-wrap msgid "shell-profile" msgstr "" #. type: example #: doc/guix.texi:41623 #, no-wrap msgid "" "$ guix home search shell\n" "name: home-shell-profile\n" "location: gnu/home/services/shells.scm:100:2\n" "extends: home-files\n" "description: Create `~/.profile', which is used for environment initialization of POSIX compliant login shells.\n" "+ This service type can be extended with a list of file-like objects.\n" "relevance: 6\n" "\n" msgstr "" #. type: example #: doc/guix.texi:41629 #, no-wrap msgid "" "name: home-fish\n" "location: gnu/home/services/shells.scm:640:2\n" "extends: home-files home-profile\n" "description: Install and configure Fish, the friendly interactive shell.\n" "relevance: 3\n" "\n" msgstr "" #. type: example #: doc/guix.texi:41635 #, no-wrap msgid "" "name: home-zsh\n" "location: gnu/home/services/shells.scm:290:2\n" "extends: home-files home-profile\n" "description: Install and configure Zsh.\n" "relevance: 1\n" "\n" msgstr "" #. type: example #: doc/guix.texi:41641 #, no-wrap msgid "" "name: home-bash\n" "location: gnu/home/services/shells.scm:508:2\n" "extends: home-files home-profile\n" "description: Install and configure GNU Bash.\n" "relevance: 1\n" "\n" msgstr "" #. type: table #: doc/guix.texi:41648 msgid "" "As for @command{guix 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: table #: doc/guix.texi:41653 msgid "" "Spawn a shell in an isolated environment---a @dfn{container}---containing " "your home as specified by @var{file}." msgstr "" #. type: table #: doc/guix.texi:41656 msgid "" "For example, this is how you would start an interactive shell in a container " "with your home:" msgstr "" #. type: table #: doc/guix.texi:41664 msgid "" "This is a throw-away container where you can lightheartedly fiddle with " "files; any changes made within the container, any process started---all this " "disappears as soon as you exit that shell." msgstr "" #. type: table #: doc/guix.texi:41666 msgid "As with @command{guix shell}, several options control that container:" msgstr "" #. type: table #: doc/guix.texi:41671 msgid "Enable networking within the container (it is disabled by default)." msgstr "" #. type: table #: doc/guix.texi:41678 msgid "" "As with @command{guix shell}, make directory @var{source} of the host system " "available as @var{target} inside the container---read-only if you pass " "@option{--expose}, and writable if you pass @option{--share} " "(@pxref{Invoking guix shell, @option{--expose} and @option{--share}})." msgstr "" #. type: table #: doc/guix.texi:41684 msgid "" "Additionally, you can run a command in that container, instead of spawning " "an interactive shell. For instance, here is how you would check which " "Shepherd services are started in a throw-away home container:" msgstr "" #. type: example #: doc/guix.texi:41687 #, no-wrap msgid "guix home container config.scm -- herd status\n" msgstr "" #. type: table #: doc/guix.texi:41691 msgid "" "The command to run in the container must come after @code{--} (double " "hyphen)." msgstr "" #. type: table #: doc/guix.texi:41696 msgid "Edit or view the definition of the given Home service types." msgstr "" #. type: table #: doc/guix.texi:41700 msgid "" "For example, the command below opens your editor, as specified by the " "@env{EDITOR} environment variable, on the definition of the @code{home-" "mcron} service type:" msgstr "" #. type: example #: doc/guix.texi:41703 #, no-wrap msgid "guix home edit home-mcron\n" msgstr "" #. type: table #: doc/guix.texi:41713 msgid "" "Build the home environment described in @var{file}, and switch to it. " "Switching means that the activation script will be evaluated and (in basic " "scenario) symlinks to configuration files generated from @code{home-" "environment} declaration will be created in @file{~}. If the file with the " "same path already exists in home folder it will be moved to @file{~/" "@var{timestamp}-guix-home-legacy-configs-backup}, where @var{timestamp} is a " "current UNIX epoch time." msgstr "" #. type: quotation #: doc/guix.texi:41718 msgid "" "It is highly recommended to run @command{guix pull} once before you run " "@command{guix home reconfigure} for the first time (@pxref{Invoking guix " "pull})." msgstr "" #. type: table #: doc/guix.texi:41725 msgid "" "This effects all the configuration specified in @var{file}. The command " "starts Shepherd services specified in @var{file} that are not currently " "running; if a service is currently running, this command will arrange for it " "to be upgraded the next time it is stopped (e.g.@: by @code{herd stop " "@var{service}} or @code{herd restart @var{service}})." msgstr "" #. type: table #: doc/guix.texi:41731 msgid "" "This command creates a new generation whose number is one greater than the " "current generation (as reported by @command{guix home 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: cindex #: doc/guix.texi:41732 #, no-wrap msgid "provenance tracking, of the home environment" msgstr "" #. type: table #: doc/guix.texi:41737 msgid "" "Upon completion, the new home is deployed under @file{~/.guix-home}. This " "directory contains @dfn{provenance meta-data}: the list of channels in use " "(@pxref{Channels}) and @var{file} itself, when available. You can view the " "provenance information by running:" msgstr "" #. type: example #: doc/guix.texi:41740 #, no-wrap msgid "guix home describe\n" msgstr "" #. type: table #: doc/guix.texi:41746 msgid "" "This information is useful should you later want to inspect how this " "particular generation was built. In fact, assuming @var{file} is self-" "contained, you can later rebuild generation @var{n} of your home environment " "with:" msgstr "" #. type: example #: doc/guix.texi:41752 #, no-wrap msgid "" "guix time-machine \\\n" " -C /var/guix/profiles/per-user/@var{USER}/guix-home-@var{n}-link/channels.scm -- \\\n" " home reconfigure \\\n" " /var/guix/profiles/per-user/@var{USER}/guix-home-@var{n}-link/configuration.scm\n" "\n" msgstr "" #. type: table #: doc/guix.texi:41759 msgid "" "You can think of it as some sort of built-in version control! Your home is " "not just a binary artifact: @emph{it carries its own source}." msgstr "" #. type: cindex #: doc/guix.texi:41765 #, no-wrap msgid "home generations" msgstr "" #. type: table #: doc/guix.texi:41768 msgid "" "Switch to an existing home generation. This action atomically switches the " "home profile to the specified home generation." msgstr "" #. type: table #: doc/guix.texi:41772 msgid "" "The target generation can be specified explicitly by its generation number. " "For example, the following invocation would switch to home generation 7:" msgstr "" #. type: example #: doc/guix.texi:41775 #, no-wrap msgid "guix home switch-generation 7\n" msgstr "" #. type: example #: doc/guix.texi:41786 #, no-wrap msgid "guix home switch-generation -- -1\n" msgstr "" #. type: table #: doc/guix.texi:41795 msgid "" "Switch to the preceding home 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: cindex #: doc/guix.texi:41797 #, no-wrap msgid "deleting home generations" msgstr "" #. type: table #: doc/guix.texi:41802 msgid "" "Delete home generations, making them candidates for garbage collection " "(@pxref{Invoking guix gc}, for information on how to run the ``garbage " "collector'')." msgstr "" #. type: table #: doc/guix.texi:41806 msgid "" "This works in the same way as @samp{guix package --delete-generations} " "(@pxref{Invoking guix package, @option{--delete-generations}}). With no " "arguments, all home generations but the current one are deleted:" msgstr "" #. type: example #: doc/guix.texi:41809 #, no-wrap msgid "guix home delete-generations\n" msgstr "" #. type: table #: doc/guix.texi:41813 msgid "" "You can also select the generations you want to delete. The example below " "deletes all the home generations that are more than two months old:" msgstr "" #. type: example #: doc/guix.texi:41816 #, no-wrap msgid "guix home delete-generations 2m\n" msgstr "" #. type: table #: doc/guix.texi:41822 msgid "" "Build the derivation of the home environment, which includes all the " "configuration files and programs needed. This action does not actually " "install anything." msgstr "" #. type: table #: doc/guix.texi:41826 msgid "" "Describe the current home generation: its file name, as well as provenance " "information when available." msgstr "" #. type: table #: doc/guix.texi:41833 msgid "" "To show installed packages in the current home generation's profile, the " "@code{--list-installed} flag is provided, with the same syntax that is used " "in @command{guix package --list-installed} (@pxref{Invoking guix package}). " "For instance, the following command shows a table of all the packages with " "``emacs'' in their name that are installed in the current home generation's " "profile:" msgstr "" #. type: example #: doc/guix.texi:41836 #, no-wrap msgid "guix home describe --list-installed=emacs\n" msgstr "" #. type: table #: doc/guix.texi:41843 msgid "" "List a summary of each generation of the home environment 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: example #: doc/guix.texi:41851 #, no-wrap msgid "guix home list-generations 10d\n" msgstr "" #. type: table #: doc/guix.texi:41857 msgid "" "The @code{--list-installed} flag may also be specified, with the same syntax " "that is used in @command{guix home describe}. This may be helpful if trying " "to determine when a package was added to the home profile." msgstr "" #. type: item #: doc/guix.texi:41858 #, no-wrap msgid "import" msgstr "" #. type: table #: doc/guix.texi:41865 msgid "" "Generate a @dfn{home environment} from the packages in the default profile " "and configuration files found in the user's home directory. The " "configuration files will be copied to the specified directory, and a " "@file{home-configuration.scm} will be populated with the home environment. " "Note that not every home service that exists is supported (@pxref{Home " "Services})." msgstr "" #. type: example #: doc/guix.texi:41869 #, no-wrap msgid "" "$ guix home import ~/guix-config\n" "guix home: '/home/alice/guix-config' populated with all the Home configuration files\n" msgstr "" #. type: Plain text #: doc/guix.texi:41875 msgid "" "And there's more! @command{guix home} also provides the following sub-" "commands to visualize how the services of your home environment relate to " "one another:" msgstr "" #. type: cindex #: doc/guix.texi:41877 #, no-wrap msgid "service extension graph, of a home environment" msgstr "" #. type: table #: doc/guix.texi:41885 msgid "" "Emit to standard output the @dfn{service extension graph} of the home " "environment defined in @var{file} (@pxref{Service Composition}, for more " "information on service extensions). By default the output is in Dot/" "Graphviz format, but you can choose a different format with @option{--graph-" "backend}, as with @command{guix graph} (@pxref{Invoking guix graph, " "@option{--backend}}):" msgstr "" #. type: example #: doc/guix.texi:41890 #, no-wrap msgid "guix home extension-graph @var{file} | xdot -\n" msgstr "" #. type: cindex #: doc/guix.texi:41894 #, no-wrap msgid "Shepherd dependency graph, for a home environment" msgstr "" #. type: table #: doc/guix.texi:41899 msgid "" "Emit to standard output the @dfn{dependency graph} of shepherd services of " "the home environment defined in @var{file}. @xref{Shepherd Services}, for " "more information and for an example graph." msgstr "" #. type: table #: doc/guix.texi:41915 msgid "" "Consider the home-environment @var{expr} evaluates to. This is an " "alternative to specifying a file which evaluates to a home environment." msgstr "" #. type: table #: doc/guix.texi:41918 msgid "Instruct @command{guix home reconfigure} to allow system downgrades." msgstr "" #. type: table #: doc/guix.texi:41925 msgid "" "Just like @command{guix system}, @command{guix home reconfigure}, by " "default, prevents you from downgrading your home to older or unrelated " "revisions compared to the channel revisions that were used to deploy it---" "those shown by @command{guix home describe}. Using @option{--allow-" "downgrades} allows you to bypass that check, at the risk of downgrading your " "home---be careful!" msgstr "" #. type: cindex #: doc/guix.texi:41931 #, no-wrap msgid "documentation, searching for" msgstr "" #. type: cindex #: doc/guix.texi:41932 #, no-wrap msgid "searching for documentation" msgstr "" #. type: cindex #: doc/guix.texi:41933 #, no-wrap msgid "Info, documentation format" msgstr "" #. type: cindex #: doc/guix.texi:41934 #, no-wrap msgid "man pages" msgstr "" #. type: cindex #: doc/guix.texi:41935 #, no-wrap msgid "manual pages" msgstr "" #. type: Plain text #: doc/guix.texi:41942 msgid "" "In most cases packages installed with Guix come with documentation. There " "are two main documentation formats: ``Info'', a browsable hypertext format " "used for GNU software, and ``manual pages'' (or ``man pages''), the linear " "documentation format traditionally found on Unix. Info manuals are accessed " "with the @command{info} command or with Emacs, and man pages are accessed " "using @command{man}." msgstr "" #. type: Plain text #: doc/guix.texi:41946 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:41954 #, 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:41960 msgid "" "The command below searches for the same keyword in man pages@footnote{The " "database searched by @command{man -k} is only created in profiles that " "contain the @code{man-db} package.}:" msgstr "" #. type: example #: doc/guix.texi:41966 #, 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:41972 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:41975 msgid "" "Once you have these results, you can view the relevant documentation by " "running, say:" msgstr "" #. type: example #: doc/guix.texi:41978 #, no-wrap msgid "$ info \"(gnutls)Core TLS API\"\n" msgstr "" #. type: Plain text #: doc/guix.texi:41982 msgid "or:" msgstr "" #. type: example #: doc/guix.texi:41985 #, no-wrap msgid "$ man certtool\n" msgstr "" #. type: Plain text #: doc/guix.texi:41993 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: Plain text #: doc/guix.texi:42002 msgid "" "The packages and systems built by Guix are intended, like most computer " "programs, to run on a CPU with a specific instruction set, and under a " "specific operating system. Those programs are often also targeting a " "specific kernel and system library. Those constraints are captured by Guix " "in @code{platform} records." msgstr "" #. type: section #: doc/guix.texi:42009 #, no-wrap msgid "@code{platform} Reference" msgstr "" #. type: Plain text #: doc/guix.texi:42015 msgid "" "The @code{platform} data type describes a @dfn{platform}: an @acronym{ISA, " "instruction set architecture}, combined with an operating system and " "possibly additional system-wide settings such as the @acronym{ABI, " "application binary interface}." msgstr "" #. type: deftp #: doc/guix.texi:42016 #, no-wrap msgid "{Data Type} platform" msgstr "" #. type: deftp #: doc/guix.texi:42018 msgid "This is the data type representing a platform." msgstr "" #. type: table #: doc/guix.texi:42024 msgid "" "This field specifies the platform's GNU triplet as a string " "(@pxref{Specifying Target Triplets, GNU configuration triplets,, autoconf, " "Autoconf})." msgstr "" #. type: table #: doc/guix.texi:42028 msgid "" "This string is the system type as it is known to Guix and passed, for " "instance, to the @option{--system} option of most commands." msgstr "" #. type: table #: doc/guix.texi:42032 msgid "" "It usually has the form @code{\"@var{cpu}-@var{kernel}\"}, where @var{cpu} " "is the target CPU and @var{kernel} the target operating system kernel." msgstr "" #. type: table #: doc/guix.texi:42036 msgid "" "It can be for instance @code{\"aarch64-linux\"} or @code{\"armhf-linux\"}. " "You will encounter system types when you perform native builds " "(@pxref{Native Builds})." msgstr "" #. type: item #: doc/guix.texi:42037 #, no-wrap msgid "@code{linux-architecture} (default: @code{#false})" msgstr "" #. type: table #: doc/guix.texi:42041 msgid "" "This optional string field is only relevant if the kernel is Linux. In that " "case, it corresponds to the ARCH variable used when building Linux, " "@code{\"mips\"} for instance." msgstr "" #. type: code{#1} #: doc/guix.texi:42042 #, no-wrap msgid "glibc-dynamic-linker" msgstr "" #. type: table #: doc/guix.texi:42046 msgid "" "This field is the name of the GNU C Library dynamic linker for the " "corresponding system, as a string. It can be @code{\"/lib/ld-linux-armhf." "so.3\"}." msgstr "" #. type: Plain text #: doc/guix.texi:42055 msgid "" "The @code{(guix platforms @dots{})} modules export the following variables, " "each of which is bound to a @code{platform} record." msgstr "" #. type: defvr #: doc/guix.texi:42056 #, no-wrap msgid "{Scheme Variable} armv7-linux" msgstr "" #. type: defvr #: doc/guix.texi:42058 msgid "Platform targeting ARM v7 CPU running GNU/Linux." msgstr "" #. type: defvr #: doc/guix.texi:42060 #, no-wrap msgid "{Scheme Variable} aarch64-linux" msgstr "" #. type: defvr #: doc/guix.texi:42062 msgid "Platform targeting ARM v8 CPU running GNU/Linux." msgstr "" #. type: defvr #: doc/guix.texi:42064 #, no-wrap msgid "{Scheme Variable} mips64-linux" msgstr "" #. type: defvr #: doc/guix.texi:42066 msgid "Platform targeting MIPS little-endian 64-bit CPU running GNU/Linux." msgstr "" #. type: defvr #: doc/guix.texi:42068 #, no-wrap msgid "{Scheme Variable} powerpc-linux" msgstr "" #. type: defvr #: doc/guix.texi:42070 msgid "Platform targeting PowerPC big-endian 32-bit CPU running GNU/Linux." msgstr "" #. type: defvr #: doc/guix.texi:42072 #, no-wrap msgid "{Scheme Variable} powerpc64le-linux" msgstr "" #. type: defvr #: doc/guix.texi:42074 msgid "Platform targeting PowerPC little-endian 64-bit CPU running GNU/Linux." msgstr "" #. type: defvr #: doc/guix.texi:42076 #, no-wrap msgid "{Scheme Variable} riscv64-linux" msgstr "" #. type: defvr #: doc/guix.texi:42078 msgid "Platform targeting RISC-V 64-bit CPU running GNU/Linux." msgstr "" #. type: defvr #: doc/guix.texi:42080 #, no-wrap msgid "{Scheme Variable} i686-linux" msgstr "" #. type: defvr #: doc/guix.texi:42082 msgid "Platform targeting x86 CPU running GNU/Linux." msgstr "" #. type: defvr #: doc/guix.texi:42084 #, no-wrap msgid "{Scheme Variable} x86_64-linux" msgstr "" #. type: defvr #: doc/guix.texi:42086 msgid "Platform targeting x86 64-bit CPU running GNU/Linux." msgstr "" #. type: defvr #: doc/guix.texi:42088 #, no-wrap msgid "{Scheme Variable} i686-mingw" msgstr "" #. type: defvr #: doc/guix.texi:42091 msgid "" "Platform targeting x86 CPU running Windows, with run-time support from MinGW." msgstr "" #. type: defvr #: doc/guix.texi:42093 #, no-wrap msgid "{Scheme Variable} x86_64-mingw" msgstr "" #. type: defvr #: doc/guix.texi:42096 msgid "" "Platform targeting x86 64-bit CPU running Windows, with run-time support " "from MinGW." msgstr "" #. type: defvr #: doc/guix.texi:42098 #, no-wrap msgid "{Scheme Variable} i586-gnu" msgstr "" #. type: defvr #: doc/guix.texi:42101 msgid "" "Platform targeting x86 CPU running GNU/Hurd (also referred to as ``GNU'')." msgstr "" #. type: chapter #: doc/guix.texi:42104 #, no-wrap msgid "Creating System Images" msgstr "" #. type: cindex #: doc/guix.texi:42106 #, no-wrap msgid "system images" msgstr "" #. type: Plain text #: doc/guix.texi:42118 msgid "" "When it comes to installing Guix System for the first time on a new machine, " "you can basically proceed in three different ways. The first one is to use " "an existing operating system on the machine to run the @command{guix system " "init} command (@pxref{Invoking guix system}). The second one, is to produce " "an installation image (@pxref{Building the Installation Image}). This is a " "bootable system which role is to eventually run @command{guix system init}. " "Finally, the third option would be to produce an image that is a direct " "instantiation of the system you wish to run. That image can then be copied " "on a bootable device such as an USB drive or a memory card. The target " "machine would then directly boot from it, without any kind of installation " "procedure." msgstr "" #. type: Plain text #: doc/guix.texi:42127 msgid "" "The @command{guix system image} command is able to turn an operating system " "definition into a bootable image. This command supports different image " "types, such as @code{efi-raw}, @code{iso9660} and @code{docker}. Any modern " "@code{x86_64} machine will probably be able to boot from an @code{iso9660} " "image. However, there are a few machines out there that require specific " "image types. Those machines, in general using @code{ARM} processors, may " "expect specific partitions at specific offsets." msgstr "" #. type: Plain text #: doc/guix.texi:42130 msgid "" "This chapter explains how to define customized system images and how to turn " "them into actual bootable images." msgstr "" #. type: section #: doc/guix.texi:42139 #, no-wrap msgid "@code{image} Reference" msgstr "" #. type: Plain text #: doc/guix.texi:42143 msgid "" "The @code{image} record, described right after, allows you to define a " "customized bootable system image." msgstr "" #. type: deftp #: doc/guix.texi:42144 #, no-wrap msgid "{Data Type} image" msgstr "" #. type: deftp #: doc/guix.texi:42146 msgid "This is the data type representing a system image." msgstr "" #. type: item #: doc/guix.texi:42148 #, no-wrap msgid "@code{name} (default: @code{#false})" msgstr "" #. type: table #: doc/guix.texi:42151 msgid "" "The image name as a symbol, @code{'my-iso9660} for instance. The name is " "optional and it defaults to @code{#false}." msgstr "" #. type: table #: doc/guix.texi:42154 msgid "The image format as a symbol. The following formats are supported:" msgstr "" #. type: item #: doc/guix.texi:42156 #, no-wrap msgid "@code{disk-image}, a raw disk image composed of one or multiple" msgstr "" #. type: itemize #: doc/guix.texi:42158 msgid "partitions." msgstr "" #. type: item #: doc/guix.texi:42159 #, no-wrap msgid "@code{compressed-qcow2}, a compressed qcow2 image composed of" msgstr "" #. type: itemize #: doc/guix.texi:42161 msgid "one or multiple partitions." msgstr "" #. type: item #: doc/guix.texi:42162 #, no-wrap msgid "@code{docker}, a Docker image." msgstr "" #. type: item #: doc/guix.texi:42164 #, no-wrap msgid "@code{iso9660}, an ISO-9660 image." msgstr "" #. type: item #: doc/guix.texi:42166 #, no-wrap msgid "@code{tarball}, a tar.gz image archive." msgstr "" #. type: item #: doc/guix.texi:42168 #, no-wrap msgid "@code{wsl2}, a WSL2 image." msgstr "" #. type: item #: doc/guix.texi:42172 #, no-wrap msgid "@code{platform} (default: @code{#false})" msgstr "" #. type: table #: doc/guix.texi:42176 msgid "" "The @code{platform} record the image is targeting (@pxref{Platforms}), " "@code{aarch64-linux} for instance. By default, this field is set to " "@code{#false} and the image will target the host platform." msgstr "" #. type: item #: doc/guix.texi:42177 doc/guix.texi:42235 #, no-wrap msgid "@code{size} (default: @code{'guess})" msgstr "" #. type: table #: doc/guix.texi:42181 msgid "" "The image size in bytes or @code{'guess}. The @code{'guess} symbol, which " "is the default, means that the image size will be inferred based on the " "image content." msgstr "" #. type: table #: doc/guix.texi:42184 msgid "The image's @code{operating-system} record that is instanciated." msgstr "" #. type: item #: doc/guix.texi:42185 #, no-wrap msgid "@code{partition-table-type} (default: @code{'mbr})" msgstr "" #. type: table #: doc/guix.texi:42188 msgid "" "The image partition table type as a symbol. Possible values are @code{'mbr} " "and @code{'gpt}. It default to @code{'mbr}." msgstr "" #. type: item #: doc/guix.texi:42189 #, no-wrap msgid "@code{partitions} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:42192 msgid "" "The image partitions as a list of @code{partition} records (@pxref{partition " "Reference})." msgstr "" #. type: item #: doc/guix.texi:42193 #, no-wrap msgid "@code{compression?} (default: @code{#true})" msgstr "" #. type: table #: doc/guix.texi:42197 msgid "" "Whether the image content should be compressed, as a boolean. It defaults " "to @code{#true} and only applies to @code{'iso9660} image formats." msgstr "" #. type: item #: doc/guix.texi:42198 #, no-wrap msgid "@code{volatile-root?} (default: @code{#true})" msgstr "" #. type: table #: doc/guix.texi:42200 msgid "Whether the image root partition should be made volatile, as a boolean." msgstr "" #. type: table #: doc/guix.texi:42205 msgid "" "This is achieved by using a RAM backed file system (overlayfs) that is " "mounted on top of the root partition by the initrd. It defaults to " "@code{#true}. When set to @code{#false}, the image root partition is " "mounted as read-write partition by the initrd." msgstr "" #. type: item #: doc/guix.texi:42206 #, no-wrap msgid "@code{shared-store?} (default: @code{#false})" msgstr "" #. type: table #: doc/guix.texi:42213 msgid "" "Whether the image's store should be shared with the host system, as a " "boolean. This can be useful when creating images dedicated to virtual " "machines. When set to @code{#false}, which is the default, the image's " "@code{operating-system} closure is copied to the image. Otherwise, when set " "to @code{#true}, it is assumed that the host store will be made available at " "boot, using a @code{9p} mount for instance." msgstr "" #. type: item #: doc/guix.texi:42214 #, no-wrap msgid "@code{shared-network?} (default: @code{#false})" msgstr "" #. type: table #: doc/guix.texi:42218 msgid "" "Whether to use the host network interfaces within the image, as a boolean. " "This is only used for the @code{'docker} image format. It defaults to " "@code{#false}." msgstr "" #. type: item #: doc/guix.texi:42219 #, no-wrap msgid "@code{substitutable?} (default: @code{#true})" msgstr "" #. type: table #: doc/guix.texi:42222 msgid "" "Whether the image derivation should be substitutable, as a boolean. It " "defaults to @code{true}." msgstr "" #. type: node #: doc/guix.texi:42226 #, no-wrap msgid "partition Reference" msgstr "" #. type: subsection #: doc/guix.texi:42227 #, no-wrap msgid "@code{partition} Reference" msgstr "" #. type: Plain text #: doc/guix.texi:42230 msgid "In @code{image} record may contain some partitions." msgstr "" #. type: deftp #: doc/guix.texi:42231 #, no-wrap msgid "{Data Type} partition" msgstr "" #. type: deftp #: doc/guix.texi:42233 msgid "This is the data type representing an image partition." msgstr "" #. type: table #: doc/guix.texi:42239 msgid "" "The partition size in bytes or @code{'guess}. The @code{'guess} symbol, " "which is the default, means that the partition size will be inferred based " "on the partition content." msgstr "" #. type: item #: doc/guix.texi:42240 #, no-wrap msgid "@code{offset} (default: @code{0})" msgstr "" #. type: table #: doc/guix.texi:42244 msgid "" "The partition's start offset in bytes, relative to the image start or the " "previous partition end. It defaults to @code{0} which means that there is " "no offset applied." msgstr "" #. type: item #: doc/guix.texi:42245 #, no-wrap msgid "@code{file-system} (default: @code{\"ext4\"})" msgstr "" #. type: table #: doc/guix.texi:42249 msgid "" "The partition file system as a string, defaulting to @code{\"ext4\"}. The " "supported values are @code{\"vfat\"}, @code{\"fat16\"}, @code{\"fat32\"} and " "@code{\"ext4\"}." msgstr "" #. type: item #: doc/guix.texi:42250 #, no-wrap msgid "@code{file-system-options} (default: @code{'()})" msgstr "" #. type: table #: doc/guix.texi:42254 msgid "" "The partition file system creation options that should be passed to the " "partition creation tool, as a list of strings. This is only supported when " "creating @code{\"ext4\"} partitions." msgstr "" #. type: table #: doc/guix.texi:42257 msgid "" "See the @code{\"extended-options\"} man page section of the @code{\"mke2fs" "\"} tool for a more complete reference." msgstr "" #. type: table #: doc/guix.texi:42261 msgid "" "The partition label as a mandatory string, @code{\"my-root\"} for instance." msgstr "" #. type: item #: doc/guix.texi:42262 #, no-wrap msgid "@code{uuid} (default: @code{#false})" msgstr "" #. type: table #: doc/guix.texi:42266 msgid "" "The partition UUID as an @code{uuid} record (@pxref{File Systems}). By " "default it is @code{#false}, which means that the partition creation tool " "will attribute a random UUID to the partition." msgstr "" #. type: table #: doc/guix.texi:42273 msgid "" "The partition flags as a list of symbols. Possible values are @code{'boot} " "and @code{'esp}. The @code{'boot} flags should be set if you want to boot " "from this partition. Exactly one partition should have this flag set, " "usually the root one. The @code{'esp} flag identifies a UEFI System " "Partition." msgstr "" #. type: item #: doc/guix.texi:42274 #, no-wrap msgid "@code{initializer} (default: @code{#false})" msgstr "" #. type: table #: doc/guix.texi:42279 msgid "" "The partition initializer procedure as a gexp. This procedure is called to " "populate a partition. If no initializer is passed, the @code{initialize-" "root-partition} procedure from the @code{(gnu build image)} module is used." msgstr "" #. type: Plain text #: doc/guix.texi:42288 msgid "" "Let's say you would like to create an MBR image with three distinct " "partitions:" msgstr "" #. type: item #: doc/guix.texi:42290 #, no-wrap msgid "The @acronym{ESP, EFI System Partition}, a partition of" msgstr "" #. type: itemize #: doc/guix.texi:42292 msgid "40@tie{}MiB at offset 1024@tie{}KiB with a vfat file system." msgstr "" #. type: item #: doc/guix.texi:42293 #, no-wrap msgid "an ext4 partition of 50@tie{}MiB data file, and labeled ``data''." msgstr "" #. type: item #: doc/guix.texi:42295 #, no-wrap msgid "an ext4 bootable partition containing the @code{%simple-os}" msgstr "" #. type: itemize #: doc/guix.texi:42297 msgid "operating-system." msgstr "" #. type: Plain text #: doc/guix.texi:42301 msgid "" "You would then write the following image definition in a @code{my-image.scm} " "file for instance." msgstr "" #. type: lisp #: doc/guix.texi:42308 #, no-wrap msgid "" "(use-modules (gnu)\n" " (gnu image)\n" " (gnu tests)\n" " (gnu system image)\n" " (guix gexp))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:42310 doc/guix.texi:42412 #, no-wrap msgid "" "(define MiB (expt 2 20))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:42339 #, no-wrap msgid "" "(image\n" " (format 'disk-image)\n" " (operating-system %simple-os)\n" " (partitions\n" " (list\n" " (partition\n" " (size (* 40 MiB))\n" " (offset (* 1024 1024))\n" " (label \"GNU-ESP\")\n" " (file-system \"vfat\")\n" " (flags '(esp))\n" " (initializer (gexp initialize-efi-partition)))\n" " (partition\n" " (size (* 50 MiB))\n" " (label \"DATA\")\n" " (file-system \"ext4\")\n" " (initializer #~(lambda* (root . rest)\n" " (mkdir root)\n" " (call-with-output-file\n" " (string-append root \"/data\")\n" " (lambda (port)\n" " (format port \"my-data\"))))))\n" " (partition\n" " (size 'guess)\n" " (label root-label)\n" " (file-system \"ext4\")\n" " (flags '(boot))\n" " (initializer (gexp initialize-root-partition))))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:42347 msgid "" "Note that the first and third partitions use generic initializers " "procedures, initialize-efi-partition and initialize-root-partition " "respectively. The initialize-efi-partition installs a GRUB EFI loader that " "is loading the GRUB bootloader located in the root partition. The " "initialize-root-partition instantiates a complete system as defined by the " "@code{%simple-os} operating-system." msgstr "" #. type: Plain text #: doc/guix.texi:42349 msgid "You can now run:" msgstr "" #. type: example #: doc/guix.texi:42352 #, no-wrap msgid "guix system image my-image.scm\n" msgstr "" #. type: Plain text #: doc/guix.texi:42356 msgid "" "to instantiate the @code{image} definition. That produces a disk image " "which has the expected structure:" msgstr "" #. type: example #: doc/guix.texi:42365 #, no-wrap msgid "" "$ parted $(guix system image my-image.scm) print\n" "@dots{}\n" "Model: (file)\n" "Disk /gnu/store/yhylv1bp5b2ypb97pd3bbhz6jk5nbhxw-disk-image: 1714MB\n" "Sector size (logical/physical): 512B/512B\n" "Partition Table: msdos\n" "Disk Flags:\n" "\n" msgstr "" #. type: example #: doc/guix.texi:42370 #, no-wrap msgid "" "Number Start End Size Type File system Flags\n" " 1 1049kB 43.0MB 41.9MB primary fat16 esp\n" " 2 43.0MB 95.4MB 52.4MB primary ext4\n" " 3 95.4MB 1714MB 1619MB primary ext4 boot\n" msgstr "" #. type: Plain text #: doc/guix.texi:42375 msgid "" "The size of the @code{boot} partition has been inferred to @code{1619MB} so " "that it is large enough to host the @code{%simple-os} operating-system." msgstr "" #. type: Plain text #: doc/guix.texi:42380 msgid "" "You can also use existing @code{image} record definitions and inherit from " "them to simplify the @code{image} definition. The @code{(gnu system image)} " "module provides the following @code{image} definition variables." msgstr "" #. type: defvr #: doc/guix.texi:42381 #, no-wrap msgid "{Scheme Variable} efi-disk-image" msgstr "" #. type: defvr #: doc/guix.texi:42385 msgid "" "A MBR disk-image composed of two partitions: a 64 bits ESP partition and a " "ROOT boot partition. This image can be used on most @code{x86_64} and " "@code{i686} machines, supporting BIOS or UEFI booting." msgstr "" #. type: defvr #: doc/guix.texi:42387 #, no-wrap msgid "{Scheme Variable} efi32-disk-image" msgstr "" #. type: defvr #: doc/guix.texi:42389 msgid "Same as @code{efi-disk-image} but with a 32 bits EFI partition." msgstr "" #. type: defvr #: doc/guix.texi:42391 #, no-wrap msgid "{Scheme Variable} iso9660-image" msgstr "" #. type: defvr #: doc/guix.texi:42394 msgid "" "An ISO-9660 image composed of a single bootable partition. This image can " "also be used on most @code{x86_64} and @code{i686} machines." msgstr "" #. type: defvr #: doc/guix.texi:42396 #, no-wrap msgid "{Scheme Variable} docker-image" msgstr "" #. type: defvr #: doc/guix.texi:42398 msgid "A Docker image that can be used to spawn a Docker container." msgstr "" #. type: Plain text #: doc/guix.texi:42402 msgid "" "Using the @code{efi-disk-image} we can simplify our previous @code{image} " "declaration this way:" msgstr "" #. type: lisp #: doc/guix.texi:42410 #, no-wrap msgid "" "(use-modules (gnu)\n" " (gnu image)\n" " (gnu tests)\n" " (gnu system image)\n" " (guix gexp)\n" " (ice-9 match))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:42424 #, no-wrap msgid "" "(define data\n" " (partition\n" " (size (* 50 MiB))\n" " (label \"DATA\")\n" " (file-system \"ext4\")\n" " (initializer #~(lambda* (root . rest)\n" " (mkdir root)\n" " (call-with-output-file\n" " (string-append root \"/data\")\n" " (lambda (port)\n" " (format port \"my-data\")))))))\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:42432 #, no-wrap msgid "" "(image\n" " (inherit efi-disk-image)\n" " (operating-system %simple-os)\n" " (partitions\n" " (match (image-partitions efi-disk-image)\n" " ((esp root)\n" " (list esp data root)))))\n" msgstr "" #. type: Plain text #: doc/guix.texi:42436 msgid "" "This will give the exact same @code{image} instantiation but the " "@code{image} declaration is simpler." msgstr "" #. type: Plain text #: doc/guix.texi:42445 msgid "" "The @command{guix system image} command can, as we saw above, take a file " "containing an @code{image} declaration as argument and produce an actual " "disk image from it. The same command can also handle a file containing an " "@code{operating-system} declaration as argument. In that case, how is the " "@code{operating-system} turned into an image?" msgstr "" #. type: Plain text #: doc/guix.texi:42449 msgid "" "That's where the @code{image-type} record intervenes. This record defines " "how to transform an @code{operating-system} record into an @code{image} " "record." msgstr "" #. type: deftp #: doc/guix.texi:42450 #, no-wrap msgid "{Data Type} image-type" msgstr "" #. type: deftp #: doc/guix.texi:42452 msgid "This is the data type representing an image-type." msgstr "" #. type: table #: doc/guix.texi:42457 msgid "" "The image-type name as a mandatory symbol, @code{'efi32-raw} for instance." msgstr "" #. type: code{#1} #: doc/guix.texi:42458 #, no-wrap msgid "constructor" msgstr "" #. type: table #: doc/guix.texi:42462 msgid "" "The image-type constructor, as a mandatory procedure that takes an " "@code{operating-system} record as argument and returns an @code{image} " "record." msgstr "" #. type: Plain text #: doc/guix.texi:42468 msgid "" "There are several @code{image-type} records provided by the @code{(gnu " "system image)} and the @code{(gnu system images @dots{})} modules." msgstr "" #. type: defvr #: doc/guix.texi:42469 #, no-wrap msgid "{Scheme Variable} efi-raw-image-type" msgstr "" #. type: defvr #: doc/guix.texi:42471 msgid "Build an image based on the @code{efi-disk-image} image." msgstr "" #. type: defvr #: doc/guix.texi:42473 #, no-wrap msgid "{Scheme Variable} efi32-raw-image-type" msgstr "" #. type: defvr #: doc/guix.texi:42475 msgid "Build an image based on the @code{efi32-disk-image} image." msgstr "" #. type: defvr #: doc/guix.texi:42477 #, no-wrap msgid "{Scheme Variable} qcow2-image-type" msgstr "" #. type: defvr #: doc/guix.texi:42480 msgid "" "Build an image based on the @code{efi-disk-image} image but with the " "@code{compressed-qcow2} image format." msgstr "" #. type: defvr #: doc/guix.texi:42482 #, no-wrap msgid "{Scheme Variable} iso-image-type" msgstr "" #. type: defvr #: doc/guix.texi:42484 msgid "Build a compressed image based on the @code{iso9660-image} image." msgstr "" #. type: defvr #: doc/guix.texi:42486 #, no-wrap msgid "{Scheme Variable} uncompressed-iso-image-type" msgstr "" #. type: defvr #: doc/guix.texi:42489 msgid "" "Build an image based on the @code{iso9660-image} image but with the " "@code{compression?} field set to @code{#false}." msgstr "" #. type: defvr #: doc/guix.texi:42491 #, no-wrap msgid "{Scheme Variable} docker-image-type" msgstr "" #. type: defvr #: doc/guix.texi:42493 msgid "Build an image based on the @code{docker-image} image." msgstr "" #. type: defvr #: doc/guix.texi:42495 #, no-wrap msgid "{Scheme Variable} raw-with-offset-image-type" msgstr "" #. type: defvr #: doc/guix.texi:42499 msgid "" "Build an MBR image with a single partition starting at a @code{1024KiB} " "offset. This is useful to leave some room to install a bootloader in the " "post-MBR gap." msgstr "" #. type: defvr #: doc/guix.texi:42501 #, no-wrap msgid "{Scheme Variable} pinebook-pro-image-type" msgstr "" #. type: defvr #: doc/guix.texi:42506 msgid "" "Build an image that is targeting the Pinebook Pro machine. The MBR image " "contains a single partition starting at a @code{9MiB} offset. The @code{u-" "boot-pinebook-pro-rk3399-bootloader} bootloader will be installed in this " "gap." msgstr "" #. type: defvr #: doc/guix.texi:42508 #, no-wrap msgid "{Scheme Variable} rock64-image-type" msgstr "" #. type: defvr #: doc/guix.texi:42513 msgid "" "Build an image that is targeting the Rock64 machine. The MBR image contains " "a single partition starting at a @code{16MiB} offset. The @code{u-boot-" "rock64-rk3328-bootloader} bootloader will be installed in this gap." msgstr "" #. type: defvr #: doc/guix.texi:42515 #, no-wrap msgid "{Scheme Variable} novena-image-type" msgstr "" #. type: defvr #: doc/guix.texi:42518 msgid "" "Build an image that is targeting the Novena machine. It has the same " "characteristics as @code{raw-with-offset-image-type}." msgstr "" #. type: defvr #: doc/guix.texi:42520 #, no-wrap msgid "{Scheme Variable} pine64-image-type" msgstr "" #. type: defvr #: doc/guix.texi:42523 msgid "" "Build an image that is targeting the Pine64 machine. It has the same " "characteristics as @code{raw-with-offset-image-type}." msgstr "" #. type: defvr #: doc/guix.texi:42525 #, no-wrap msgid "{Scheme Variable} hurd-image-type" msgstr "" #. type: defvr #: doc/guix.texi:42529 msgid "" "Build an image that is targeting a @code{i386} machine running the Hurd " "kernel. The MBR image contains a single ext2 partitions with specific " "@code{file-system-options} flags." msgstr "" #. type: defvr #: doc/guix.texi:42531 #, no-wrap msgid "{Scheme Variable} hurd-qcow2-image-type" msgstr "" #. type: defvr #: doc/guix.texi:42534 msgid "" "Build an image similar to the one built by the @code{hurd-image-type} but " "with the @code{format} set to @code{'compressed-qcow2}." msgstr "" #. type: defvr #: doc/guix.texi:42536 #, no-wrap msgid "{Scheme Variable} wsl2-image-type" msgstr "" #. type: defvr #: doc/guix.texi:42539 msgid "" "Build an image for the @acronym{WSL2, Windows Subsystem for Linux 2}. It " "can be imported by running:" msgstr "" #. type: example #: doc/guix.texi:42543 #, no-wrap msgid "" "wsl --import Guix ./guix ./wsl2-image.tar.gz\n" "wsl -d Guix\n" msgstr "" #. type: Plain text #: doc/guix.texi:42551 msgid "" "So, if we get back to the @code{guix system image} command taking an " "@code{operating-system} declaration as argument. By default, the @code{efi-" "raw-image-type} is used to turn the provided @code{operating-system} into an " "actual bootable image." msgstr "" #. type: Plain text #: doc/guix.texi:42557 msgid "" "To use a different @code{image-type}, the @code{--image-type} option can be " "used. The @code{--list-image-types} option will list all the supported " "image types. It turns out to be a textual listing of all the @code{image-" "types} variables described just above (@pxref{Invoking guix system})." msgstr "" #. type: Plain text #: doc/guix.texi:42564 msgid "" "Let's take the example of the Pine64, an ARM based machine. To be able to " "produce an image targeting this board, we need the following elements:" msgstr "" #. type: item #: doc/guix.texi:42566 #, no-wrap msgid "An @code{operating-system} record containing at least" msgstr "" #. type: itemize #: doc/guix.texi:42569 msgid "" "an appropriate kernel (@code{linux-libre-arm64-generic}) and bootloader " "@code{u-boot-pine64-lts-bootloader}) for the Pine64." msgstr "" #. type: item #: doc/guix.texi:42570 #, no-wrap msgid "Possibly, an @code{image-type} record providing a way to" msgstr "" #. type: itemize #: doc/guix.texi:42573 msgid "" "turn an @code{operating-system} record to an @code{image} record suitable " "for the Pine64." msgstr "" #. type: item #: doc/guix.texi:42574 #, no-wrap msgid "An actual @code{image} that can be instantiated with the" msgstr "" #. type: itemize #: doc/guix.texi:42576 msgid "@command{guix system image} command." msgstr "" #. type: Plain text #: doc/guix.texi:42582 msgid "" "The @code{(gnu system images pine64)} module provides all those elements: " "@code{pine64-barebones-os}, @code{pine64-image-type} and @code{pine64-" "barebones-raw-image} respectively." msgstr "" #. type: Plain text #: doc/guix.texi:42585 msgid "" "The module returns the @code{pine64-barebones-raw-image} in order for users " "to be able to run:" msgstr "" #. type: example #: doc/guix.texi:42588 #, no-wrap msgid "guix system image gnu/system/images/pine64.scm\n" msgstr "" #. type: Plain text #: doc/guix.texi:42593 msgid "" "Now, thanks to the @code{pine64-image-type} record declaring the " "@code{'pine64-raw} @code{image-type}, one could also prepare a @code{my-pine." "scm} file with the following content:" msgstr "" #. type: lisp #: doc/guix.texi:42599 #, no-wrap msgid "" "(use-modules (gnu system images pine64))\n" "(operating-system\n" " (inherit pine64-barebones-os)\n" " (timezone \"Europe/Athens\"))\n" msgstr "" #. type: Plain text #: doc/guix.texi:42602 msgid "to customize the @code{pine64-barebones-os}, and run:" msgstr "" #. type: example #: doc/guix.texi:42605 #, no-wrap msgid "$ guix system image --image-type=pine64-raw my-pine.scm\n" msgstr "" #. type: Plain text #: doc/guix.texi:42610 msgid "" "Note that there are other modules in the @code{gnu/system/images} directory " "targeting @code{Novena}, @code{Pine64}, @code{PinebookPro} and @code{Rock64} " "machines." msgstr "" #. type: cindex #: doc/guix.texi:42614 #, no-wrap msgid "debugging files" msgstr "" #. type: Plain text #: doc/guix.texi:42620 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:42624 msgid "" "This chapter explains how to use separate debug info when packages provide " "it, and how to rebuild packages with debug info when it's missing." msgstr "" #. type: Plain text #: doc/guix.texi:42640 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:42647 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:42655 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:42658 #, no-wrap msgid "guix install glibc:debug guile:debug\n" msgstr "" #. type: Plain text #: doc/guix.texi:42664 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:42667 #, no-wrap msgid "(gdb) set debug-file-directory ~/.guix-profile/lib/debug\n" msgstr "" #. type: Plain text #: doc/guix.texi:42671 msgid "" "From there on, GDB will pick up debugging information from the @file{.debug} " "files under @file{~/.guix-profile/lib/debug}." msgstr "" #. type: Plain text #: doc/guix.texi:42676 msgid "" "Below is an alternative GDB script which is useful when working with other " "profiles. It takes advantage of the optional Guile integration in GDB. " "This snippet is included by default on Guix System in the @file{~/.gdbinit} " "file." msgstr "" #. type: example #: doc/guix.texi:42684 #, no-wrap msgid "" "guile\n" "(use-modules (gdb))\n" "(execute (string-append \"set debug-file-directory \"\n" " (or (getenv \"GDB_DEBUG_FILE_DIRECTORY\")\n" " \"~/.guix-profile/lib/debug\")))\n" "end\n" msgstr "" #. type: Plain text #: doc/guix.texi:42692 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:42700 msgid "" "The @code{debug} output mechanism in Guix is implemented by the @code{gnu-" "build-system} (@pxref{Build Systems}). Currently, it is opt-in---debugging " "information is available only for the packages with definitions explicitly " "declaring a @code{debug} output. To check whether a package has a " "@code{debug} output, use @command{guix package --list-available} " "(@pxref{Invoking guix package})." msgstr "" #. type: Plain text #: doc/guix.texi:42702 msgid "Read on for how to deal with packages lacking a @code{debug} output." msgstr "" #. type: Plain text #: doc/guix.texi:42714 msgid "" "As we saw above, some packages, but not all, provide debugging info in a " "@code{debug} output. What can you do when debugging info is missing? The " "@option{--with-debug-info} option provides a solution to that: it allows you " "to rebuild the package(s) for which debugging info is missing---and only " "those---and to graft those onto the application you're debugging. Thus, " "while it's not as fast as installing a @code{debug} output, it is relatively " "inexpensive." msgstr "" #. type: Plain text #: doc/guix.texi:42719 msgid "" "Let's illustrate that. Suppose you're experiencing a bug in Inkscape and " "would like to see what's going on in GLib, a library that's deep down in its " "dependency graph. As it turns out, GLib does not have a @code{debug} output " "and the backtrace GDB shows is all sadness:" msgstr "" #. type: example #: doc/guix.texi:42730 #, no-wrap msgid "" "(gdb) bt\n" "#0 0x00007ffff5f92190 in g_getenv ()\n" " from /gnu/store/@dots{}-glib-2.62.6/lib/libglib-2.0.so.0\n" "#1 0x00007ffff608a7d6 in gobject_init_ctor ()\n" " from /gnu/store/@dots{}-glib-2.62.6/lib/libgobject-2.0.so.0\n" "#2 0x00007ffff7fe275a in call_init (l=, argc=argc@@entry=1, argv=argv@@entry=0x7fffffffcfd8, \n" " env=env@@entry=0x7fffffffcfe8) at dl-init.c:72\n" "#3 0x00007ffff7fe2866 in call_init (env=0x7fffffffcfe8, argv=0x7fffffffcfd8, argc=1, l=)\n" " at dl-init.c:118\n" msgstr "" #. type: Plain text #: doc/guix.texi:42734 msgid "" "To address that, you install Inkscape linked against a variant GLib that " "contains debug info:" msgstr "" #. type: Plain text #: doc/guix.texi:42740 msgid "This time, debugging will be a whole lot nicer:" msgstr "" #. type: example #: doc/guix.texi:42758 #, no-wrap msgid "" "$ gdb --args sh -c 'exec inkscape'\n" "@dots{}\n" "(gdb) b g_getenv\n" "Function \"g_getenv\" not defined.\n" "Make breakpoint pending on future shared library load? (y or [n]) y\n" "Breakpoint 1 (g_getenv) pending.\n" "(gdb) r\n" "Starting program: /gnu/store/@dots{}-profile/bin/sh -c exec\\ inkscape\n" "@dots{}\n" "(gdb) bt\n" "#0 g_getenv (variable=variable@@entry=0x7ffff60c7a2e \"GOBJECT_DEBUG\") at ../glib-2.62.6/glib/genviron.c:252\n" "#1 0x00007ffff608a7d6 in gobject_init () at ../glib-2.62.6/gobject/gtype.c:4380\n" "#2 gobject_init_ctor () at ../glib-2.62.6/gobject/gtype.c:4493\n" "#3 0x00007ffff7fe275a in call_init (l=, argc=argc@@entry=3, argv=argv@@entry=0x7fffffffd088, \n" " env=env@@entry=0x7fffffffd0a8) at dl-init.c:72\n" "@dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:42761 msgid "Much better!" msgstr "" #. type: Plain text #: doc/guix.texi:42765 msgid "" "Note that there can be packages for which @option{--with-debug-info} will " "not have the desired effect. @xref{Package Transformation Options, " "@option{--with-debug-info}}, for more information." msgstr "" #. type: chapter #: doc/guix.texi:42767 #, no-wrap msgid "Using @TeX{} and @LaTeX{}" msgstr "" #. type: cindex #: doc/guix.texi:42769 #, no-wrap msgid "@TeX{} packages" msgstr "" #. type: cindex #: doc/guix.texi:42770 #, no-wrap msgid "@LaTeX{} packages" msgstr "" #. type: Plain text #: doc/guix.texi:42778 msgid "" "Guix provides packages for the @TeX{}, @LaTeX{}, ConTeXt, LuaTeX, and " "related typesetting systems, taken from the @uref{https://www.tug.org/" "texlive/, @TeX{} Live distribution}. However, because @TeX{} Live is so " "huge and because finding your way in this maze is tricky, we thought that " "you, dear user, would welcome guidance on how to deploy the relevant " "packages so you can compile your @TeX{} and @LaTeX{} documents." msgstr "" #. type: Plain text #: doc/guix.texi:42780 msgid "@TeX{} Live currently comes in two flavors in Guix:" msgstr "" #. type: itemize #: doc/guix.texi:42786 msgid "" "The ``monolithic'' @code{texlive} package: it comes with @emph{every single " "@TeX{} Live package} (more than 7,000 of them), but it is huge (more than " "4@tie{}GiB for a single package!)." msgstr "" #. type: itemize #: doc/guix.texi:42796 msgid "" "The ``modular'' @code{texlive-} packages: you install @code{texlive-base}, " "which provides core functionality and the main commands---" "@command{pdflatex}, @command{dvips}, @command{luatex}, @command{mf}, etc.---" "together with individual packages that provide just the features you need---" "@code{texlive-listings} for the @code{listings} package, @code{texlive-" "hyperref} for @code{hyperref}, @code{texlive-beamer} for Beamer, " "@code{texlive-pgf} for PGF/TikZ, and so on." msgstr "" #. type: Plain text #: doc/guix.texi:42801 msgid "" "We recommend using the modular package set because it is much less resource-" "hungry. To build your documents, you would use commands such as:" msgstr "" #. type: example #: doc/guix.texi:42805 #, no-wrap msgid "" "guix shell texlive-base texlive-wrapfig \\\n" " texlive-hyperref texlive-cm-super -- pdflatex doc.tex\n" msgstr "" #. type: Plain text #: doc/guix.texi:42809 msgid "" "You can quickly end up with unreasonably long command lines though. The " "solution is to instead write a manifest, for example like this one:" msgstr "" #. type: lisp #: doc/guix.texi:42813 #, no-wrap msgid "" "(specifications->manifest\n" " '(\"rubber\"\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:42816 #, no-wrap msgid "" " \"texlive-base\"\n" " \"texlive-wrapfig\"\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:42819 #, no-wrap msgid "" " \"texlive-microtype\"\n" " \"texlive-listings\" \"texlive-hyperref\"\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:42822 #, no-wrap msgid "" " ;; PGF/TikZ\n" " \"texlive-pgf\"\n" "\n" msgstr "" #. type: lisp #: doc/guix.texi:42826 #, no-wrap msgid "" " ;; Additional fonts.\n" " \"texlive-cm-super\" \"texlive-amsfonts\"\n" " \"texlive-times\" \"texlive-helvetic\" \"texlive-courier\"))\n" msgstr "" #. type: Plain text #: doc/guix.texi:42829 msgid "You can then pass it to any command with the @option{-m} option:" msgstr "" #. type: example #: doc/guix.texi:42832 #, no-wrap msgid "guix shell -m manifest.scm -- pdflatex doc.tex\n" msgstr "" #. type: Plain text #: doc/guix.texi:42840 msgid "" "@xref{Writing Manifests}, for more on manifests. In the future, we plan to " "provide packages for @TeX{} Live @dfn{collections}---``meta-packages'' such " "as @code{fontsrecommended}, @code{humanities}, or @code{langarabic} that " "provide the set of packages needed in this particular domain. That will " "allow you to list fewer packages." msgstr "" #. type: Plain text #: doc/guix.texi:42846 msgid "" "The main difficulty here is that using the modular package set forces you to " "select precisely the packages that you need. You can use @command{guix " "search}, but finding the right package can prove to be tedious. When a " "package is missing, @command{pdflatex} and similar commands fail with an " "obscure message along the lines of:" msgstr "" #. type: example #: doc/guix.texi:42850 #, no-wrap msgid "" "doc.tex: File `tikz.sty' not found.\n" "doc.tex:7: Emergency stop.\n" msgstr "" #. type: Plain text #: doc/guix.texi:42854 msgid "or, for a missing font:" msgstr "" #. type: example #: doc/guix.texi:42858 #, no-wrap msgid "" "kpathsea: Running mktexmf phvr7t\n" "! I can't find file `phvr7t'.\n" msgstr "" #. type: Plain text #: doc/guix.texi:42862 msgid "" "How do you determine what the missing package is? In the first case, you'll " "find the answer by running:" msgstr "" #. type: example #: doc/guix.texi:42868 #, no-wrap msgid "" "$ guix search texlive tikz\n" "name: texlive-pgf\n" "version: 59745\n" "@dots{}\n" msgstr "" #. type: Plain text #: doc/guix.texi:42873 msgid "" "In the second case, @command{guix search} turns up nothing. Instead, you " "can search the @TeX{} Live package database using the @command{tlmgr} " "command:" msgstr "" #. type: example #: doc/guix.texi:42877 #, no-wrap msgid "" "$ guix shell texlive-base -- tlmgr info phvr7t\n" "tlmgr: cannot find package phvr7t, searching for other matches:\n" "\n" msgstr "" #. type: example #: doc/guix.texi:42879 #, no-wrap msgid "" "Packages containing `phvr7t' in their title/description:\n" "\n" msgstr "" #. type: example #: doc/guix.texi:42888 #, no-wrap msgid "" "Packages containing files matching `phvr7t':\n" "helvetic:\n" " texmf-dist/fonts/tfm/adobe/helvetic/phvr7t.tfm\n" " texmf-dist/fonts/tfm/adobe/helvetic/phvr7tn.tfm\n" " texmf-dist/fonts/vf/adobe/helvetic/phvr7t.vf\n" " texmf-dist/fonts/vf/adobe/helvetic/phvr7tn.vf\n" "tex4ht:\n" " texmf-dist/tex4ht/ht-fonts/alias/adobe/helvetic/phvr7t.htf\n" msgstr "" #. type: Plain text #: doc/guix.texi:42893 msgid "" "The file is available in the @TeX{} Live @code{helvetic} package, which is " "known in Guix as @code{texlive-helvetic}. Quite a ride, but we found it!" msgstr "" #. type: Plain text #: doc/guix.texi:42897 msgid "" "There is one important limitation though: Guix currently provides a subset " "of the @TeX{} Live packages. If you stumble upon a missing package, you can " "try and import it (@pxref{Invoking guix import}):" msgstr "" #. type: example #: doc/guix.texi:42900 #, no-wrap msgid "guix import texlive @var{package}\n" msgstr "" #. type: quotation #: doc/guix.texi:42915 msgid "" "@TeX{} Live packaging is still very much work in progress, but you can help! " "@xref{Contributing}, for more information." msgstr "" #. type: cindex #: doc/guix.texi:42920 #, no-wrap msgid "security updates" msgstr "" #. type: Plain text #: doc/guix.texi:42929 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:42936 #, 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:42939 msgid "@xref{Invoking guix lint}, for more information." msgstr "" #. type: Plain text #: doc/guix.texi:42948 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:42949 #, no-wrap msgid "grafts" msgstr "" #. type: Plain text #: doc/guix.texi:42957 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:42958 #, no-wrap msgid "replacements of packages, for grafts" msgstr "" #. type: Plain text #: doc/guix.texi:42964 msgid "" "For instance, suppose a security update needs to be applied to Bash. Guix " "developers will provide a package definition for the ``fixed'' Bash, say " "@code{bash-fixed}, in the usual way (@pxref{Defining Packages}). Then, the " "original package definition is augmented with a @code{replacement} field " "pointing to the package containing the bug fix:" msgstr "" #. type: lisp #: doc/guix.texi:42971 #, no-wrap msgid "" "(define bash\n" " (package\n" " (name \"bash\")\n" " ;; @dots{}\n" " (replacement bash-fixed)))\n" msgstr "" #. type: Plain text #: doc/guix.texi:42981 msgid "" "From there on, any package depending directly or indirectly on Bash---as " "reported by @command{guix gc --requisites} (@pxref{Invoking guix gc})---that " "is installed is automatically ``rewritten'' to refer to @code{bash-fixed} " "instead of @code{bash}. This grafting process takes time proportional to " "the size of the package, usually less than a minute for an ``average'' " "package on a recent machine. Grafting is recursive: when an indirect " "dependency requires grafting, then grafting ``propagates'' up to the package " "that the user is installing." msgstr "" #. type: Plain text #: doc/guix.texi:42989 msgid "" "Currently, the length of the name and version of the graft and that of the " "package it replaces (@code{bash-fixed} and @code{bash} in the example above) " "must be equal. This restriction mostly comes from the fact that grafting " "works by patching files, including binary files, directly. Other " "restrictions may apply: for instance, when adding a graft to a package " "providing a shared library, the original shared library and its replacement " "must have the same @code{SONAME} and be binary-compatible." msgstr "" #. type: Plain text #: doc/guix.texi:42993 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:42996 #, no-wrap msgid "guix build bash --no-grafts\n" msgstr "" #. type: Plain text #: doc/guix.texi:43000 msgid "returns the store file name of the original Bash, whereas:" msgstr "" #. type: example #: doc/guix.texi:43003 #, no-wrap msgid "guix build bash\n" msgstr "" #. type: Plain text #: doc/guix.texi:43008 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:43011 msgid "" "To verify which Bash your whole profile refers to, you can run " "(@pxref{Invoking guix gc}):" msgstr "" #. type: example #: doc/guix.texi:43014 #, no-wrap msgid "guix gc -R $(readlink -f ~/.guix-profile) | grep bash\n" msgstr "" #. type: Plain text #: doc/guix.texi:43019 msgid "" "@dots{} and compare the store file names that you get with those above. " "Likewise for a complete Guix system generation:" msgstr "" #. type: example #: doc/guix.texi:43022 #, no-wrap msgid "guix gc -R $(guix system build my-config.scm) | grep bash\n" msgstr "" #. type: Plain text #: doc/guix.texi:43026 msgid "" "Lastly, to check which Bash running processes are using, you can use the " "@command{lsof} command:" msgstr "" #. type: example #: doc/guix.texi:43029 #, no-wrap msgid "lsof | grep /gnu/store/.*bash\n" msgstr "" #. type: cindex #: doc/guix.texi:43037 #, no-wrap msgid "bootstrapping" msgstr "" #. type: Plain text #: doc/guix.texi:43044 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?" msgstr "" #. type: Plain text #: doc/guix.texi:43052 msgid "" "It is tempting to think of this question as one that only die-hard hackers " "may care about. However, while the answer to that question is technical in " "nature, its implications are wide-ranging. How the distribution is " "bootstrapped defines the extent to which we, as individuals and as a " "collective of users and hackers, can trust the software we run. It is a " "central concern from the standpoint of @emph{security} and from a @emph{user " "freedom} viewpoint." msgstr "" #. type: cindex #: doc/guix.texi:43053 doc/guix.texi:43265 #, no-wrap msgid "bootstrap binaries" msgstr "" #. type: Plain text #: doc/guix.texi:43063 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:43067 msgid "" "These bootstrap binaries are ``taken for granted'', though we can also re-" "create them if needed (@pxref{Preparing to Use the Bootstrap Binaries})." msgstr "" #. type: section #: doc/guix.texi:43074 #, no-wrap msgid "The Reduced Binary Seed Bootstrap" msgstr "" #. type: Plain text #: doc/guix.texi:43081 msgid "" "Guix---like other GNU/Linux distributions---is traditionally bootstrapped " "from a set of bootstrap binaries: Bourne shell, command-line tools provided " "by GNU Coreutils, Awk, Findutils, `sed', and `grep' and Guile, GCC, " "Binutils, and the GNU C Library (@pxref{Bootstrapping}). Usually, these " "bootstrap binaries are ``taken for granted.''" msgstr "" #. type: Plain text #: doc/guix.texi:43087 msgid "" "Taking the bootstrap binaries for granted means that we consider them to be " "a correct and trustworthy ``seed'' for building the complete system. " "Therein lies a problem: the combined size of these bootstrap binaries is " "about 250MB (@pxref{Bootstrappable Builds,,, mes, GNU Mes}). Auditing or " "even inspecting these is next to impossible." msgstr "" #. type: Plain text #: doc/guix.texi:43092 msgid "" "For @code{i686-linux} and @code{x86_64-linux}, Guix now features a ``Reduced " "Binary Seed'' bootstrap @footnote{We would like to say: ``Full Source " "Bootstrap'' and while we are working towards that goal it would be hyperbole " "to use that term for what we do now.}." msgstr "" #. type: Plain text #: doc/guix.texi:43098 msgid "" "The Reduced Binary Seed bootstrap removes the most critical tools---from a " "trust perspective---from the bootstrap binaries: GCC, Binutils and the GNU C " "Library are replaced by: @code{bootstrap-mescc-tools} (a tiny assembler and " "linker) and @code{bootstrap-mes} (a small Scheme Interpreter and a C " "compiler written in Scheme and the Mes C Library, built for TinyCC and for " "GCC)." msgstr "" #. type: Plain text #: doc/guix.texi:43103 msgid "" "Using these new binary seeds the ``missing'' Binutils, GCC, and the GNU C " "Library are built from source. From here on the more traditional bootstrap " "process resumes. This approach has reduced the bootstrap binaries in size " "to about 145MB in Guix v1.1." msgstr "" #. type: Plain text #: doc/guix.texi:43111 msgid "" "The next step that Guix has taken is to replace the shell and all its " "utilities with implementations in Guile Scheme, the @emph{Scheme-only " "bootstrap}. Gash (@pxref{Gash,,, gash, The Gash manual}) is a POSIX-" "compatible shell that replaces Bash, and it comes with Gash Utils which has " "minimalist replacements for Awk, the GNU Core Utilities, Grep, Gzip, Sed, " "and Tar. The rest of the bootstrap binary seeds that were removed are now " "built from source." msgstr "" #. type: Plain text #: doc/guix.texi:43121 msgid "" "Building the GNU System from source is currently only possible by adding " "some historical GNU packages as intermediate steps@footnote{Packages such as " "@code{gcc-2.95.3}, @code{binutils-2.14}, @code{glibc-2.2.5}, " "@code{gzip-1.2.4}, @code{tar-1.22}, and some others. For details, see " "@file{gnu/packages/commencement.scm}.}. As Gash and Gash Utils mature, and " "GNU packages become more bootstrappable again (e.g., new releases of GNU Sed " "will also ship as gzipped tarballs again, as alternative to the hard to " "bootstrap @code{xz}-compression), this set of added packages can hopefully " "be reduced again." msgstr "" #. type: Plain text #: doc/guix.texi:43125 msgid "" "The graph below shows the resulting dependency graph for @code{gcc-core-" "mesboot0}, the bootstrap compiler used for the traditional bootstrap of the " "rest of the Guix System." msgstr "" #. type: Plain text #: doc/guix.texi:43128 msgid "" "@image{images/gcc-core-mesboot0-graph,6in,,Dependency graph of gcc-core-" "mesboot0}" msgstr "" #. type: Plain text #: doc/guix.texi:43135 msgid "" "The only significant binary bootstrap seeds that remain@footnote{ Ignoring " "the 68KB @code{mescc-tools}; that will be removed later, together with " "@code{mes}.} are a Scheme interpreter and a Scheme compiler: GNU Mes and GNU " "Guile@footnote{Not shown in this graph are the static binaries for " "@file{bash}, @code{tar}, and @code{xz} that are used to get Guile running.}." msgstr "" #. type: Plain text #: doc/guix.texi:43138 msgid "" "This further reduction has brought down the size of the binary seed to about " "60MB for @code{i686-linux} and @code{x86_64-linux}." msgstr "" #. type: Plain text #: doc/guix.texi:43143 msgid "" "Work is ongoing to remove all binary blobs from our free software bootstrap " "stack, working towards a Full Source Bootstrap. Also ongoing is work to " "bring these bootstraps to the @code{arm-linux} and @code{aarch64-linux} " "architectures and to the Hurd." msgstr "" #. type: Plain text #: doc/guix.texi:43147 msgid "" "If you are interested, join us on @samp{#bootstrappable} on the Freenode IRC " "network or discuss on @email{bug-mes@@gnu.org} or @email{gash-devel@@nongnu." "org}." msgstr "" #. type: Plain text #: doc/guix.texi:43154 msgid "" "@image{images/bootstrap-graph,6in,,Dependency graph of the early bootstrap " "derivations}" msgstr "" #. type: Plain text #: doc/guix.texi:43159 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:43164 #, no-wrap msgid "" "guix graph -t derivation \\\n" " -e '(@@@@ (gnu packages bootstrap) %bootstrap-gcc)' \\\n" " | dot -Tps > gcc.ps\n" msgstr "" #. type: Plain text #: doc/guix.texi:43167 msgid "or, for the further Reduced Binary Seed bootstrap" msgstr "" #. type: example #: doc/guix.texi:43172 #, no-wrap msgid "" "guix graph -t derivation \\\n" " -e '(@@@@ (gnu packages bootstrap) %bootstrap-mes)' \\\n" " | dot -Tps > mes.ps\n" msgstr "" #. type: Plain text #: doc/guix.texi:43181 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:43190 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:43202 msgid "" "Once @code{guile-bootstrap-2.0.drv} is built, we have a functioning Guile " "that can be used to run subsequent build programs. Its first task is to " "download tarballs containing the other pre-built binaries---this is what the " "@file{.tar.xz.drv} derivations do. Guix modules such as @code{ftp-client." "scm} are used for this purpose. The @code{module-import.drv} derivations " "import those modules in a directory in the store, using the original " "layout. The @code{module-import-compiled.drv} derivations compile those " "modules, and write them in an output directory with the right layout. This " "corresponds to the @code{#:modules} argument of @code{build-expression-" ">derivation} (@pxref{Derivations})." msgstr "" #. type: Plain text #: doc/guix.texi:43207 msgid "" "Finally, the various tarballs are unpacked by the derivations @code{gcc-" "bootstrap-0.drv}, @code{glibc-bootstrap-0.drv}, or @code{bootstrap-mes-0." "drv} and @code{bootstrap-mescc-tools-0.drv}, at which point we have a " "working C tool chain." msgstr "" #. type: unnumberedsec #: doc/guix.texi:43208 #, no-wrap msgid "Building the Build Tools" msgstr "" #. type: Plain text #: doc/guix.texi:43217 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:43224 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:43229 #, no-wrap msgid "" "guix graph -t bag \\\n" " -e '(@@@@ (gnu packages commencement)\n" " glibc-final-with-bootstrap-bash)' | xdot -\n" msgstr "" #. type: Plain text #: doc/guix.texi:43236 msgid "" "displays the dependency graph leading to the ``final'' C " "library@footnote{You may notice the @code{glibc-intermediate} label, " "suggesting that it is not @emph{quite} final, but as a good approximation, " "we will consider it final.}, depicted below." msgstr "" #. type: Plain text #: doc/guix.texi:43238 msgid "" "@image{images/bootstrap-packages,6in,,Dependency graph of the early packages}" msgstr "" #. type: Plain text #: doc/guix.texi:43244 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:43249 msgid "" "Then come the first-stage Binutils and GCC, built as pseudo cross tools---i." "e., with @option{--target} equal to @option{--host}. They are used to build " "libc. Thanks to this cross-build trick, this libc is guaranteed not to hold " "any reference to the initial tool chain." msgstr "" #. type: Plain text #: doc/guix.texi:43255 msgid "" "From there the final Binutils and GCC (not shown above) are built. GCC uses " "@command{ld} from the final Binutils, and links programs against the just-" "built libc. This tool chain is used to build the other packages used by " "Guix and by the GNU Build System: Guile, Bash, Coreutils, etc." msgstr "" #. type: Plain text #: doc/guix.texi:43261 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: unnumberedsec #: doc/guix.texi:43263 #, no-wrap msgid "Building the Bootstrap Binaries" msgstr "" #. type: Plain text #: doc/guix.texi:43270 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:43276 msgid "" "The following command builds the tarballs containing the bootstrap binaries " "(Binutils, GCC, glibc, for the traditional bootstrap and linux-libre-" "headers, bootstrap-mescc-tools, bootstrap-mes for the Reduced Binary Seed " "bootstrap, and Guile, and a tarball containing a mixture of Coreutils and " "other basic command-line tools):" msgstr "" #. type: example #: doc/guix.texi:43279 #, no-wrap msgid "guix build bootstrap-tarballs\n" msgstr "" #. type: Plain text #: doc/guix.texi:43284 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:43290 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: unnumberedsec #: doc/guix.texi:43291 #, no-wrap msgid "Reducing the Set of Bootstrap Binaries" msgstr "" #. type: Plain text #: doc/guix.texi:43299 msgid "" "Our traditional bootstrap includes GCC, GNU Libc, Guile, etc. That's a lot " "of binary code! Why is that a problem? It's a problem because these big " "chunks of binary code are practically non-auditable, which makes it hard to " "establish what source code produced them. Every unauditable binary also " "leaves us vulnerable to compiler backdoors as described by Ken Thompson in " "the 1984 paper @emph{Reflections on Trusting Trust}." msgstr "" #. type: Plain text #: doc/guix.texi:43305 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:43311 msgid "" "The @uref{https://bootstrappable.org, Bootstrappable.org web site} lists on-" "going projects to do that. One of these is about replacing the bootstrap " "GCC with a sequence of assemblers, interpreters, and compilers of increasing " "complexity, which could be built from source starting from a simple and " "auditable assembler." msgstr "" #. type: Plain text #: doc/guix.texi:43320 msgid "" "Our first major achievement is the replacement of of GCC, the GNU C Library " "and Binutils by MesCC-Tools (a simple hex linker and macro assembler) and " "Mes (@pxref{Top, GNU Mes Reference Manual,, mes, GNU Mes}, a Scheme " "interpreter and C compiler in Scheme). Neither MesCC-Tools nor Mes can be " "fully bootstrapped yet and thus we inject them as binary seeds. We call " "this the Reduced Binary Seed bootstrap, as it has halved the size of our " "bootstrap binaries! Also, it has eliminated the C compiler binary; i686-" "linux and x86_64-linux Guix packages are now bootstrapped without any binary " "C compiler." msgstr "" #. type: Plain text #: doc/guix.texi:43323 msgid "" "Work is ongoing to make MesCC-Tools and Mes fully bootstrappable and we are " "also looking at any other bootstrap binaries. Your help is welcome!" msgstr "" #. type: chapter #: doc/guix.texi:43325 #, no-wrap msgid "Porting to a New Platform" msgstr "" #. type: Plain text #: doc/guix.texi:43334 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:43339 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:43342 #, no-wrap msgid "guix build --target=armv5tel-linux-gnueabi bootstrap-tarballs\n" msgstr "" #. type: Plain text #: doc/guix.texi:43351 msgid "" "For this to work, it is first required to register a new platform as defined " "in the @code{(guix platform)} module. A platform is making the connection " "between a GNU triplet (@pxref{Specifying Target Triplets, GNU configuration " "triplets,, autoconf, Autoconf}), the equivalent @var{system} in Nix " "notation, the name of the @var{glibc-dynamic-linker}, and the corresponding " "Linux architecture name if applicable (@pxref{Platforms})." msgstr "" #. type: Plain text #: doc/guix.texi:43360 msgid "" "Once the bootstrap tarball are built, the @code{(gnu packages bootstrap)} " "module needs to be updated to refer to these binaries on the target " "platform. That is, the hashes and URLs of the bootstrap tarballs for the " "new platform must be added alongside those of the currently supported " "platforms. The bootstrap Guile tarball is treated specially: it is expected " "to be available locally, and @file{gnu/local.mk} has rules to download it " "for the supported architectures; a rule for the new platform must be added " "as well." msgstr "" #. type: Plain text #: doc/guix.texi:43369 msgid "" "In practice, there may be some complications. First, it may be that the " "extended GNU triplet that specifies an ABI (like the @code{eabi} suffix " "above) is not recognized by all the GNU tools. Typically, glibc recognizes " "some of these, whereas GCC uses an extra @option{--with-abi} configure flag " "(see @code{gcc.scm} for examples of how to handle this). Second, some of " "the required packages could fail to build for that platform. Lastly, the " "generated binaries could be broken for some reason." msgstr "" #. type: include #: doc/guix.texi:43371 #, no-wrap msgid "contributing.texi" msgstr "" #. type: Plain text #: doc/guix.texi:43384 msgid "" "Guix is based on the @uref{https://nixos.org/nix/, Nix package manager}, " "which was designed and implemented by Eelco Dolstra, with contributions from " "other people (see the @file{nix/AUTHORS} file in Guix). Nix pioneered " "functional package management, and promoted unprecedented features, such as " "transactional package upgrades and rollbacks, per-user profiles, and " "referentially transparent build processes. Without this work, Guix would " "not exist." msgstr "" #. type: Plain text #: doc/guix.texi:43387 msgid "" "The Nix-based software distributions, Nixpkgs and NixOS, have also been an " "inspiration for Guix." msgstr "" #. type: Plain text #: doc/guix.texi:43393 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:43398 #, no-wrap msgid "license, GNU Free Documentation License" msgstr "" #. type: include #: doc/guix.texi:43399 #, no-wrap msgid "fdl-1.3.texi" msgstr "" #. 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 Libera Chat 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 "" #. type: cindex #: doc/contributing.texi:10 #, no-wrap msgid "code of conduct, of contributors" msgstr "" #. type: cindex #: doc/contributing.texi:11 #, no-wrap msgid "contributor covenant" msgstr "" #. 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{https://" "contributor-covenant.org/}. You can find a local version in the @file{CODE-" "OF-CONDUCT} file in the source tree." msgstr "" #. 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 "" #. type: section #: doc/contributing.texi:34 doc/contributing.texi:36 doc/contributing.texi:37 #, no-wrap msgid "Building from Git" msgstr "" #. type: menuentry #: doc/contributing.texi:34 msgid "The latest and greatest." msgstr "" #. type: section #: doc/contributing.texi:34 doc/contributing.texi:193 doc/contributing.texi:194 #, no-wrap msgid "Running Guix Before It Is Installed" msgstr "" #. type: menuentry #: doc/contributing.texi:34 msgid "Hacker tricks." msgstr "" #. type: section #: doc/contributing.texi:34 doc/contributing.texi:284 doc/contributing.texi:285 #, no-wrap msgid "The Perfect Setup" msgstr "" #. type: menuentry #: doc/contributing.texi:34 msgid "The right tools." msgstr "" #. type: section #: doc/contributing.texi:34 doc/contributing.texi:385 doc/contributing.texi:386 #, no-wrap msgid "Packaging Guidelines" msgstr "" #. type: menuentry #: doc/contributing.texi:34 msgid "Growing the distribution." msgstr "" #. type: section #: doc/contributing.texi:34 doc/contributing.texi:1051 #: doc/contributing.texi:1052 #, no-wrap msgid "Coding Style" msgstr "" #. type: menuentry #: doc/contributing.texi:34 msgid "Hygiene of the contributor." msgstr "" #. type: section #: doc/contributing.texi:34 doc/contributing.texi:1149 #: doc/contributing.texi:1150 #, no-wrap msgid "Submitting Patches" msgstr "" #. type: menuentry #: doc/contributing.texi:34 msgid "Share your work." msgstr "" #. type: section #: doc/contributing.texi:34 doc/contributing.texi:1587 #: doc/contributing.texi:1588 #, no-wrap msgid "Tracking Bugs and Patches" msgstr "" #. type: menuentry #: doc/contributing.texi:34 msgid "Keeping it all organized." msgstr "" #. type: section #: doc/contributing.texi:34 doc/contributing.texi:1702 #: doc/contributing.texi:1703 #, no-wrap msgid "Commit Access" msgstr "" #. type: menuentry #: doc/contributing.texi:34 msgid "Pushing to the official repository." msgstr "" #. type: section #: doc/contributing.texi:34 doc/contributing.texi:1942 #: doc/contributing.texi:1943 #, no-wrap msgid "Updating the Guix Package" msgstr "" #. type: menuentry #: doc/contributing.texi:34 msgid "Updating the Guix package definition." msgstr "" #. type: section #: doc/contributing.texi:34 doc/contributing.texi:1980 #: doc/contributing.texi:1981 #, no-wrap msgid "Writing Documentation" msgstr "" #. type: menuentry #: doc/contributing.texi:34 msgid "Improving documentation in GNU Guix." msgstr "" #. type: section #: doc/contributing.texi:34 doc/contributing.texi:2024 #: doc/contributing.texi:2025 #, no-wrap msgid "Translating Guix" msgstr "" #. type: menuentry #: doc/contributing.texi:34 msgid "Make Guix speak your native language." msgstr "" #. type: Plain text #: doc/contributing.texi:41 msgid "" "If you want to hack Guix itself, it is recommended to use the latest version " "from the Git repository:" msgstr "" #. type: example #: doc/contributing.texi:44 #, no-wrap msgid "git clone https://git.savannah.gnu.org/git/guix.git\n" msgstr "" #. type: cindex #: doc/contributing.texi:46 #, no-wrap msgid "authentication, of a Guix checkout" msgstr "" #. type: Plain text #: doc/contributing.texi:51 msgid "" "How do you ensure that you obtained a genuine copy of the repository? To do " "that, run @command{guix git authenticate}, passing it the commit and OpenPGP " "fingerprint of the @dfn{channel introduction} (@pxref{Invoking guix git " "authenticate}):" msgstr "" #. type: example #: doc/contributing.texi:58 #, no-wrap msgid "" "git fetch origin keyring:keyring\n" "guix git authenticate 9edb3f66fd807b096b48283debdcddccfea34bad \\\n" " \"BBB0 2DDF 2CEA F6A8 0D1D E643 A2A0 6DF2 A33A 54FA\"\n" msgstr "" #. type: Plain text #: doc/contributing.texi:63 msgid "" "This command completes with exit code zero on success; it prints an error " "message and exits with a non-zero code otherwise." msgstr "" #. type: Plain text #: doc/contributing.texi:70 msgid "" "As you can see, there is a chicken-and-egg problem: you first need to have " "Guix installed. Typically you would install Guix System (@pxref{System " "Installation}) or Guix on top of another distro (@pxref{Binary " "Installation}); in either case, you would verify the OpenPGP signature on " "the installation medium. This ``bootstraps'' the trust chain." msgstr "" #. type: Plain text #: doc/contributing.texi:75 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 "" #. type: example #: doc/contributing.texi:78 #, no-wrap msgid "guix shell -D guix --pure\n" msgstr "" #. type: Plain text #: doc/contributing.texi:81 msgid "@xref{Invoking guix shell}, for more information on that command." msgstr "" #. type: Plain text #: doc/contributing.texi:85 msgid "" "If you are unable to use Guix when building Guix from a checkout, the " "following are the required packages in addition to those mentioned in the " "installation instructions (@pxref{Requirements})." msgstr "" #. type: item #: doc/contributing.texi:87 #, no-wrap msgid "@url{https://gnu.org/software/autoconf/, GNU Autoconf};" msgstr "" #. type: item #: doc/contributing.texi:88 #, no-wrap msgid "@url{https://gnu.org/software/automake/, GNU Automake};" msgstr "" #. type: item #: doc/contributing.texi:89 #, no-wrap msgid "@url{https://gnu.org/software/gettext/, GNU Gettext};" msgstr "" #. type: item #: doc/contributing.texi:90 #, no-wrap msgid "@url{https://gnu.org/software/texinfo/, GNU Texinfo};" msgstr "" #. type: item #: doc/contributing.texi:91 #, no-wrap msgid "@url{https://www.graphviz.org/, Graphviz};" msgstr "" #. type: item #: doc/contributing.texi:92 #, no-wrap msgid "@url{https://www.gnu.org/software/help2man/, GNU Help2man (optional)}." msgstr "" #. type: Plain text #: doc/contributing.texi:97 msgid "" "On Guix, extra dependencies can be added by instead running @command{guix " "shell}:" msgstr "" #. type: example #: doc/contributing.texi:100 #, no-wrap msgid "guix shell -D guix help2man git strace --pure\n" msgstr "" #. type: Plain text #: doc/contributing.texi:104 msgid "" "From there you can generate the build system infrastructure using Autoconf " "and Automake:" msgstr "" #. type: example #: doc/contributing.texi:107 #, no-wrap msgid "./bootstrap\n" msgstr "" #. type: Plain text #: doc/contributing.texi:110 msgid "If you get an error like this one:" msgstr "" #. type: example #: doc/contributing.texi:113 #, no-wrap msgid "configure.ac:46: error: possibly undefined macro: PKG_CHECK_MODULES\n" msgstr "" #. type: Plain text #: doc/contributing.texi:122 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 "" #. type: example #: doc/contributing.texi:125 #, no-wrap msgid "export ACLOCAL_PATH=/usr/share/aclocal\n" msgstr "" #. type: Plain text #: doc/contributing.texi:129 msgid "" "@xref{Macro Search Path,,, automake, The GNU Automake Manual}, for more " "information." msgstr "" #. type: Plain text #: doc/contributing.texi:131 msgid "Then, run:" msgstr "" #. type: example #: doc/contributing.texi:134 #, no-wrap msgid "./configure --localstatedir=/var\n" msgstr "" #. type: Plain text #: doc/contributing.texi:141 msgid "" "... where @file{/var} is the normal @code{localstatedir} value (@pxref{The " "Store}, for information about this). Note that you will probably not run " "@command{make install} at the end (you don't have to) but it's still " "important to pass the right @code{localstatedir}." msgstr "" #. type: Plain text #: doc/contributing.texi:144 msgid "" "Finally, you can build Guix and, if you feel so inclined, run the tests " "(@pxref{Running the Test Suite}):" msgstr "" #. type: example #: doc/contributing.texi:148 #, no-wrap msgid "" "make\n" "make check\n" msgstr "" #. type: Plain text #: doc/contributing.texi:154 msgid "" "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 "" #. type: Plain text #: doc/contributing.texi:157 msgid "" "From there on, you can authenticate all the commits included in your " "checkout by running:" msgstr "" #. type: example #: doc/contributing.texi:160 doc/contributing.texi:1812 #, no-wrap msgid "make authenticate\n" msgstr "" #. type: Plain text #: doc/contributing.texi:163 msgid "" "The first run takes a couple of minutes, but subsequent runs are faster." msgstr "" #. type: Plain text #: doc/contributing.texi:169 msgid "" "Or, when your configuration for your local Git repository doesn't match the " "default one, you can provide the reference for the @code{keyring} branch " "through the variable @code{GUIX_GIT_KEYRING}. The following example assumes " "that you have a Git remote called @samp{myremote} pointing to the official " "repository:" msgstr "" #. type: example #: doc/contributing.texi:172 #, no-wrap msgid "make authenticate GUIX_GIT_KEYRING=myremote/keyring\n" msgstr "" #. type: quotation #: doc/contributing.texi:178 msgid "" "You are advised to run @command{make authenticate} after every @command{git " "pull} invocation. This ensures you keep receiving valid changes to the " "repository." msgstr "" #. type: Plain text #: doc/contributing.texi:182 msgid "" "After updating the repository, @command{make} might fail with an error " "similar to the following example:" msgstr "" #. type: example #: doc/contributing.texi:186 #, no-wrap msgid "" "error: failed to load 'gnu/packages/dunst.scm':\n" "ice-9/eval.scm:293:34: In procedure abi-check: #>: record ABI mismatch; recompilation needed\n" msgstr "" #. type: Plain text #: doc/contributing.texi:192 msgid "" "This means that one of the record types that Guix defines (in this example, " "the @code{origin} record) has changed, and all of guix needs to be " "recompiled to take that change into account. To do so, run @command{make " "clean-go} followed by @command{make}." msgstr "" #. type: Plain text #: doc/contributing.texi:200 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 "" #. type: Plain text #: doc/contributing.texi:211 msgid "" "To that end, all the command-line tools can be used even if you have not run " "@code{make install}. To do that, you first need to have an environment with " "all the dependencies available (@pxref{Building from Git}), and then simply " "prefix each command with @command{./pre-inst-env} (the @file{pre-inst-env} " "script lives in the top build tree of Guix; it is generated by running " "@command{./bootstrap} followed by @command{./configure}). As an example, " "here is how you would build the @code{hello} package as defined in your " "working tree (this assumes @command{guix-daemon} is already running on your " "system; it's OK if it's a different version):" msgstr "" #. type: example #: doc/contributing.texi:214 #, no-wrap msgid "$ ./pre-inst-env guix build hello\n" msgstr "" #. type: Plain text #: doc/contributing.texi:218 msgid "Similarly, an example for a Guile session using the Guix modules:" msgstr "" #. type: example #: doc/contributing.texi:221 #, no-wrap msgid "" "$ ./pre-inst-env guile -c '(use-modules (guix utils)) (pk (%current-system))'\n" "\n" msgstr "" #. type: example #: doc/contributing.texi:223 #, no-wrap msgid ";;; (\"x86_64-linux\")\n" msgstr "" #. type: cindex #: doc/contributing.texi:226 #, no-wrap msgid "REPL" msgstr "" #. type: cindex #: doc/contributing.texi:227 #, no-wrap msgid "read-eval-print loop" msgstr "" #. type: Plain text #: doc/contributing.texi:229 msgid "@dots{} and for a REPL (@pxref{Using Guix Interactively}):" msgstr "" #. type: example #: doc/contributing.texi:244 #, 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 "" #. type: Plain text #: doc/contributing.texi:252 msgid "" "If you are hacking on the daemon and its supporting code or if @command{guix-" "daemon} is not already running on your system, you can launch it straight " "from the build tree@footnote{The @option{-E} flag to @command{sudo} " "guarantees that @code{GUILE_LOAD_PATH} is correctly set such that " "@command{guix-daemon} and the tools it uses can find the Guile modules they " "need.}:" msgstr "" #. type: example #: doc/contributing.texi:255 #, no-wrap msgid "$ sudo -E ./pre-inst-env guix-daemon --build-users-group=guixbuild\n" msgstr "" #. type: Plain text #: doc/contributing.texi:259 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 "" #. type: Plain text #: doc/contributing.texi:264 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 "" #. type: Plain text #: doc/contributing.texi:268 msgid "" "Sometimes, especially if you have recently updated your repository, running " "@command{./pre-inst-env} will print a message similar to the following " "example:" msgstr "" #. type: example #: doc/contributing.texi:272 #, no-wrap msgid "" ";;; note: source file /home/user/projects/guix/guix/progress.scm\n" ";;; newer than compiled /home/user/projects/guix/guix/progress.go\n" msgstr "" #. type: Plain text #: doc/contributing.texi:278 msgid "" "This is only a note and you can safely ignore it. You can get rid of the " "message by running @command{make -j4}. Until you do, Guile will run " "slightly slower because it will interpret the code instead of using prepared " "Guile object (@file{.go}) files." msgstr "" #. type: Plain text #: doc/contributing.texi:283 msgid "" "You can run @command{make} automatically as you work using " "@command{watchexec} from the @code{watchexec} package. For example, to " "build again each time you update a package file, run @samp{watchexec -w gnu/" "packages -- make -j4}." msgstr "" #. type: Plain text #: doc/contributing.texi:292 msgid "" "The Perfect Setup to hack on Guix is basically the perfect setup used for " "Guile hacking (@pxref{Using Guile in Emacs,,, guile, Guile Reference " "Manual}). First, you need more than an editor, you need @url{https://www." "gnu.org/software/emacs, Emacs}, empowered by the wonderful @url{https://" "nongnu.org/geiser/, Geiser}. To set that up, run:" msgstr "" #. type: example #: doc/contributing.texi:295 #, no-wrap msgid "guix install emacs guile emacs-geiser emacs-geiser-guile\n" msgstr "" #. type: Plain text #: doc/contributing.texi:304 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 "" #. type: lisp #: doc/contributing.texi:309 #, 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 "" #. type: Plain text #: doc/contributing.texi:317 msgid "" "To actually edit the code, Emacs already has a neat Scheme mode. But in " "addition to that, you must not miss @url{https://www.emacswiki.org/emacs/" "ParEdit, Paredit}. It provides facilities to directly operate on the syntax " "tree, such as raising an s-expression or wrapping it, swallowing or " "rejecting the following s-expression, etc." msgstr "" #. type: cindex #: doc/contributing.texi:318 #, no-wrap msgid "code snippets" msgstr "" #. type: cindex #: doc/contributing.texi:319 #, no-wrap msgid "templates" msgstr "" #. type: cindex #: doc/contributing.texi:320 #, no-wrap msgid "reducing boilerplate" msgstr "" #. type: Plain text #: doc/contributing.texi:330 msgid "" "We also provide templates for common git commit messages and package " "definitions in the @file{etc/snippets} directory. These templates can be " "used to expand short trigger strings to interactive text snippets. If you " "use @url{https://joaotavora.github.io/yasnippet/, YASnippet}, you may want " "to add the @file{etc/snippets/yas} snippets directory to the @var{yas-" "snippet-dirs} variable. If you use @url{https://github.com/minad/tempel/, " "Tempel}, you may want to add the @file{etc/snippets/tempel/*} path to the " "@var{tempel-path} variable in Emacs." msgstr "" #. type: lisp #: doc/contributing.texi:342 #, no-wrap msgid "" ";; @r{Assuming the Guix checkout is in ~/src/guix.}\n" ";; @r{Yasnippet configuration}\n" "(with-eval-after-load 'yasnippet\n" " (add-to-list 'yas-snippet-dirs \"~/src/guix/etc/snippets/yas\"))\n" ";; @r{Tempel configuration}\n" "(with-eval-after-load 'tempel\n" " ;; Ensure tempel-path is a list -- it may also be a string.\n" " (unless (listp 'tempel-path)\n" " (setq tempel-path (list tempel-path)))\n" " (add-to-list 'tempel-path \"~/src/guix/etc/snippets/tempel/*\"))\n" msgstr "" #. type: Plain text #: doc/contributing.texi:350 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." msgstr "" #. type: Plain text #: doc/contributing.texi:356 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 "" #. type: cindex #: doc/contributing.texi:357 #, no-wrap msgid "insert or update copyright" msgstr "" #. type: code{#1} #: doc/contributing.texi:358 #, no-wrap msgid "M-x guix-copyright" msgstr "" #. type: code{#1} #: doc/contributing.texi:359 #, no-wrap msgid "M-x copyright-update" msgstr "" #. type: Plain text #: doc/contributing.texi:363 msgid "" "We additionally provide insertion and automatic update of a copyright in " "@file{etc/copyright.el}. You may want to set your full name, mail, and load " "a file." msgstr "" #. type: lisp #: doc/contributing.texi:369 #, no-wrap msgid "" "(setq user-full-name \"Alice Doe\")\n" "(setq user-mail-address \"alice@@mail.org\")\n" ";; @r{Assuming the Guix checkout is in ~/src/guix.}\n" "(load-file \"~/src/guix/etc/copyright.el\")\n" msgstr "" #. type: Plain text #: doc/contributing.texi:372 msgid "" "To insert a copyright at the current line invoke @code{M-x guix-copyright}." msgstr "" #. type: Plain text #: doc/contributing.texi:374 msgid "" "To update a copyright you need to specify a @code{copyright-names-regexp}." msgstr "" #. type: lisp #: doc/contributing.texi:378 #, no-wrap msgid "" "(setq copyright-names-regexp\n" " (format \"%s <%s>\" user-full-name user-mail-address))\n" msgstr "" #. type: Plain text #: doc/contributing.texi:384 msgid "" "You can check if your copyright is up to date by evaluating @code{M-x " "copyright-update}. If you want to do it automatically after each buffer " "save then add @code{(add-hook 'after-save-hook 'copyright-update)} in Emacs." msgstr "" #. type: cindex #: doc/contributing.texi:388 #, no-wrap msgid "packages, creating" msgstr "" #. type: Plain text #: doc/contributing.texi:392 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." msgstr "" #. type: Plain text #: doc/contributing.texi:400 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/contributing.texi:409 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/contributing.texi:415 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/contributing.texi:418 #, no-wrap msgid "./pre-inst-env guix build gnew --keep-failed\n" msgstr "" #. type: Plain text #: doc/contributing.texi:424 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/contributing.texi:429 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/contributing.texi:432 #, no-wrap msgid "./pre-inst-env guile -c '(use-modules (gnu packages gnew))'\n" msgstr "" #. type: Plain text #: doc/contributing.texi:439 msgid "" "Once your package builds correctly, please send us a patch " "(@pxref{Submitting Patches}). Well, if you need help, we will be happy to " "help you too. Once the patch is committed in the Guix repository, the new " "package automatically gets built on the supported platforms by @url{https://" "@value{SUBSTITUTE-SERVER-1}, our continuous integration system}." msgstr "" #. type: cindex #: doc/contributing.texi:440 #, no-wrap msgid "substituter" msgstr "" #. type: Plain text #: doc/contributing.texi:447 msgid "" "Users can obtain the new package definition simply by running @command{guix " "pull} (@pxref{Invoking guix pull}). When @code{@value{SUBSTITUTE-SERVER-1}} " "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: subsection #: doc/contributing.texi:462 doc/contributing.texi:464 #: doc/contributing.texi:465 #, no-wrap msgid "Software Freedom" msgstr "" #. type: menuentry #: doc/contributing.texi:462 msgid "What may go into the distribution." msgstr "" #. type: subsection #: doc/contributing.texi:462 doc/contributing.texi:492 #: doc/contributing.texi:493 #, no-wrap msgid "Package Naming" msgstr "" #. type: menuentry #: doc/contributing.texi:462 msgid "What's in a name?" msgstr "" #. type: subsection #: doc/contributing.texi:462 doc/contributing.texi:525 #: doc/contributing.texi:526 #, no-wrap msgid "Version Numbers" msgstr "" #. type: menuentry #: doc/contributing.texi:462 msgid "When the name is not enough." msgstr "" #. type: subsection #: doc/contributing.texi:462 doc/contributing.texi:632 #: doc/contributing.texi:633 #, no-wrap msgid "Synopses and Descriptions" msgstr "" #. type: menuentry #: doc/contributing.texi:462 msgid "Helping users find the right package." msgstr "" #. type: subsection #: doc/contributing.texi:462 doc/contributing.texi:711 #: doc/contributing.texi:712 #, no-wrap msgid "Snippets versus Phases" msgstr "" #. type: menuentry #: doc/contributing.texi:462 msgid "Whether to use a snippet, or a build phase." msgstr "" #. type: menuentry #: doc/contributing.texi:462 msgid "Your Elisp fix." msgstr "" #. type: subsection #: doc/contributing.texi:462 doc/contributing.texi:766 #: doc/contributing.texi:767 #, no-wrap msgid "Python Modules" msgstr "" #. type: menuentry #: doc/contributing.texi:462 msgid "A touch of British comedy." msgstr "" #. type: subsection #: doc/contributing.texi:462 doc/contributing.texi:862 #: doc/contributing.texi:863 #, no-wrap msgid "Perl Modules" msgstr "" #. type: menuentry #: doc/contributing.texi:462 msgid "Little pearls." msgstr "" #. type: subsection #: doc/contributing.texi:462 doc/contributing.texi:878 #: doc/contributing.texi:879 #, no-wrap msgid "Java Packages" msgstr "" #. type: menuentry #: doc/contributing.texi:462 msgid "Coffee break." msgstr "" #. type: subsection #: doc/contributing.texi:462 doc/contributing.texi:898 #: doc/contributing.texi:899 #, no-wrap msgid "Rust Crates" msgstr "" #. type: menuentry #: doc/contributing.texi:462 msgid "Beware of oxidation." msgstr "" #. type: subsection #: doc/contributing.texi:462 doc/contributing.texi:932 #: doc/contributing.texi:933 #, no-wrap msgid "Elm Packages" msgstr "" #. type: menuentry #: doc/contributing.texi:462 msgid "Trees of browser code" msgstr "" #. type: subsection #: doc/contributing.texi:462 doc/contributing.texi:1013 #: doc/contributing.texi:1014 #, no-wrap msgid "Fonts" msgstr "" #. type: menuentry #: doc/contributing.texi:462 msgid "Fond of fonts." msgstr "" #. type: cindex #: doc/contributing.texi:468 #, no-wrap msgid "free software" msgstr "" #. type: Plain text #: doc/contributing.texi:476 msgid "" "The GNU operating system has been developed so that users can have freedom " "in their computing. GNU is @dfn{free software}, meaning that users have the " "@url{https://www.gnu.org/philosophy/free-sw.html,four essential freedoms}: " "to run the program, to study and change the program in source code form, to " "redistribute exact copies, and to distribute modified versions. Packages " "found in the GNU distribution provide only software that conveys these four " "freedoms." msgstr "" #. type: Plain text #: doc/contributing.texi:482 msgid "" "In addition, the GNU distribution follow the @url{https://www.gnu.org/" "distros/free-system-distribution-guidelines.html,free software distribution " "guidelines}. Among other things, these guidelines reject non-free firmware, " "recommendations of non-free software, and discuss ways to deal with " "trademarks and patents." msgstr "" #. type: Plain text #: doc/contributing.texi:490 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/contributing.texi:495 #, no-wrap msgid "package name" msgstr "" #. type: Plain text #: doc/contributing.texi:503 msgid "" "A package actually has two names associated with it. First, there is the " "name of the @emph{Scheme variable}, the one following @code{define-public}. " "By this name, the package can be made known in the Scheme code, for instance " "as input to another package. Second, there is the string in the @code{name} " "field of a package definition. This name is used by package management " "commands such as @command{guix package} and @command{guix build}." msgstr "" #. type: Plain text #: doc/contributing.texi:508 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/contributing.texi:516 msgid "" "A noteworthy exception to this rule is when the project name is only a " "single character, or if an older maintained project with the same name " "already exists---regardless of whether it has already been packaged for " "Guix. Use common sense to make such names unambiguous and meaningful. For " "example, Guix's package for the shell called ``s'' upstream is @code{s-" "shell} and @emph{not} @code{s}. Feel free to ask your fellow hackers for " "inspiration." msgstr "" #. type: Plain text #: doc/contributing.texi:521 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/contributing.texi:523 msgid "Font package names are handled differently, @pxref{Fonts}." msgstr "" #. type: cindex #: doc/contributing.texi:528 #, no-wrap msgid "package version" msgstr "" #. type: Plain text #: doc/contributing.texi:537 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/contributing.texi:540 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/contributing.texi:542 msgid "" "For instance, the versions 2.24.20 and 3.9.12 of GTK+ may be packaged as " "follows:" msgstr "" #. type: lisp #: doc/contributing.texi:554 #, 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/contributing.texi:556 msgid "If we also wanted GTK+ 3.8.2, this would be packaged as" msgstr "" #. type: lisp #: doc/contributing.texi:562 #, no-wrap msgid "" "(define-public gtk+-3.8\n" " (package\n" " (name \"gtk+\")\n" " (version \"3.8.2\")\n" " ...))\n" msgstr "" #. type: cindex #: doc/contributing.texi:566 #, no-wrap msgid "version number, for VCS snapshots" msgstr "" #. type: Plain text #: doc/contributing.texi:572 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/contributing.texi:580 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/contributing.texi:589 #, 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/contributing.texi:599 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). There are " "helper functions for doing this for packages using @code{git-fetch} or " "@code{hg-fetch} (see below). 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: lisp #: doc/contributing.texi:616 #, 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: deffn #: doc/contributing.texi:618 #, no-wrap msgid "{Scheme Procedure} git-version @var{VERSION} @var{REVISION} @var{COMMIT}" msgstr "" #. type: deffn #: doc/contributing.texi:620 msgid "Return the version string for packages using @code{git-fetch}." msgstr "" #. type: lisp #: doc/contributing.texi:624 #, no-wrap msgid "" "(git-version \"0.2.3\" \"0\" \"93818c936ee7e2f1ba1b315578bde363a7d43d05\")\n" "@result{} \"0.2.3-0.93818c9\"\n" msgstr "" #. type: deffn #: doc/contributing.texi:627 #, no-wrap msgid "{Scheme Procedure} hg-version @var{VERSION} @var{REVISION} @var{CHANGESET}" msgstr "" #. type: deffn #: doc/contributing.texi:630 msgid "" "Return the version string for packages using @code{hg-fetch}. It works in " "the same way as @code{git-version}." msgstr "" #. type: cindex #: doc/contributing.texi:635 #, no-wrap msgid "package description" msgstr "" #. type: cindex #: doc/contributing.texi:636 #, no-wrap msgid "package synopsis" msgstr "" #. type: Plain text #: doc/contributing.texi:643 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/contributing.texi:651 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/contributing.texi:661 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/contributing.texi:669 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/contributing.texi:670 #, no-wrap msgid "Texinfo markup, in package descriptions" msgstr "" #. type: Plain text #: doc/contributing.texi:679 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 show} take " "care of rendering it appropriately." msgstr "" #. type: Plain text #: doc/contributing.texi:685 msgid "" "Synopses and descriptions are translated by volunteers @uref{https://" "translate.fedoraproject.org/projects/guix/packages, at Weblate} so that as " "many users as possible can read them in their native language. User " "interfaces search them and display them in the language specified by the " "current locale." msgstr "" #. type: Plain text #: doc/contributing.texi:690 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/contributing.texi:696 #, 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/contributing.texi:704 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: lisp #: doc/contributing.texi:709 #, 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/contributing.texi:714 #, no-wrap msgid "snippets, when to use" msgstr "" #. type: Plain text #: doc/contributing.texi:725 msgid "" "The boundary between using an origin snippet versus a build phase to modify " "the sources of a package can be elusive. Origin snippets are typically used " "to remove unwanted files such as bundled libraries, nonfree sources, or to " "apply simple substitutions. The source derived from an origin should " "produce a source that can be used to build the package on any system that " "the upstream package supports (i.e., act as the corresponding source). In " "particular, origin snippets must not embed store items in the sources; such " "patching should rather be done using build phases. Refer to the " "@code{origin} record documentation for more information (@pxref{origin " "Reference})." msgstr "" #. type: cindex #: doc/contributing.texi:729 #, no-wrap msgid "emacs, packaging" msgstr "" #. type: cindex #: doc/contributing.texi:730 #, no-wrap msgid "elisp, packaging" msgstr "" #. type: Plain text #: doc/contributing.texi:742 msgid "" "Emacs packages should preferably use the Emacs build system (@pxref{emacs-" "build-system}), for uniformity and the benefits provided by its build " "phases, such as the auto-generation of the autoloads file and the byte " "compilation of the sources. Because there is no standardized way to run a " "test suite for Emacs packages, tests are disabled by default. When a test " "suite is available, it should be enabled by setting the @code{#:tests?} " "argument to @code{#true}. By default, the command to run the test is " "@command{make check}, but any command can be specified via the @code{#:test-" "command} argument. The @code{#:test-command} argument expects a list " "containing a command and its arguments, to be invoked during the " "@code{check} phase." msgstr "" #. type: Plain text #: doc/contributing.texi:747 msgid "" "The Elisp dependencies of Emacs packages are typically provided as " "@code{propagated-inputs} when required at run time. As for other packages, " "build or test dependencies should be specified as @code{native-inputs}." msgstr "" #. type: Plain text #: doc/contributing.texi:756 msgid "" "Emacs packages sometimes depend on resources directories that should be " "installed along the Elisp files. The @code{#:include} argument can be used " "for that purpose, by specifying a list of regexps to match. The best " "practice when using the @code{#:include} argument is to extend rather than " "override its default value (accessible via the @code{%default-include} " "variable). As an example, a yasnippet extension package typically include a " "@file{snippets} directory, which could be copied to the installation " "directory using:" msgstr "" #. type: lisp #: doc/contributing.texi:759 #, no-wrap msgid "#:include (cons \"^snippets/\" %default-include)\n" msgstr "" #. type: Plain text #: doc/contributing.texi:765 msgid "" "When encountering problems, it is wise to check for the presence of the " "@code{Package-Requires} extension header in the package main source file, " "and whether any dependencies and their versions listed therein are satisfied." msgstr "" #. type: cindex #: doc/contributing.texi:769 #, no-wrap msgid "python" msgstr "" #. type: Plain text #: doc/contributing.texi:775 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/contributing.texi:782 msgid "" "Some modules are compatible with only one version of Python, others with " "both. If the package Foo is compiled with Python 3, we name it @code{python-" "foo}. If it is compiled with Python 2, we name it @code{python2-foo}. " "Packages should be added when they are necessary; we don't add Python 2 " "variants of the package unless we are going to use them." msgstr "" #. type: Plain text #: doc/contributing.texi:788 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: quotation #: doc/contributing.texi:802 msgid "" "Currently there are two different build systems for Python packages in Guix: " "@var{python-build-system} and @var{pyproject-build-system}. For the longest " "time, Python packages were built from an informally specified @file{setup." "py} file. That worked amazingly well, considering Python's success, but was " "difficult to build tooling around. As a result, a host of alternative build " "systems emerged and the community eventually settled on a @url{https://peps." "python.org/pep-0517/, formal standard} for specifying build requirements. " "@var{pyproject-build-system} is Guix's implementation of this standard. It " "is considered ``experimental'' in that it does not yet support all the " "various PEP-517 @emph{build backends}, but you are encouraged to try it for " "new Python packages and report any problems. It will eventually be " "deprecated and merged into @var{python-build-system}." msgstr "" #. type: subsubsection #: doc/contributing.texi:804 #, no-wrap msgid "Specifying Dependencies" msgstr "" #. type: cindex #: doc/contributing.texi:805 #, no-wrap msgid "inputs, for Python packages" msgstr "" #. type: Plain text #: doc/contributing.texi:812 msgid "" "Dependency information for Python packages is usually available in the " "package source tree, with varying degrees of accuracy: in the " "@file{pyproject.toml} file, the @file{setup.py} file, in @file{requirements." "txt}, or in @file{tox.ini} (the latter mostly for test dependencies)." msgstr "" #. type: Plain text #: doc/contributing.texi:818 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/contributing.texi:825 msgid "" "We currently package Python with @code{setuptools} and @code{pip} installed " "per default. This is about to change, and users are encouraged to use " "@code{python-toolchain} if they want a build environment for Python." msgstr "" #. type: itemize #: doc/contributing.texi:828 msgid "" "@command{guix lint} will warn if @code{setuptools} or @code{pip} are added " "as native-inputs because they are generally not necessary." msgstr "" #. type: itemize #: doc/contributing.texi:834 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/contributing.texi:843 msgid "" "Python packages required only at build time---e.g., those listed under " "@code{build-system.requires} in @file{pyproject.toml} or with the " "@code{setup_requires} keyword in @file{setup.py}---or dependencies only for " "testing---e.g., those in @code{tests_require} or @file{tox.ini}---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/contributing.texi:847 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/contributing.texi:852 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/contributing.texi:858 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/contributing.texi:865 #, no-wrap msgid "perl" msgstr "" #. type: Plain text #: doc/contributing.texi:876 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/contributing.texi:881 #, no-wrap msgid "java" msgstr "" #. type: Plain text #: doc/contributing.texi:884 msgid "" "Java programs standing for themselves are named as any other package, using " "the lowercase upstream name." msgstr "" #. type: Plain text #: doc/contributing.texi:890 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/contributing.texi:896 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: cindex #: doc/contributing.texi:901 #, no-wrap msgid "rust" msgstr "" #. type: Plain text #: doc/contributing.texi:904 msgid "" "Rust programs standing for themselves are named as any other package, using " "the lowercase upstream name." msgstr "" #. type: Plain text #: doc/contributing.texi:908 msgid "" "To prevent namespace collisions we prefix all other Rust packages with the " "@code{rust-} prefix. The name should be changed to lowercase as appropriate " "and dashes should remain in place." msgstr "" #. type: Plain text #: doc/contributing.texi:914 msgid "" "In the rust ecosystem it is common for multiple incompatible versions of a " "package to be used at any given time, so all package definitions should have " "a versioned suffix. The versioned suffix is the left-most non-zero digit " "(and any leading zeros, of course). This follows the ``caret'' version " "scheme intended by Cargo. Examples@: @code{rust-clap-2}, @code{rust-" "rand-0.6}." msgstr "" #. type: Plain text #: doc/contributing.texi:924 msgid "" "Because of the difficulty in reusing rust packages as pre-compiled inputs " "for other packages the Cargo build system (@pxref{Build Systems, @code{cargo-" "build-system}}) presents the @code{#:cargo-inputs} and @code{cargo-" "development-inputs} keywords as build system arguments. It would be helpful " "to think of these as similar to @code{propagated-inputs} and @code{native-" "inputs}. Rust @code{dependencies} and @code{build-dependencies} should go " "in @code{#:cargo-inputs}, and @code{dev-dependencies} should go in @code{#:" "cargo-development-inputs}. If a Rust package links to other libraries then " "the standard placement in @code{inputs} and the like should be used." msgstr "" #. type: Plain text #: doc/contributing.texi:930 msgid "" "Care should be taken to ensure the correct version of dependencies are used; " "to this end we try to refrain from skipping the tests or using @code{#:skip-" "build?} when possible. Of course this is not always possible, as the " "package may be developed for a different Operating System, depend on " "features from the Nightly Rust compiler, or the test suite may have " "atrophied since it was released." msgstr "" #. type: cindex #: doc/contributing.texi:935 #, no-wrap msgid "Elm" msgstr "" #. type: Plain text #: doc/contributing.texi:938 msgid "" "Elm applications can be named like other software: their names need not " "mention Elm." msgstr "" #. type: Plain text #: doc/contributing.texi:944 msgid "" "Packages in the Elm sense (see @code{elm-build-system} under @ref{Build " "Systems}) are required use names of the format @var{author}@code{/}" "@var{project}, where both the @var{author} and the @var{project} may contain " "hyphens internally, and the @var{author} sometimes contains uppercase " "letters." msgstr "" #. type: Plain text #: doc/contributing.texi:948 msgid "" "To form the Guix package name from the upstream name, we follow a convention " "similar to Python packages (@pxref{Python Modules}), adding an @code{elm-} " "prefix unless the name would already begin with @code{elm-}." msgstr "" #. type: Plain text #: doc/contributing.texi:955 msgid "" "In many cases we can reconstruct an Elm package's upstream name " "heuristically, but, since conversion to a Guix-style name involves a loss of " "information, this is not always possible. Care should be taken to add the " "@code{'upstream-name} property when necessary so that @samp{guix import elm} " "will work correctly (@pxref{Invoking guix import}). The most notable " "scenarios when explicitly specifying the upstream name is necessary are:" msgstr "" #. type: enumerate #: doc/contributing.texi:960 msgid "" "When the @var{author} is @code{elm} and the @var{project} contains one or " "more hyphens, as with @code{elm/virtual-dom}; and" msgstr "" #. type: enumerate #: doc/contributing.texi:967 msgid "" "When the @var{author} contains hyphens or uppercase letters, as with " "@code{Elm-Canvas/raster-shapes}---unless the @var{author} is @code{elm-" "explorations}, which is handled as a special case, so packages like " "@code{elm-explorations/markdown} do @emph{not} need to use the " "@code{'upstream-name} property." msgstr "" #. type: Plain text #: doc/contributing.texi:971 msgid "" "The module @code{(guix build-system elm)} provides the following utilities " "for working with names and related conventions:" msgstr "" #. type: deffn #: doc/contributing.texi:972 #, no-wrap msgid "{Scheme procedure} elm-package-origin @var{elm-name} @var{version} @" msgstr "" #. type: deffn #: doc/contributing.texi:977 msgid "" "@var{hash} Returns a Git origin using the repository naming and tagging " "regime required for a published Elm package with the upstream name @var{elm-" "name} at version @var{version} with sha256 checksum @var{hash}." msgstr "" #. type: lisp #: doc/contributing.texi:989 #, no-wrap msgid "" "(package\n" " (name \"elm-html\")\n" " (version \"1.0.0\")\n" " (source\n" " (elm-package-origin\n" " \"elm/html\"\n" " version\n" " (base32 \"15k1679ja57vvlpinpv06znmrxy09lbhzfkzdc89i01qa8c4gb4a\")))\n" " ...)\n" msgstr "" #. type: deffn #: doc/contributing.texi:992 #, no-wrap msgid "{Scheme procedure} elm->package-name @var{elm-name}" msgstr "" #. type: deffn #: doc/contributing.texi:995 msgid "" "Returns the Guix-style package name for an Elm package with upstream name " "@var{elm-name}." msgstr "" #. type: deffn #: doc/contributing.texi:998 msgid "" "Note that there is more than one possible @var{elm-name} for which @code{elm-" ">package-name} will produce a given result." msgstr "" #. type: deffn #: doc/contributing.texi:1000 #, no-wrap msgid "{Scheme procedure} guix-package->elm-name @var{package}" msgstr "" #. type: deffn #: doc/contributing.texi:1004 msgid "" "Given an Elm @var{package}, returns the possibly-inferred upstream name, or " "@code{#f} the upstream name is not specified via the @code{'upstream-name} " "property and can not be inferred by @code{infer-elm-package-name}." msgstr "" #. type: deffn #: doc/contributing.texi:1006 #, no-wrap msgid "{Scheme procedure} infer-elm-package-name @var{guix-name}" msgstr "" #. type: deffn #: doc/contributing.texi:1011 msgid "" "Given the @var{guix-name} of an Elm package, returns the inferred upstream " "name, or @code{#f} if the upstream name can't be inferred. If the result is " "not @code{#f}, supplying it to @code{elm->package-name} would produce " "@var{guix-name}." msgstr "" #. type: Plain text #: doc/contributing.texi:1022 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/contributing.texi:1026 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/contributing.texi:1034 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/contributing.texi:1043 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/contributing.texi:1049 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: Plain text #: doc/contributing.texi:1057 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 "" #. type: subsection #: doc/contributing.texi:1063 doc/contributing.texi:1065 #: doc/contributing.texi:1066 #, no-wrap msgid "Programming Paradigm" msgstr "" #. type: menuentry #: doc/contributing.texi:1063 msgid "How to compose your elements." msgstr "" #. type: subsection #: doc/contributing.texi:1063 doc/contributing.texi:1072 #: doc/contributing.texi:1073 #, no-wrap msgid "Modules" msgstr "" #. type: menuentry #: doc/contributing.texi:1063 msgid "Where to store your code?" msgstr "" #. type: subsection #: doc/contributing.texi:1063 doc/contributing.texi:1083 #: doc/contributing.texi:1084 #, no-wrap msgid "Data Types and Pattern Matching" msgstr "" #. type: menuentry #: doc/contributing.texi:1063 msgid "Implementing data structures." msgstr "" #. type: subsection #: doc/contributing.texi:1063 doc/contributing.texi:1103 #: doc/contributing.texi:1104 #, no-wrap msgid "Formatting Code" msgstr "" #. type: menuentry #: doc/contributing.texi:1063 msgid "Writing conventions." msgstr "" #. type: Plain text #: doc/contributing.texi:1071 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 "" #. type: Plain text #: doc/contributing.texi:1079 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 "" #. type: Plain text #: doc/contributing.texi:1082 msgid "" "Modules that deal with the broader GNU system should be in the @code{(gnu " "@dots{})} name space rather than @code{(guix @dots{})}." msgstr "" #. type: Plain text #: doc/contributing.texi:1091 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 "" #. type: findex #: doc/contributing.texi:1092 #, no-wrap msgid "define-record-type*" msgstr "" #. type: findex #: doc/contributing.texi:1093 #, no-wrap msgid "match-record" msgstr "" #. type: cindex #: doc/contributing.texi:1094 #, no-wrap msgid "pattern matching" msgstr "" #. type: Plain text #: doc/contributing.texi:1102 msgid "" "Guix code should define appropriate data types (for instance, using " "@code{define-record-type*}) rather than abuse lists. In addition, it should " "use pattern matching, via Guile’s @code{(ice-9 match)} module, especially " "when matching lists (@pxref{Pattern Matching,,, guile, GNU Guile Reference " "Manual}); pattern matching for records is better done using @code{match-" "record} from @code{(guix records)}, which, unlike @code{match}, verifies " "field names at macro-expansion time." msgstr "" #. type: cindex #: doc/contributing.texi:1106 #, no-wrap msgid "formatting code" msgstr "" #. type: cindex #: doc/contributing.texi:1107 #, no-wrap msgid "coding style" msgstr "" #. type: Plain text #: doc/contributing.texi:1114 msgid "" "When writing Scheme code, we follow common wisdom among Scheme programmers. " "In general, we follow the @url{https://mumble.net/~campbell/scheme/style." "txt, Riastradh's Lisp Style Rules}. This document happens to describe the " "conventions mostly used in Guile’s code too. It is very thoughtful and well " "written, so please do read it." msgstr "" #. type: Plain text #: doc/contributing.texi:1121 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 "" #. type: cindex #: doc/contributing.texi:1122 #, no-wrap msgid "indentation, of code" msgstr "" #. type: cindex #: doc/contributing.texi:1123 #, no-wrap msgid "formatting, of code" msgstr "" #. type: Plain text #: doc/contributing.texi:1126 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 "" #. type: example #: doc/contributing.texi:1129 #, no-wrap msgid "./pre-inst-env guix style @var{package}\n" msgstr "" #. type: Plain text #: doc/contributing.texi:1133 msgid "@xref{Invoking guix style}, for more information." msgstr "" #. type: cindex #: doc/contributing.texi:1134 #, no-wrap msgid "Vim, Scheme code editing" msgstr "" #. type: Plain text #: doc/contributing.texi:1140 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 "" #. type: Plain text #: doc/contributing.texi:1144 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 "" #. type: Plain text #: doc/contributing.texi:1147 msgid "" "Procedures should not have more than four positional parameters. Use " "keyword parameters for procedures that take more than four parameters." msgstr "" #. type: Plain text #: doc/contributing.texi:1161 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 (@pxref{Submitting " "patches to a project,,, git, Git User Manual}). Contributors are encouraged " "to take a moment to set some Git repository options (@pxref{Configuring " "Git}) first, which can improve the readability of patches. Seasoned Guix " "developers may also want to look at the section on commit access " "(@pxref{Commit Access})." msgstr "" #. type: Plain text #: doc/contributing.texi:1168 msgid "" "This mailing list is backed by a Debbugs instance, which allows us to keep " "track of submissions (@pxref{Tracking Bugs and Patches}). Each message sent " "to that mailing list gets a new tracking number assigned; people can then " "follow up on the submission by sending email to @code{@var{ISSUE_NUMBER}" "@@debbugs.gnu.org}, where @var{ISSUE_NUMBER} is the tracking number " "(@pxref{Sending a Patch Series})." msgstr "" #. type: Plain text #: doc/contributing.texi:1172 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 "" #. type: Plain text #: doc/contributing.texi:1175 msgid "" "Before submitting a patch that adds or modifies a package definition, please " "run through this check list:" msgstr "" #. type: enumerate #: doc/contributing.texi:1182 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 "" #. type: enumerate #: doc/contributing.texi:1186 msgid "" "Take some time to provide an adequate synopsis and description for the " "package. @xref{Synopses and Descriptions}, for some guidelines." msgstr "" #. type: enumerate #: doc/contributing.texi:1191 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 "" #. type: enumerate #: doc/contributing.texi:1195 msgid "" "Run @code{guix style @var{package}} to format the new package definition " "according to the project's conventions (@pxref{Invoking guix style})." msgstr "" #. type: enumerate #: doc/contributing.texi:1199 msgid "" "Make sure the package builds on your platform, using @code{guix build " "@var{package}}." msgstr "" #. type: enumerate #: doc/contributing.texi:1207 msgid "" "We recommend you also try building the package on other supported " "platforms. As you may not have access to actual hardware platforms, we " "recommend using the @code{qemu-binfmt-service-type} to emulate them. In " "order to enable it, add the @code{virtualization} service module and the " "following service to the list of services in your @code{operating-system} " "configuration:" msgstr "" #. type: lisp #: doc/contributing.texi:1212 #, no-wrap msgid "" "(service qemu-binfmt-service-type\n" " (qemu-binfmt-configuration\n" " (platforms (lookup-qemu-platforms \"arm\" \"aarch64\"))))\n" msgstr "" #. type: enumerate #: doc/contributing.texi:1215 msgid "Then reconfigure your system." msgstr "" #. type: enumerate #: doc/contributing.texi:1220 msgid "" "You can then build packages for different platforms by specifying the " "@code{--system} option. For example, to build the \"hello\" package for the " "armhf or aarch64 architectures, you would run the following commands, " "respectively:" msgstr "" #. type: example #: doc/contributing.texi:1223 #, no-wrap msgid "" "guix build --system=armhf-linux --rounds=2 hello\n" "guix build --system=aarch64-linux --rounds=2 hello\n" msgstr "" #. type: cindex #: doc/contributing.texi:1226 #, no-wrap msgid "bundling" msgstr "" #. type: enumerate #: doc/contributing.texi:1229 msgid "" "Make sure the package does not use bundled copies of software already " "available as separate packages." msgstr "" #. type: enumerate #: doc/contributing.texi:1238 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 "" #. type: enumerate #: doc/contributing.texi:1247 msgid "" "Take a look at the profile reported by @command{guix size} (@pxref{Invoking " "guix size}). This will allow you to notice references to other packages " "unwillingly retained. It may also help determine whether to split the " "package (@pxref{Packages with Multiple Outputs}), and which optional " "dependencies should be used. In particular, avoid adding @code{texlive} as " "a dependency: because of its extreme size, use the @code{texlive-tiny} " "package or @code{texlive-union} procedure instead." msgstr "" #. type: enumerate #: doc/contributing.texi:1252 msgid "" "For important changes, check that dependent packages (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 "" #. type: cindex #: doc/contributing.texi:1254 #, no-wrap msgid "branching strategy" msgstr "" #. type: cindex #: doc/contributing.texi:1255 #, no-wrap msgid "rebuild scheduling strategy" msgstr "" #. type: enumerate #: doc/contributing.texi:1258 msgid "" "Depending on the number of dependent packages and thus the amount of " "rebuilding induced, commits go to different branches, along these lines:" msgstr "" #. type: item #: doc/contributing.texi:1260 #, no-wrap msgid "300 dependent packages or less" msgstr "" #. type: table #: doc/contributing.texi:1262 msgid "@code{master} branch (non-disruptive changes)." msgstr "" #. type: item #: doc/contributing.texi:1263 #, no-wrap msgid "between 300 and 1,800 dependent packages" msgstr "" #. type: table #: doc/contributing.texi:1269 msgid "" "@code{staging} branch (non-disruptive changes). This branch is intended to " "be merged in @code{master} every 6 weeks or so. Topical changes (e.g., an " "update of the GNOME stack) can instead go to a specific branch (say, " "@code{gnome-updates}). This branch is not expected to be buildable or " "usable until late in its development process." msgstr "" #. type: item #: doc/contributing.texi:1270 #, no-wrap msgid "more than 1,800 dependent packages" msgstr "" #. type: table #: doc/contributing.texi:1275 msgid "" "@code{core-updates} branch (may include major and potentially disruptive " "changes). This branch is intended to be merged in @code{master} every 6 " "months or so. This branch is not expected to be buildable or usable until " "late in its development process." msgstr "" #. type: enumerate #: doc/contributing.texi:1282 msgid "" "All these branches are @uref{https://@value{SUBSTITUTE-SERVER-1}, 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 "" #. type: enumerate #: doc/contributing.texi:1291 msgid "" "When we decide to start building the @code{staging} or @code{core-updates} " "branches, they will be forked and renamed with the suffix @code{-frozen}, at " "which time only bug fixes may be pushed to the frozen branches. The " "@code{core-updates} and @code{staging} branches will remain open to accept " "patches for the next cycle. Please ask on the mailing list or IRC if unsure " "where to place a patch." msgstr "" #. type: cindex #: doc/contributing.texi:1293 #, no-wrap msgid "determinism, of build processes" msgstr "" #. type: cindex #: doc/contributing.texi:1294 #, no-wrap msgid "reproducible builds, checking" msgstr "" #. type: enumerate #: doc/contributing.texi:1298 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 "" #. type: enumerate #: doc/contributing.texi:1301 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 "" #. type: example #: doc/contributing.texi:1304 #, no-wrap msgid "guix build --rounds=2 my-package\n" msgstr "" #. type: enumerate #: doc/contributing.texi:1308 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 "" #. type: enumerate #: doc/contributing.texi:1318 msgid "" "Another option is to use @command{guix challenge} (@pxref{Invoking guix " "challenge}). You may run it once the package has been committed and built " "by @code{@value{SUBSTITUTE-SERVER-1}} 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 "" #. type: enumerate #: doc/contributing.texi:1324 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 "" #. type: enumerate #: doc/contributing.texi:1328 msgid "" "Verify that your patch contains only one set of related changes. Bundling " "unrelated changes together makes reviewing harder and slower." msgstr "" #. type: enumerate #: doc/contributing.texi:1331 msgid "" "Examples of unrelated changes include the addition of several packages, or a " "package update along with fixes to that package." msgstr "" #. type: enumerate #: doc/contributing.texi:1336 msgid "" "Please follow our code formatting rules, possibly running @command{guix " "style} script to do that automatically for you (@pxref{Formatting Code})." msgstr "" #. type: enumerate #: doc/contributing.texi:1344 msgid "" "When possible, use mirrors in the source URL (@pxref{Invoking guix " "download}). Use reliable URLs, not generated ones. For instance, GitHub " "archives are not necessarily identical from one generation to the next, so " "in this case it's often better to clone the repository. Don't use the " "@command{name} field in the URL: it is not very useful and if the name " "changes, the URL will probably be wrong." msgstr "" #. type: enumerate #: doc/contributing.texi:1348 msgid "" "Check if Guix builds (@pxref{Building from Git}) and address the warnings, " "especially those about use of undefined symbols." msgstr "" #. type: enumerate #: doc/contributing.texi:1351 msgid "" "Make sure your changes do not break Guix and simulate a @code{guix pull} " "with:" msgstr "" #. type: example #: doc/contributing.texi:1353 #, no-wrap msgid "guix pull --url=/path/to/your/checkout --profile=/tmp/guix.master\n" msgstr "" #. type: Plain text #: doc/contributing.texi:1361 msgid "" "When posting a patch to the mailing list, use @samp{[PATCH] @dots{}} as a " "subject, if your patch is to be applied on a branch other than " "@code{master}, say @code{core-updates}, specify it in the subject like " "@samp{[PATCH core-updates] @dots{}}." msgstr "" #. type: Plain text #: doc/contributing.texi:1367 msgid "" "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 "" #. type: Plain text #: doc/contributing.texi:1372 msgid "" "Expect some delay when you submit your very first patch to @email{guix-" "patches@@gnu.org}. You have to wait until you get an acknowledgement with " "the assigned tracking number. Future acknowledgements should not be delayed." msgstr "" #. type: Plain text #: doc/contributing.texi:1375 msgid "" "When a bug is resolved, please close the thread by sending an email to " "@email{@var{ISSUE_NUMBER}-done@@debbugs.gnu.org}." msgstr "" #. type: subsection #: doc/contributing.texi:1376 doc/contributing.texi:1377 #, no-wrap msgid "Configuring Git" msgstr "" #. type: cindex #: doc/contributing.texi:1378 #, no-wrap msgid "git configuration" msgstr "" #. type: code{#1} #: doc/contributing.texi:1379 doc/contributing.texi:1416 #, no-wrap msgid "git format-patch" msgstr "" #. type: code{#1} #: doc/contributing.texi:1380 doc/contributing.texi:1415 #, no-wrap msgid "git send-email" msgstr "" #. type: Plain text #: doc/contributing.texi:1388 msgid "" "If you have not done so already, you may wish to set a name and email that " "will be associated with your commits (@pxref{telling git your name, , " "Telling Git your name, git, Git User Manual}). If you wish to use a " "different name or email just for commits in this repository, you can use " "@command{git config --local}, or edit @file{.git/config} in the repository " "instead of @file{~/.gitconfig}." msgstr "" #. type: Plain text #: doc/contributing.texi:1394 msgid "" "We provide some default settings in @file{etc/git/gitconfig} which modify " "how patches are generated, making them easier to read and apply. These " "settings can be applied by manually copying them to @file{.git/config} in " "your checkout, or by telling Git to include the whole file:" msgstr "" #. type: example #: doc/contributing.texi:1397 #, no-wrap msgid "git config --local include.path ../etc/git/gitconfig\n" msgstr "" #. type: Plain text #: doc/contributing.texi:1401 msgid "" "From then on, any changes to @file{etc/git/gitconfig} would automatically " "take effect." msgstr "" #. type: Plain text #: doc/contributing.texi:1406 msgid "" "Since the first patch in a series must be sent separately (@pxref{Sending a " "Patch Series}), it can also be helpful to tell @command{git format-patch} to " "handle the e-mail threading instead of @command{git send-email}:" msgstr "" #. type: example #: doc/contributing.texi:1410 #, no-wrap msgid "" "git config --local format.thread shallow\n" "git config --local sendemail.thread no\n" msgstr "" #. type: subsection #: doc/contributing.texi:1412 doc/contributing.texi:1413 #, no-wrap msgid "Sending a Patch Series" msgstr "" #. type: cindex #: doc/contributing.texi:1414 #, no-wrap msgid "patch series" msgstr "" #. type: anchor{#1} #: doc/contributing.texi:1418 doc/contributing.texi:1425 #, no-wrap msgid "Single Patches" msgstr "" #. type: Plain text #: doc/contributing.texi:1425 msgid "" "The @command{git send-email} command is the best way to send both single " "patches and patch series (@pxref{Multiple Patches}) to the Guix mailing " "list. Sending patches as email attachments may make them difficult to " "review in some mail clients, and @command{git diff} does not store commit " "metadata." msgstr "" #. type: quotation #: doc/contributing.texi:1429 msgid "" "The @command{git send-email} command is provided by the @code{send-email} " "output of the @code{git} package, i.e. @code{git:send-email}." msgstr "" #. type: Plain text #: doc/contributing.texi:1434 msgid "" "The following command will create a patch email from the latest commit, open " "it in your @var{EDITOR} or @var{VISUAL} for editing, and send it to the Guix " "mailing list to be reviewed and merged:" msgstr "" #. type: example #: doc/contributing.texi:1437 #, no-wrap msgid "$ git send-email -1 -a --base=auto --to=guix-patches@@gnu.org\n" msgstr "" #. type: quotation #: doc/contributing.texi:1445 msgid "" "To add a prefix to the subject of your patch, you may use the @option{--" "subject-prefix} option. The Guix project uses this to specify that the " "patch is intended for a branch or repository other than the @code{master} " "branch of @url{https://git.savannah.gnu.org/cgit/guix.git}." msgstr "" #. type: example #: doc/contributing.texi:1450 #, no-wrap msgid "" "git send-email -1 -a --base=auto \\\n" " --subject-prefix='PATCH core-updates' \\\n" " --to=guix-patches@@gnu.org\n" msgstr "" #. type: Plain text #: doc/contributing.texi:1457 msgid "" "The patch email contains a three-dash separator line after the commit " "message. You may ``annotate'' the patch with explanatory text by adding it " "under this line. If you do not wish to annotate the email, you may drop the " "@option{-a} flag (which is short for @option{--annotate})." msgstr "" #. type: Plain text #: doc/contributing.texi:1461 msgid "" "The @option{--base=auto} flag automatically adds a note at the bottom of the " "patch of the commit it was based on, making it easier for maintainers to " "rebase and merge your patch." msgstr "" #. type: Plain text #: doc/contributing.texi:1467 msgid "" "If you need to send a revised patch, don't resend it like this or send a " "``fix'' patch to be applied on top of the last one; instead, use " "@command{git commit -a} or @url{https://git-rebase.io, @command{git rebase}} " "to modify the commit, and use the @email{@var{ISSUE_NUMBER}@@debbugs.gnu." "org} address and the @option{-v} flag with @command{git send-email}." msgstr "" #. type: example #: doc/contributing.texi:1472 #, no-wrap msgid "" "$ git commit -a\n" "$ git send-email -1 -a --base=auto -v @var{REVISION} \\\n" " --to=@var{ISSUE_NUMBER}@@debbugs.gnu.org\n" msgstr "" #. type: Plain text #: doc/contributing.texi:1478 msgid "" "You can find out @var{ISSUE_NUMBER} either by searching on the mumi " "interface at @url{issues.guix.gnu.org} for the name of your patch or reading " "the acknowledgement email sent automatically by Debbugs in reply to incoming " "bugs and patches, which contains the bug number." msgstr "" #. type: anchor{#1} #: doc/contributing.texi:1479 doc/contributing.texi:1481 #, no-wrap msgid "Notifying Teams" msgstr "" #. type: cindex #: doc/contributing.texi:1481 doc/contributing.texi:1552 #, no-wrap msgid "teams" msgstr "" #. type: Plain text #: doc/contributing.texi:1490 msgid "" "The @file{etc/teams.scm} script may be used to notify all those who may be " "interested in your patch of its existence (@pxref{Teams}). Use @command{etc/" "teams.scm list-teams} to display all the teams, decide which team(s) your " "patch relates to, and use @command{etc/teams.scm cc} to output various " "@command{git send-email} flags which will notify the appropriate team " "members, or use @command{etc/teams.scm cc-members} to detect the appropriate " "teams automatically." msgstr "" #. type: anchor{#1} #: doc/contributing.texi:1491 doc/contributing.texi:1493 #, no-wrap msgid "Multiple Patches" msgstr "" #. type: cindex #: doc/contributing.texi:1493 #, no-wrap msgid "cover letter" msgstr "" #. type: Plain text #: doc/contributing.texi:1499 msgid "" "While @command{git send-email} alone will suffice for a single patch, an " "unfortunate flaw in Debbugs means you need to be more careful when sending " "multiple patches: if you send them all to the @email{guix-patches@@gnu.org} " "address, a new issue will be created for each patch!" msgstr "" #. type: Plain text #: doc/contributing.texi:1505 msgid "" "When sending a series of patches, it's best to send a Git ``cover letter'' " "first, to give reviewers an overview of the patch series. We can create a " "directory called @file{outgoing} containing both our patch series and a " "cover letter called @file{0000-cover-letter.patch} with @command{git format-" "patch}." msgstr "" #. type: example #: doc/contributing.texi:1509 #, no-wrap msgid "" "$ git format-patch -@var{NUMBER_COMMITS} -o outgoing \\\n" " --cover-letter --base=auto\n" msgstr "" #. type: Plain text #: doc/contributing.texi:1514 msgid "" "We can now send @emph{just} the cover letter to the @email{guix-patches@@gnu." "org} address, which will create an issue that we can send the rest of the " "patches to." msgstr "" #. type: example #: doc/contributing.texi:1520 #, no-wrap msgid "" "$ git send-email outgoing/0000-cover-letter.patch -a \\\n" " --to=guix-patches@@debbugs.gnu.org \\\n" " $(etc/teams.scm cc-members ...)\n" "$ rm outgoing/0000-cover-letter.patch # we don't want to resend it!\n" msgstr "" #. type: Plain text #: doc/contributing.texi:1525 msgid "" "Ensure you edit the email to add an appropriate subject line and blurb " "before sending it. Note the automatically generated shortlog and diffstat " "below the blurb." msgstr "" #. type: Plain text #: doc/contributing.texi:1528 msgid "" "Once the Debbugs mailer has replied to your cover letter email, you can send " "the actual patches to the newly-created issue address." msgstr "" #. type: example #: doc/contributing.texi:1534 #, no-wrap msgid "" "$ git send-email outgoing/*.patch \\\n" " --to=@var{ISSUE_NUMBER}@@debbugs.gnu.org \\\n" " $(etc/teams.scm cc-members ...)\n" "$ rm -rf outgoing # we don't need these anymore\n" msgstr "" #. type: Plain text #: doc/contributing.texi:1539 msgid "" "Thankfully, this @command{git format-patch} dance is not necessary to send " "an amended patch series, since an issue already exists for the patchset." msgstr "" #. type: example #: doc/contributing.texi:1544 #, no-wrap msgid "" "$ git send-email -@var{NUMBER_COMMITS} \\\n" " -v@var{REVISION} --base=auto \\\n" " --to @var{ISSUE_NUMBER}@@debbugs.gnu.org\n" msgstr "" #. type: Plain text #: doc/contributing.texi:1549 msgid "" "If need be, you may use @option{--cover-letter -a} to send another cover " "letter, e.g. for explaining what's changed since the last revision, and " "these changes are necessary." msgstr "" #. type: subsection #: doc/contributing.texi:1550 doc/contributing.texi:1551 #, no-wrap msgid "Teams" msgstr "" #. type: Plain text #: doc/contributing.texi:1556 msgid "" "There are several teams mentoring different parts of the Guix source code. " "To list all those teams, you can run from a Guix checkout:" msgstr "" #. type: example #: doc/contributing.texi:1569 #, no-wrap msgid "" "$ ./etc/teams.scm list-teams\n" "id: mentors\n" "name: Mentors\n" "description: A group of mentors who chaperone contributions by newcomers.\n" "members:\n" "+ Christopher Baines \n" "+ Ricardo Wurmus \n" "+ Mathieu Othacehe \n" "+ jgart \n" "+ Ludovic Courtès \n" "@dots{}\n" msgstr "" #. type: Plain text #: doc/contributing.texi:1573 msgid "" "You can run the following command to have the @code{Mentors} team put in CC " "of a patch series:" msgstr "" #. type: example #: doc/contributing.texi:1576 #, no-wrap msgid "$ git send-email --to @var{ISSUE_NUMBER}@@debbugs.gnu.org $(./etc/teams.scm cc mentors) *.patch\n" msgstr "" #. type: Plain text #: doc/contributing.texi:1581 msgid "" "The appropriate team or teams can also be inferred from the modified files. " "For instance, if you want to send the two latest commits of the current Git " "repository to review, you can run:" msgstr "" #. type: example #: doc/contributing.texi:1585 #, no-wrap msgid "" "$ guix shell -D guix\n" "[env]$ git send-email --to @var{ISSUE_NUMBER}@@debbugs.gnu.org $(./etc/teams.scm cc-members HEAD~2 HEAD) *.patch\n" msgstr "" #. type: Plain text #: doc/contributing.texi:1592 msgid "" "This section describes how the Guix project tracks its bug reports and patch " "submissions." msgstr "" #. type: subsection #: doc/contributing.texi:1597 doc/contributing.texi:1599 #: doc/contributing.texi:1600 #, no-wrap msgid "The Issue Tracker" msgstr "" #. type: menuentry #: doc/contributing.texi:1597 msgid "The official bug and patch tracker." msgstr "" #. type: subsection #: doc/contributing.texi:1597 doc/contributing.texi:1613 #: doc/contributing.texi:1614 #, no-wrap msgid "Debbugs User Interfaces" msgstr "" #. type: menuentry #: doc/contributing.texi:1597 msgid "Ways to interact with Debbugs." msgstr "" #. type: subsection #: doc/contributing.texi:1597 doc/contributing.texi:1653 #: doc/contributing.texi:1654 #, no-wrap msgid "Debbugs Usertags" msgstr "" #. type: menuentry #: doc/contributing.texi:1597 msgid "Tag reports with custom labels." msgstr "" #. type: cindex #: doc/contributing.texi:1602 #, no-wrap msgid "bug reports, tracking" msgstr "" #. type: cindex #: doc/contributing.texi:1603 #, no-wrap msgid "patch submissions, tracking" msgstr "" #. type: cindex #: doc/contributing.texi:1604 #, no-wrap msgid "issue tracking" msgstr "" #. type: cindex #: doc/contributing.texi:1605 #, no-wrap msgid "Debbugs, issue tracking system" msgstr "" #. type: Plain text #: doc/contributing.texi:1612 msgid "" "Bug reports and patch submissions are currently tracked using the Debbugs " "instance at @uref{https://bugs.gnu.org}. Bug reports are filed against the " "@code{guix} ``package'' (in Debbugs parlance), by sending email to " "@email{bug-guix@@gnu.org}, while patch submissions are filed against the " "@code{guix-patches} package by sending email to @email{guix-patches@@gnu." "org} (@pxref{Submitting Patches})." msgstr "" #. type: Plain text #: doc/contributing.texi:1618 msgid "" "A web interface (actually @emph{two} web interfaces!) are available to " "browse issues:" msgstr "" #. type: itemize #: doc/contributing.texi:1627 msgid "" "@url{https://issues.guix.gnu.org} provides a pleasant interface@footnote{The " "web interface at @url{https://issues.guix.gnu.org} is powered by Mumi, a " "nice piece of software written in Guile, and you can help! See @url{https://" "git.elephly.net/gitweb.cgi?p=software/mumi.git}.} to browse bug reports and " "patches, and to participate in discussions;" msgstr "" #. type: itemize #: doc/contributing.texi:1629 msgid "@url{https://bugs.gnu.org/guix} lists bug reports;" msgstr "" #. type: itemize #: doc/contributing.texi:1631 msgid "@url{https://bugs.gnu.org/guix-patches} lists patch submissions." msgstr "" #. type: Plain text #: doc/contributing.texi:1636 msgid "" "To view discussions related to issue number @var{n}, go to " "@indicateurl{https://issues.guix.gnu.org/@var{n}} or @indicateurl{https://" "bugs.gnu.org/@var{n}}." msgstr "" #. type: Plain text #: doc/contributing.texi:1639 msgid "" "If you use Emacs, you may find it more convenient to interact with issues " "using @file{debbugs.el}, which you can install with:" msgstr "" #. type: example #: doc/contributing.texi:1642 #, no-wrap msgid "guix install emacs-debbugs\n" msgstr "" #. type: Plain text #: doc/contributing.texi:1645 msgid "For example, to list all open issues on @code{guix-patches}, hit:" msgstr "" #. type: example #: doc/contributing.texi:1648 #, no-wrap msgid "@kbd{C-u} @kbd{M-x} debbugs-gnu @kbd{RET} @kbd{RET} guix-patches @kbd{RET} n y\n" msgstr "" #. type: Plain text #: doc/contributing.texi:1652 msgid "" "@xref{Top,,, debbugs-ug, Debbugs User Guide}, for more information on this " "nifty tool!" msgstr "" #. type: cindex #: doc/contributing.texi:1656 #, no-wrap msgid "usertags, for debbugs" msgstr "" #. type: cindex #: doc/contributing.texi:1657 #, no-wrap msgid "Debbugs usertags" msgstr "" #. type: Plain text #: doc/contributing.texi:1663 msgid "" "Debbugs provides a feature called @dfn{usertags} that allows any user to tag " "any bug with an arbitrary label. Bugs can be searched by usertag, so this " "is a handy way to organize bugs@footnote{The list of usertags is public " "information, and anyone can modify any user's list of usertags, so keep that " "in mind if you choose to use this feature.}." msgstr "" #. type: Plain text #: doc/contributing.texi:1669 msgid "" "For example, to view all the bug reports (or patches, in the case of " "@code{guix-patches}) tagged with the usertag @code{powerpc64le-linux} for " "the user @code{guix}, open a URL like the following in a web browser: " "@url{https://debbugs.gnu.org/cgi-bin/pkgreport.cgi?tag=powerpc64le-linux;" "users=guix}." msgstr "" #. type: Plain text #: doc/contributing.texi:1673 msgid "" "For more information on how to use usertags, please refer to the " "documentation for Debbugs or the documentation for whatever tool you use to " "interact with Debbugs." msgstr "" #. type: Plain text #: doc/contributing.texi:1678 msgid "" "In Guix, we are experimenting with usertags to keep track of architecture-" "specific issues. To facilitate collaboration, all our usertags are " "associated with the single user @code{guix}. The following usertags " "currently exist for that user:" msgstr "" #. type: table #: doc/contributing.texi:1689 msgid "" "The purpose of this usertag is to make it easy to find the issues that " "matter most for the @code{powerpc64le-linux} system type. Please assign " "this usertag to bugs or patches that affect @code{powerpc64le-linux} but not " "other system types. In addition, you may use it to identify issues that for " "some reason are particularly important for the @code{powerpc64le-linux} " "system type, even if the issue affects other system types, too." msgstr "" #. type: table #: doc/contributing.texi:1694 msgid "" "For issues related to reproducibility. For example, it would be appropriate " "to assign this usertag to a bug report for a package that fails to build " "reproducibly." msgstr "" #. type: Plain text #: doc/contributing.texi:1701 msgid "" "If you're a committer and you want to add a usertag, just start using it " "with the @code{guix} user. If the usertag proves useful to you, consider " "updating this section of the manual so that others will know what your " "usertag means." msgstr "" #. type: cindex #: doc/contributing.texi:1705 #, no-wrap msgid "commit access, for developers" msgstr "" #. type: Plain text #: doc/contributing.texi:1716 msgid "" "Everyone can contribute to Guix without having commit access " "(@pxref{Submitting Patches}). However, for frequent contributors, having " "write access to the repository can be convenient. As a rule of thumb, a " "contributor should have accumulated fifty (50) reviewed commits to be " "considered as a committer and have sustained their activity in the project " "for at least 6 months. This ensures enough interactions with the " "contributor, which is essential for mentoring and assessing whether they are " "ready to become a committer. Commit access should not be thought of as a " "``badge of honor'' but rather as a responsibility a contributor is willing " "to take to help the project." msgstr "" #. type: Plain text #: doc/contributing.texi:1720 msgid "" "The following sections explain how to get commit access, how to be ready to " "push commits, and the policies and community expectations for commits pushed " "upstream." msgstr "" #. type: subsection #: doc/contributing.texi:1721 #, no-wrap msgid "Applying for Commit Access" msgstr "" #. type: Plain text #: doc/contributing.texi:1725 msgid "" "When you deem it necessary, consider applying for commit access by following " "these steps:" msgstr "" #. type: enumerate #: doc/contributing.texi:1734 msgid "" "Find three committers who would vouch for you. You can view the list of " "committers at @url{https://savannah.gnu.org/project/memberlist.php?" "group=guix}. Each of them should email a statement to @email{guix-" "maintainers@@gnu.org} (a private alias for the collective of maintainers), " "signed with their OpenPGP key." msgstr "" #. type: enumerate #: doc/contributing.texi:1740 msgid "" "Committers are expected to have had some interactions with you as a " "contributor and to be able to judge whether you are sufficiently familiar " "with the project's practices. It is @emph{not} a judgment on the value of " "your work, so a refusal should rather be interpreted as ``let's try again " "later''." msgstr "" #. type: enumerate #: doc/contributing.texi:1747 msgid "" "Send @email{guix-maintainers@@gnu.org} a message stating your intent, " "listing the three committers who support your application, signed with the " "OpenPGP key you will use to sign commits, and giving its fingerprint (see " "below). See @uref{https://emailselfdefense.fsf.org/en/}, for an " "introduction to public-key cryptography with GnuPG." msgstr "" #. type: enumerate #: doc/contributing.texi:1753 msgid "" "Set up GnuPG such that it never uses the SHA1 hash algorithm for digital " "signatures, which is known to be unsafe since 2019, for instance by adding " "the following line to @file{~/.gnupg/gpg.conf} (@pxref{GPG Esoteric " "Options,,, gnupg, The GNU Privacy Guard Manual}):" msgstr "" #. type: example #: doc/contributing.texi:1756 #, no-wrap msgid "digest-algo sha512\n" msgstr "" #. type: enumerate #: doc/contributing.texi:1761 msgid "" "Maintainers ultimately decide whether to grant you commit access, usually " "following your referrals' recommendation." msgstr "" #. type: cindex #: doc/contributing.texi:1763 #, no-wrap msgid "OpenPGP, signed commits" msgstr "" #. type: enumerate #: doc/contributing.texi:1768 msgid "" "If and once you've been given access, please send a message to @email{guix-" "devel@@gnu.org} to say so, again signed with the OpenPGP key you will use to " "sign commits (do that before pushing your first commit). That way, everyone " "can notice and ensure you control that OpenPGP key." msgstr "" #. type: quotation #: doc/contributing.texi:1771 msgid "Before you can push for the first time, maintainers must:" msgstr "" #. type: enumerate #: doc/contributing.texi:1775 msgid "add your OpenPGP key to the @code{keyring} branch;" msgstr "" #. type: enumerate #: doc/contributing.texi:1778 msgid "" "add your OpenPGP fingerprint to the @file{.guix-authorizations} file of the " "branch(es) you will commit to." msgstr "" #. type: enumerate #: doc/contributing.texi:1783 msgid "Make sure to read the rest of this section and... profit!" msgstr "" #. type: quotation #: doc/contributing.texi:1789 msgid "" "Maintainers are happy to give commit access to people who have been " "contributing for some time and have a track record---don't be shy and don't " "underestimate your work!" msgstr "" #. type: quotation #: doc/contributing.texi:1793 msgid "" "However, note that the project is working towards a more automated patch " "review and merging system, which, as a consequence, may lead us to have " "fewer people with commit access to the main repository. Stay tuned!" msgstr "" #. type: Plain text #: doc/contributing.texi:1800 msgid "" "All commits that are pushed to the central repository on Savannah must be " "signed with an OpenPGP key, and the public key should be uploaded to your " "user account on Savannah and to public key servers, such as @code{keys." "openpgp.org}. To configure Git to automatically sign commits, run:" msgstr "" #. type: example #: doc/contributing.texi:1803 #, no-wrap msgid "" "git config commit.gpgsign true\n" "\n" msgstr "" #. type: example #: doc/contributing.texi:1806 #, no-wrap msgid "" "# Substitute the fingerprint of your public PGP key.\n" "git config user.signingkey CABBA6EA1DC0FF33\n" msgstr "" #. type: Plain text #: doc/contributing.texi:1809 msgid "To check that commits are signed with correct key, use:" msgstr "" #. type: Plain text #: doc/contributing.texi:1817 msgid "" "You can prevent yourself from accidentally pushing unsigned or signed with " "the wrong key commits to Savannah by using the pre-push Git hook located at " "@file{etc/git/pre-push}:" msgstr "" #. type: example #: doc/contributing.texi:1820 #, no-wrap msgid "cp etc/git/pre-push .git/hooks/pre-push\n" msgstr "" #. type: Plain text #: doc/contributing.texi:1824 msgid "" "It additionally calls @code{make check-channel-news} to be sure @file{news." "scm} file is correct." msgstr "" #. type: subsection #: doc/contributing.texi:1825 #, no-wrap msgid "Commit Policy" msgstr "" #. type: Plain text #: doc/contributing.texi:1830 msgid "" "If you get commit access, please make sure to follow the policy below " "(discussions of the policy can take place on @email{guix-devel@@gnu.org})." msgstr "" #. type: Plain text #: doc/contributing.texi:1835 msgid "" "Non-trivial patches should always be posted to @email{guix-patches@@gnu.org} " "(trivial patches include fixing typos, etc.). This mailing list fills the " "patch-tracking database (@pxref{Tracking Bugs and Patches})." msgstr "" #. type: Plain text #: doc/contributing.texi:1844 msgid "" "For patches that just add a new package, and a simple one, it's OK to " "commit, if you're confident (which means you successfully built it in a " "chroot setup, and have done a reasonable copyright and license auditing). " "Likewise for package upgrades, except upgrades that trigger a lot of " "rebuilds (for example, upgrading GnuTLS or GLib). We have a mailing list " "for commit notifications (@email{guix-commits@@gnu.org}), so people can " "notice. Before pushing your changes, make sure to run @code{git pull --" "rebase}." msgstr "" #. type: Plain text #: doc/contributing.texi:1849 msgid "" "When pushing a commit on behalf of somebody else, please add a @code{Signed-" "off-by} line at the end of the commit log message---e.g., with @command{git " "am --signoff}. This improves tracking of who did what." msgstr "" #. type: Plain text #: doc/contributing.texi:1853 msgid "" "When adding channel news entries (@pxref{Channels, Writing Channel News}), " "make sure they are well-formed by running the following command right before " "pushing:" msgstr "" #. type: example #: doc/contributing.texi:1856 #, no-wrap msgid "make check-channel-news\n" msgstr "" #. type: Plain text #: doc/contributing.texi:1862 msgid "" "For anything else, please post to @email{guix-patches@@gnu.org} and leave " "time for a review, without committing anything (@pxref{Submitting " "Patches}). If you didn’t receive any reply after two weeks, and if you're " "confident, it's OK to commit." msgstr "" #. type: Plain text #: doc/contributing.texi:1865 msgid "" "That last part is subject to being adjusted, allowing individuals to commit " "directly on non-controversial changes on parts they’re familiar with." msgstr "" #. type: subsection #: doc/contributing.texi:1866 #, no-wrap msgid "Addressing Issues" msgstr "" #. type: Plain text #: doc/contributing.texi:1877 msgid "" "Peer review (@pxref{Submitting Patches}) and tools such as @command{guix " "lint} (@pxref{Invoking guix lint}) and the test suite (@pxref{Running the " "Test Suite}) should catch issues before they are pushed. Yet, commits that " "``break'' functionality might occasionally go through. When that happens, " "there are two priorities: mitigating the impact, and understanding what " "happened to reduce the chance of similar incidents in the future. The " "responsibility for both these things primarily lies with those involved, but " "like everything this is a group effort." msgstr "" #. type: Plain text #: doc/contributing.texi:1882 msgid "" "Some issues can directly affect all users---for instance because they make " "@command{guix pull} fail or break core functionality, because they break " "major packages (at build time or run time), or because they introduce known " "security vulnerabilities." msgstr "" #. type: cindex #: doc/contributing.texi:1883 #, no-wrap msgid "reverting commits" msgstr "" #. type: Plain text #: doc/contributing.texi:1889 msgid "" "The people involved in authoring, reviewing, and pushing such commit(s) " "should be at the forefront to mitigate their impact in a timely fashion: by " "pushing a followup commit to fix it (if possible), or by reverting it to " "leave time to come up with a proper fix, and by communicating with other " "developers about the problem." msgstr "" #. type: Plain text #: doc/contributing.texi:1895 msgid "" "If these persons are unavailable to address the issue in time, other " "committers are entitled to revert the commit(s), explaining in the commit " "log and on the mailing list what the problem was, with the goal of leaving " "time to the original committer, reviewer(s), and author(s) to propose a way " "forward." msgstr "" #. type: Plain text #: doc/contributing.texi:1904 msgid "" "Once the problem has been dealt with, it is the responsibility of those " "involved to make sure the situation is understood. If you are working to " "understand what happened, focus on gathering information and avoid assigning " "any blame. Do ask those involved to describe what happened, do not ask them " "to explain the situation---this would implicitly blame them, which is " "unhelpful. Accountability comes from a consensus about the problem, " "learning from it and improving processes so that it's less likely to reoccur." msgstr "" #. type: subsection #: doc/contributing.texi:1905 #, no-wrap msgid "Commit Revocation" msgstr "" #. type: Plain text #: doc/contributing.texi:1912 msgid "" "In order to reduce the possibility of mistakes, committers will have their " "Savannah account removed from the Guix Savannah project and their key " "removed from @file{.guix-authorizations} after 12 months of inactivity; they " "can ask to regain commit access by emailing the maintainers, without going " "through the vouching process." msgstr "" #. type: Plain text #: doc/contributing.texi:1922 msgid "" "Maintainers@footnote{See @uref{https://guix.gnu.org/en/about} for the " "current list of maintainers. You can email them privately at @email{guix-" "maintainers@@gnu.org}.} may also revoke an individual's commit rights, as a " "last resort, if cooperation with the rest of the community has caused too " "much friction---even within the bounds of the project's code of conduct " "(@pxref{Contributing}). They would only do so after public or private " "discussion with the individual and a clear notice. Examples of behavior " "that hinders cooperation and could lead to such a decision include:" msgstr "" #. type: item #: doc/contributing.texi:1924 #, no-wrap msgid "repeated violation of the commit policy stated above;" msgstr "" #. type: item #: doc/contributing.texi:1925 #, no-wrap msgid "repeated failure to take peer criticism into account;" msgstr "" #. type: item #: doc/contributing.texi:1926 #, no-wrap msgid "breaching trust through a series of grave incidents." msgstr "" #. type: Plain text #: doc/contributing.texi:1933 msgid "" "When maintainers resort to such a decision, they notify developers on " "@email{guix-devel@@gnu.org}; inquiries may be sent to @email{guix-" "maintainers@@gnu.org}. Depending on the situation, the individual may still " "be welcome to contribute." msgstr "" #. type: subsection #: doc/contributing.texi:1934 #, no-wrap msgid "Helping Out" msgstr "" #. type: Plain text #: doc/contributing.texi:1941 msgid "" "One last thing: the project keeps moving forward because committers not only " "push their own awesome changes, but also offer some of their time " "@emph{reviewing} and pushing other people's changes. As a committer, you're " "welcome to use your expertise and commit rights to help other contributors, " "too!" msgstr "" #. type: cindex #: doc/contributing.texi:1945 #, no-wrap msgid "update-guix-package, updating the guix package" msgstr "" #. type: Plain text #: doc/contributing.texi:1951 msgid "" "It is sometimes desirable to update the @code{guix} package itself (the " "package defined in @code{(gnu packages package-management)}), for example to " "make new daemon features available for use by the @code{guix-service-type} " "service type. In order to simplify this task, the following command can be " "used:" msgstr "" #. type: example #: doc/contributing.texi:1954 #, no-wrap msgid "make update-guix-package\n" msgstr "" #. type: Plain text #: doc/contributing.texi:1961 msgid "" "The @code{update-guix-package} make target will use the last known " "@emph{commit} corresponding to @code{HEAD} in your Guix checkout, compute " "the hash of the Guix sources corresponding to that commit and update the " "@code{commit}, @code{revision} and hash of the @code{guix} package " "definition." msgstr "" #. type: Plain text #: doc/contributing.texi:1965 msgid "" "To validate that the updated @code{guix} package hashes are correct and that " "it can be built successfully, the following command can be run from the " "directory of your Guix checkout:" msgstr "" #. type: example #: doc/contributing.texi:1968 #, no-wrap msgid "./pre-inst-env guix build guix\n" msgstr "" #. type: Plain text #: doc/contributing.texi:1973 msgid "" "To guard against accidentally updating the @code{guix} package to a commit " "that others can't refer to, a check is made that the commit used has already " "been pushed to the Savannah-hosted Guix git repository." msgstr "" #. type: Plain text #: doc/contributing.texi:1978 msgid "" "This check can be disabled, @emph{at your own peril}, by setting the " "@code{GUIX_ALLOW_ME_TO_USE_PRIVATE_COMMIT} environment variable. When this " "variable is set, the updated package source is also added to the store. " "This is used as part of the release process of Guix." msgstr "" #. type: Plain text #: doc/contributing.texi:1986 msgid "" "Guix is documented using the Texinfo system. If you are not yet familiar " "with it, we accept contributions for documentation in most formats. That " "includes plain text, Markdown, Org, etc." msgstr "" #. type: Plain text #: doc/contributing.texi:1990 msgid "" "Documentation contributions can be sent to @email{guix-patches@@gnu.org}. " "Prepend @samp{[DOCUMENTATION]} to the subject." msgstr "" #. type: Plain text #: doc/contributing.texi:1995 msgid "" "When you need to make more than a simple addition to the documentation, we " "prefer that you send a proper patch as opposed to sending an email as " "described above. @xref{Submitting Patches} for more information on how to " "send your patches." msgstr "" #. type: Plain text #: doc/contributing.texi:2004 msgid "" "To modify the documentation, you need to edit @file{doc/guix.texi} and " "@file{doc/contributing.texi} (which contains this documentation section), or " "@file{doc/guix-cookbook.texi} for the cookbook. If you compiled the Guix " "repository before, you will have many more @file{.texi} files that are " "translations of these documents. Do not modify them, the translation is " "managed through @uref{https://translate.fedoraproject.org/projects/guix, " "Weblate}. @xref{Translating Guix} for more information." msgstr "" #. type: Plain text #: doc/contributing.texi:2009 msgid "" "To render documentation, you must first make sure that you ran @command{./" "configure} in your source tree (@pxref{Running Guix Before It Is " "Installed}). After that you can run one of the following commands:" msgstr "" #. type: item #: doc/contributing.texi:2011 #, no-wrap msgid "@samp{make doc/guix.info} to compile the Info manual." msgstr "" #. type: itemize #: doc/contributing.texi:2013 msgid "You can check it with @command{info doc/guix.info}." msgstr "" #. type: item #: doc/contributing.texi:2013 #, no-wrap msgid "@samp{make doc/guix.html} to compile the HTML version." msgstr "" #. type: itemize #: doc/contributing.texi:2016 msgid "" "You can point your browser to the relevant file in the @file{doc/guix.html} " "directory." msgstr "" #. type: item #: doc/contributing.texi:2016 #, no-wrap msgid "@samp{make doc/guix-cookbook.info} for the cookbook Info manual." msgstr "" #. type: item #: doc/contributing.texi:2017 #, no-wrap msgid "@samp{make doc/guix-cookbook.html} for the cookbook HTML version." msgstr "" #. type: cindex #: doc/contributing.texi:2020 #, no-wrap msgid "translation" msgstr "" #. type: cindex #: doc/contributing.texi:2021 #, no-wrap msgid "l10n" msgstr "" #. type: cindex #: doc/contributing.texi:2022 #, no-wrap msgid "i18n" msgstr "" #. type: cindex #: doc/contributing.texi:2023 #, no-wrap msgid "native language support" msgstr "" #. type: Plain text #: doc/contributing.texi:2033 msgid "" "Writing code and packages is not the only way to provide a meaningful " "contribution to Guix. Translating to a language you speak is another " "example of a valuable contribution you can make. This section is designed " "to describe the translation process. It gives you advice on how you can get " "involved, what can be translated, what mistakes you should avoid and what we " "can do to help you!" msgstr "" #. type: Plain text #: doc/contributing.texi:2039 msgid "" "Guix is a big project that has multiple components that can be translated. " "We coordinate the translation effort on a @uref{https://translate." "fedoraproject.org/projects/guix/,Weblate instance} hosted by our friends at " "Fedora. You will need an account to submit translations." msgstr "" #. type: Plain text #: doc/contributing.texi:2046 msgid "" "Some of the software packaged in Guix also contain translations. We do not " "host a translation platform for them. If you want to translate a package " "provided by Guix, you should contact their developers or find the " "information on their website. As an example, you can find the homepage of " "the @code{hello} package by typing @code{guix show hello}. On the " "``homepage'' line, you will see @url{https://www.gnu.org/software/hello/} as " "the homepage." msgstr "" #. type: Plain text #: doc/contributing.texi:2051 msgid "" "Many GNU and non-GNU packages can be translated on the @uref{https://" "translationproject.org,Translation Project}. Some projects with multiple " "components have their own platform. For instance, GNOME has its own " "platform, @uref{https://l10n.gnome.org/,Damned Lies}." msgstr "" #. type: Plain text #: doc/contributing.texi:2053 msgid "Guix has five components hosted on Weblate." msgstr "" #. type: item #: doc/contributing.texi:2055 #, no-wrap msgid "@code{guix} contains all the strings from the Guix software (the" msgstr "" #. type: itemize #: doc/contributing.texi:2057 msgid "guided system installer, the package manager, etc), excluding packages." msgstr "" #. type: item #: doc/contributing.texi:2057 #, no-wrap msgid "@code{packages} contains the synopsis (single-sentence description" msgstr "" #. type: itemize #: doc/contributing.texi:2059 msgid "of a package) and description (longer description) of packages in Guix." msgstr "" #. type: item #: doc/contributing.texi:2059 #, no-wrap msgid "@code{website} contains the official Guix website, except for" msgstr "" #. type: itemize #: doc/contributing.texi:2061 msgid "blog posts and multimedia content." msgstr "" #. type: item #: doc/contributing.texi:2061 #, no-wrap msgid "@code{documentation-manual} corresponds to this manual." msgstr "" #. type: item #: doc/contributing.texi:2062 #, no-wrap msgid "@code{documentation-cookbook} is the component for the cookbook." msgstr "" #. type: subsubheading #: doc/contributing.texi:2065 #, no-wrap msgid "General Directions" msgstr "" #. type: Plain text #: doc/contributing.texi:2073 msgid "" "Once you get an account, you should be able to select a component from " "@uref{https://translate.fedoraproject.org/projects/guix/,the guix project}, " "and select a language. If your language does not appear in the list, go to " "the bottom and click on the ``Start new translation'' button. Select the " "language you want to translate to from the list, to start your new " "translation." msgstr "" #. type: Plain text #: doc/contributing.texi:2078 msgid "" "Like lots of other free software packages, Guix uses @uref{https://www.gnu." "org/software/gettext,GNU Gettext} for its translations, with which " "translatable strings are extracted from the source code to so-called PO " "files." msgstr "" #. type: Plain text #: doc/contributing.texi:2089 msgid "" "Even though PO files are text files, changes should not be made with a text " "editor but with PO editing software. Weblate integrates PO editing " "functionality. Alternatively, translators can use any of various free-" "software tools for filling in translations, of which @uref{https://poedit." "net/,Poedit} is one example, and (after logging in) @uref{https://docs." "weblate.org/en/latest/user/files.html,upload} the changed file. There is " "also a special @uref{https://www.emacswiki.org/emacs/PoMode,PO editing mode} " "for users of GNU Emacs. Over time translators find out what software they " "are happy with and what features they need." msgstr "" #. type: Plain text #: doc/contributing.texi:2094 msgid "" "On Weblate, you will find various links to the editor, that will show " "various subsets (or all) of the strings. Have a look around and at the " "@uref{https://docs.weblate.org/en/latest/,documentation} to familiarize " "yourself with the platform." msgstr "" #. type: subsubheading #: doc/contributing.texi:2095 #, no-wrap msgid "Translation Components" msgstr "" #. type: Plain text #: doc/contributing.texi:2100 msgid "" "In this section, we provide more detailed guidance on the translation " "process, as well as details on what you should or should not do. When in " "doubt, please contact us, we will be happy to help!" msgstr "" #. type: table #: doc/contributing.texi:2107 msgid "" "Guix is written in the Guile programming language, and some strings contain " "special formatting that is interpreted by Guile. These special formatting " "should be highlighted by Weblate. They start with @code{~} followed by one " "or more characters." msgstr "" #. type: table #: doc/contributing.texi:2116 msgid "" "When printing the string, Guile replaces the special formatting symbols with " "actual values. For instance, the string @samp{ambiguous package " "specification `~a'} would be substituted to contain said package " "specification instead of @code{~a}. To properly translate this string, you " "must keep the formatting code in your translation, although you can place it " "where it makes sense in your language. For instance, the French translation " "says @samp{spécification du paquet « ~a » ambiguë} because the adjective " "needs to be placed in the end of the sentence." msgstr "" #. type: table #: doc/contributing.texi:2120 msgid "" "If there are multiple formatting symbols, make sure to respect the order. " "Guile does not know in which order you intended the string to be read, so it " "will substitute the symbols in the same order as the English sentence." msgstr "" #. type: table #: doc/contributing.texi:2128 msgid "" "As an example, you cannot translate @samp{package '~a' has been superseded " "by '~a'} by @samp{'~a' superseeds package '~a'}, because the meaning would " "be reversed. If @var{foo} is superseded by @var{bar}, the translation would " "read @samp{'foo' superseeds package 'bar'}. To work around this problem, it " "is possible to use more advanced formatting to select a given piece of data, " "instead of following the default English order. @xref{Formatted Output,,, " "guile, GNU Guile Reference Manual}, for more information on formatting in " "Guile." msgstr "" #. type: table #: doc/contributing.texi:2134 msgid "" "Package descriptions occasionally contain Texinfo markup (@pxref{Synopses " "and Descriptions}). Texinfo markup looks like @samp{@@code@{rm -rf@}}, " "@samp{@@emph@{important@}}, etc. When translating, please leave markup as " "is." msgstr "" #. type: table #: doc/contributing.texi:2143 msgid "" "The characters after ``@@'' form the name of the markup, and the text " "between ``@{'' and ``@}'' is its content. In general, you should not " "translate the content of markup like @code{@@code}, as it contains literal " "code that do not change with language. You can translate the content of " "formatting markup such as @code{@@emph}, @code{@@i}, @code{@@itemize}, " "@code{@@item}. However, do not translate the name of the markup, or it will " "not be recognized. Do not translate the word after @code{@@end}, it is the " "name of the markup that is closed at this position (e.g.@: " "@code{@@itemize ... @@end itemize})." msgstr "" #. type: item #: doc/contributing.texi:2144 #, no-wrap msgid "documentation-manual and documentation-cookbook" msgstr "" #. type: table #: doc/contributing.texi:2148 msgid "" "The first step to ensure a successful translation of the manual is to find " "and translate the following strings @emph{first}:" msgstr "" #. type: item #: doc/contributing.texi:2150 #, no-wrap msgid "@code{version.texi}: Translate this string as @code{version-xx.texi}," msgstr "" #. type: itemize #: doc/contributing.texi:2153 msgid "" "where @code{xx} is your language code (the one shown in the URL on weblate)." msgstr "" #. type: item #: doc/contributing.texi:2153 #, no-wrap msgid "@code{contributing.texi}: Translate this string as" msgstr "" #. type: itemize #: doc/contributing.texi:2155 msgid "@code{contributing.xx.texi}, where @code{xx} is the same language code." msgstr "" #. type: item #: doc/contributing.texi:2155 #, no-wrap msgid "@code{Top}: Do not translate this string, it is important for Texinfo." msgstr "" #. type: itemize #: doc/contributing.texi:2158 msgid "" "If you translate it, the document will be empty (missing a Top node). " "Please look for it, and register @code{Top} as its translation." msgstr "" #. type: table #: doc/contributing.texi:2163 msgid "" "Translating these strings first ensure we can include your translation in " "the guix repository without breaking the make process or the @command{guix " "pull} machinery." msgstr "" #. type: table #: doc/contributing.texi:2170 msgid "" "The manual and the cookbook both use Texinfo. As for @code{packages}, " "please keep Texinfo markup as is. There are more possible markup types in " "the manual than in the package descriptions. In general, do not translate " "the content of @code{@@code}, @code{@@file}, @code{@@var}, @code{@@value}, " "etc. You should translate the content of formatting markup such as " "@code{@@emph}, @code{@@i}, etc." msgstr "" #. type: table #: doc/contributing.texi:2178 msgid "" "The manual contains sections that can be referred to by name by " "@code{@@ref}, @code{@@xref} and @code{@@pxref}. We have a mechanism in " "place so you do not have to translate their content. If you keep the " "English title, we will automatically replace it with your translation of " "that title. This ensures that Texinfo will always be able to find the node. " "If you decide to change the translation of the title, the references will " "automatically be updated and you will not have to update them all yourself." msgstr "" #. type: table #: doc/contributing.texi:2188 msgid "" "When translating references from the cookbook to the manual, you need to " "replace the name of the manual and the name of the section. For instance, " "to translate @code{@@pxref@{Defining Packages,,, guix, GNU Guix Reference " "Manual@}}, you would replace @code{Defining Packages} with the title of that " "section in the translated manual @emph{only} if that title is translated. " "If the title is not translated in your language yet, do not translate it " "here, or the link will be broken. Replace @code{guix} with @code{guix.xx} " "where @code{xx} is your language code. @code{GNU Guix Reference Manual} is " "the text of the link. You can translate it however you wish." msgstr "" #. type: item #: doc/contributing.texi:2189 #, no-wrap msgid "website" msgstr "" #. type: table #: doc/contributing.texi:2196 msgid "" "The website pages are written using SXML, an s-expression version of HTML, " "the basic language of the web. We have a process to extract translatable " "strings from the source, and replace complex s-expressions with a more " "familiar XML markup, where each markup is numbered. Translators can " "arbitrarily change the ordering, as in the following example." msgstr "" #. type: example #: doc/contributing.texi:2203 #, no-wrap msgid "" "#. TRANSLATORS: Defining Packages is a section name\n" "#. in the English (en) manual.\n" "#: apps/base/templates/about.scm:64\n" "msgid \"Packages are <1>defined<1.1>en<1.2>Defining-Packages.html as native <2>Guile modules.\"\n" "msgstr \"Pakete werden als reine <2>Guile-Module <1>definiert<1.1>de<1.2>Pakete-definieren.html.\"\n" msgstr "" #. type: table #: doc/contributing.texi:2206 msgid "Note that you need to include the same markups. You cannot skip any." msgstr "" #. type: Plain text #: doc/contributing.texi:2214 msgid "" "In case you make a mistake, the component might fail to build properly with " "your language, or even make guix pull fail. To prevent that, we have a " "process in place to check the content of the files before pushing to our " "repository. We will not be able to update the translation for your language " "in Guix, so we will notify you (through weblate and/or by email) so you get " "a chance to fix the issue." msgstr "" #. type: subsubheading #: doc/contributing.texi:2215 #, no-wrap msgid "Outside of Weblate" msgstr "" #. type: Plain text #: doc/contributing.texi:2218 msgid "" "Currently, some parts of Guix cannot be translated on Weblate, help wanted!" msgstr "" #. type: item #: doc/contributing.texi:2220 #, no-wrap msgid "@command{guix pull} news can be translated in @file{news.scm}, but is not" msgstr "" #. type: itemize #: doc/contributing.texi:2226 msgid "" "available from Weblate. If you want to provide a translation, you can " "prepare a patch as described above, or simply send us your translation with " "the name of the news entry you translated and your language. @xref{Writing " "Channel News}, for more information about channel news." msgstr "" #. type: item #: doc/contributing.texi:2226 #, no-wrap msgid "Guix blog posts cannot currently be translated." msgstr "" #. type: item #: doc/contributing.texi:2227 #, no-wrap msgid "The installer script (for foreign distributions) is entirely in English." msgstr "" #. type: item #: doc/contributing.texi:2228 #, no-wrap msgid "Some of the libraries Guix uses cannot be translated or are translated" msgstr "" #. type: itemize #: doc/contributing.texi:2230 msgid "outside of the Guix project. Guile itself is not internationalized." msgstr "" #. type: item #: doc/contributing.texi:2230 #, no-wrap msgid "Other manuals linked from this manual or the cookbook might not be" msgstr "" #. type: itemize #: doc/contributing.texi:2232 msgid "translated." msgstr "" #. type: subsubheading #: doc/contributing.texi:2234 #, no-wrap msgid "Conditions for Inclusion" msgstr "" #. type: Plain text #: doc/contributing.texi:2241 msgid "" "There are no conditions for adding new translations of the @code{guix} and " "@code{guix-packages} components, other than they need at least one " "translated string. New languages will be added to Guix as soon as " "possible. The files may be removed if they fall out of sync and have no " "more translated strings." msgstr "" #. type: Plain text #: doc/contributing.texi:2247 msgid "" "Given that the web site is dedicated to new users, we want its translation " "to be as complete as possible before we include it in the language menu. " "For a new language to be included, it needs to reach at least 80% " "completion. When a language is included, it may be removed in the future if " "it stays out of sync and falls below 60% completion." msgstr "" #. type: Plain text #: doc/contributing.texi:2255 msgid "" "The manual and cookbook are automatically added in the default compilation " "target. Every time we synchronize translations, developers need to " "recompile all the translated manuals and cookbooks. This is useless for " "what is essentially the English manual or cookbook. Therefore, we will only " "include a new language when it reaches 10% completion in the component. " "When a language is included, it may be removed in the future if it stays out " "of sync and falls below 5% completion." msgstr "" #. type: subsubheading #: doc/contributing.texi:2256 #, no-wrap msgid "Translation Infrastructure" msgstr "" #. type: Plain text #: doc/contributing.texi:2267 msgid "" "Weblate is backed by a git repository from which it discovers new strings to " "translate and pushes new and updated translations. Normally, it would be " "enough to give it commit access to our repositories. However, we decided to " "use a separate repository for two reasons. First, we would have to give " "Weblate commit access and authorize its signing key, but we do not trust it " "in the same way we trust guix developers, especially since we do not manage " "the instance ourselves. Second, if translators mess something up, it can " "break the generation of the website and/or guix pull for all our users, " "independently of their language." msgstr "" #. type: Plain text #: doc/contributing.texi:2271 msgid "" "For these reasons, we use a dedicated repository to host translations, and " "we synchronize it with our guix and artworks repositories after checking no " "issue was introduced in the translation." msgstr "" #. type: Plain text #: doc/contributing.texi:2277 msgid "" "Developers can download the latest PO files from weblate in the Guix " "repository by running the @command{make download-po} command. It will " "automatically download the latest files from weblate, reformat them to a " "canonical form, and check they do not contain issues. The manual needs to " "be built again to check for additional issues that might crash Texinfo." msgstr "" #. type: Plain text #: doc/contributing.texi:2281 msgid "" "Before pushing new translation files, developers should add them to the make " "machinery so the translations are actually available. The process differs " "for the various components." msgstr "" #. type: item #: doc/contributing.texi:2283 #, no-wrap msgid "New po files for the @code{guix} and @code{packages} components must" msgstr "" #. type: itemize #: doc/contributing.texi:2286 msgid "" "be registered by adding the new language to @file{po/guix/LINGUAS} or " "@file{po/packages/LINGUAS}." msgstr "" #. type: item #: doc/contributing.texi:2286 #, no-wrap msgid "New po files for the @code{documentation-manual} component must be" msgstr "" #. type: itemize #: doc/contributing.texi:2292 msgid "" "registered by adding the file name to @code{DOC_PO_FILES} in @file{po/doc/" "local.mk}, the generated @file{%D%/guix.xx.texi} manual to " "@code{info_TEXINFOS} in @file{doc/local.mk} and the generated @file{%D%/guix." "xx.texi} and @file{%D%/contributing.xx.texi} to @code{TRANSLATED_INFO} also " "in @file{doc/local.mk}." msgstr "" #. type: item #: doc/contributing.texi:2292 #, no-wrap msgid "New po files for the @code{documentation-cookbook} component must be" msgstr "" #. type: itemize #: doc/contributing.texi:2298 msgid "" "registered by adding the file name to @code{DOC_COOKBOOK_PO_FILES} in " "@file{po/doc/local.mk}, the generated @file{%D%/guix-cookbook.xx.texi} " "manual to @code{info_TEXINFOS} in @file{doc/local.mk} and the generated " "@file{%D%/guix-cookbook.xx.texi} to @code{TRANSLATED_INFO} also in @file{doc/" "local.mk}." msgstr "" #. type: item #: doc/contributing.texi:2298 #, no-wrap msgid "New po files for the @code{website} component must be added to the" msgstr "" #. type: itemize #: doc/contributing.texi:2303 msgid "" "@code{guix-artwork} repository, in @file{website/po/}. @file{website/po/" "LINGUAS} and @file{website/po/ietf-tags.scm} must be updated accordingly " "(see @file{website/i18n-howto.txt} for more information on the process)." msgstr ""