GNU Guix Reference Manual

Using the GNU Guix Functional Package Manager

The GNU Guix Developers

Edition {No value for ‘EDITION’}
UPDATED : 2024-10-01 12:31:10 00:00

Copyright © 2012-2024 Ludovic Courtès
Copyright © 2013, 2014, 2016, 2024 Andreas Enge
Copyright © 2013 Nikita Karetnikov
Copyright © 2014, 2015, 2016 Alex Kost
Copyright © 2015, 2016 Mathieu Lirzin
Copyright © 2014 Pierre-Antoine Rault
Copyright © 2015 Taylan Ulrich Bayırlı/Kammer
Copyright © 2015, 2016, 2017, 2019, 2020, 2021, 2023 Leo Famulari
Copyright © 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Ricardo Wurmus
Copyright © 2016 Ben Woodcroft
Copyright © 2016, 2017, 2018, 2021 Chris Marusich
Copyright © 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Efraim Flashner
Copyright © 2016 John Darrington
Copyright © 2016, 2017 Nikita Gillmann
Copyright © 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Jan Nieuwenhuizen
Copyright © 2016, 2017, 2018, 2019, 2020, 2021 Julien Lepiller
Copyright © 2016 Alex ter Weele
Copyright © 2016, 2017, 2018, 2019, 2020, 2021 Christopher Baines
Copyright © 2017, 2018, 2019 Clément Lassieur
Copyright © 2017, 2018, 2020, 2021, 2022 Mathieu Othacehe
Copyright © 2017 Federico Beffa
Copyright © 2017, 2018, 2024 Carlo Zancanaro
Copyright © 2017 Thomas Danckaert
Copyright © 2017 humanitiesNerd
Copyright © 2017, 2021 Christine Lemmer-Webber
Copyright © 2017, 2018, 2019, 2020, 2021, 2022 Marius Bakke
Copyright © 2017, 2019, 2020, 2022 Hartmut Goebel
Copyright © 2017, 2019, 2020, 2021, 2022, 2023 Maxim Cournoyer
Copyright © 2017–2022 Tobias Geerinckx-Rice
Copyright © 2017 George Clemmer
Copyright © 2017 Andy Wingo
Copyright © 2017, 2018, 2019, 2020, 2023, 2024 Arun Isaac
Copyright © 2017 nee
Copyright © 2018 Rutger Helling
Copyright © 2018, 2021, 2023 Oleg Pykhalov
Copyright © 2018 Mike Gerwitz
Copyright © 2018 Pierre-Antoine Rouby
Copyright © 2018, 2019 Gábor Boskovits
Copyright © 2018, 2019, 2020, 2022, 2023, 2024 Florian Pelz
Copyright © 2018 Laura Lazzati
Copyright © 2018 Alex Vong
Copyright © 2019 Josh Holland
Copyright © 2019, 2020 Diego Nicola Barbato
Copyright © 2019 Ivan Petkov
Copyright © 2019 Jakob L. Kreuze
Copyright © 2019 Kyle Andrews
Copyright © 2019 Alex Griffin
Copyright © 2019, 2020, 2021, 2022 Guillaume Le Vaillant
Copyright © 2020 Liliana Marie Prikler
Copyright © 2019, 2020, 2021, 2022, 2023 Simon Tournier
Copyright © 2020 Wiktor Żelazny
Copyright © 2020 Damien Cassou
Copyright © 2020 Jakub Kądziołka
Copyright © 2020 Jack Hill
Copyright © 2020 Naga Malleswari
Copyright © 2020, 2021 Brice Waegeneire
Copyright © 2020 R Veera Kumar
Copyright © 2020, 2021, 2022 Pierre Langlois
Copyright © 2020 pinoaffe
Copyright © 2020, 2023 André Batista
Copyright © 2020, 2021 Alexandru-Sergiu Marton
Copyright © 2020 raingloom
Copyright © 2020 Daniel Brooks
Copyright © 2020 John Soo
Copyright © 2020 Jonathan Brielmaier
Copyright © 2020 Edgar Vincent
Copyright © 2021, 2022 Maxime Devos
Copyright © 2021 B. Wilson
Copyright © 2021 Xinglu Chen
Copyright © 2021 Raghav Gururajan
Copyright © 2021 Domagoj Stolfa
Copyright © 2021 Hui Lu
Copyright © 2021 pukkamustard
Copyright © 2021 Alice Brenon
Copyright © 2021-2023 Josselin Poiret
Copyright © 2021, 2023 muradm
Copyright © 2021, 2022 Andrew Tropin
Copyright © 2021 Sarah Morgensen
Copyright © 2022 Remco van ’t Veer
Copyright © 2022 Aleksandr Vityazev
Copyright © 2022 Philip M@sup{c}Grath
Copyright © 2022 Karl Hallsby
Copyright © 2022 Justin Veilleux
Copyright © 2022 Reily Siegel
Copyright © 2022 Simon Streit
Copyright © 2022 (
Copyright © 2022 John Kehayias
Copyright © 2022⁠–⁠2023 Bruno Victal
Copyright © 2022 Ivan Vilata-i-Balaguer
Copyright © 2023-2024 Giacomo Leidi
Copyright © 2022 Antero Mejr
Copyright © 2023 Karl Hallsby
Copyright © 2023 Nathaniel Nicandro
Copyright © 2023 Tanguy Le Carrour
Copyright © 2023, 2024 Zheng Junjie
Copyright © 2023 Brian Cully
Copyright © 2023 Felix Lechner
Copyright © 2023 Foundation Devices, Inc.
Copyright © 2023 Thomas Ieong
Copyright © 2023 Saku Laesvuori
Copyright © 2023 Graham James Addis
Copyright © 2023, 2024 Tomas Volf
Copyright © 2024 Herman Rimm
Copyright © 2024 Matthew Trzcinski
Copyright © 2024 Richard Sent
Copyright © 2024 Dariqq
Copyright © 2024 Denis ’GNUtoo’ Carikli
Copyright © 2024 Fabio Natali
Copyright © 2024 Muhammad Solehin 'tfelypoc' Sabtu

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”.

[ < ] [ > ]   [Contents] [Index] [ ? ]

Bismillahirrahmanniraheem,~

GNU Guix nonGNU nonGuix

UPDATED : 2024-10-01 12:31:10 00:00

≠{No value for ‘VERSION’}, a functional package management tool written for the GNU system.

≠Top in GNU Guix参考手册), French (see Top in Manuel de référence de GNU Guix), German (see Top in Referenzhandbuch zu GNU Guix), Spanish (see Top in Manual de referencia de GNU Guix), Brazilian Portuguese (see Top in Manual de referência do GNU Guix), and Russian (see Top in Руководство GNU Guix). If you would like to translate it in your native language, consider joining Weblate (@pxref{Translating Guix}).

1 Introduction   What is Guix about?
2 Installation   Installing Guix.
3 System Installation   Installing the whole operating system.
4 Getting Started   Your first steps.
5 Package Management   Package installation, upgrade, etc.
6 Channels   Customizing the package collection.
7 Development   Guix-aided software development.
8 Programming Interface   Using Guix in Scheme.
9 Utilities   Package management commands.
10 Foreign Architectures   Build for foreign architectures.
11 System Configuration   Configuring the operating system.
12 System Troubleshooting Tips   When things don’t go as planned.
13 Home Configuration   Configuring the home environment.
14 Documentation   Browsing software user manuals.
15 Platforms   Defining platforms.
16 Creating System Images   Creating system images.
17 Installing Debugging Files   Feeding the debugger.
18 Using TeX and LaTeX   Typesetting.
19 Security Updates   Deploying security fixes quickly.
20 Bootstrapping   GNU/Linux built from scratch.
21 Porting to a New Platform   Targeting another platform or kernel.
• Contributing   Your help needed!
22 Acknowledgments   Thanks!
Appendix A GNU Free Documentation License   The license of this manual.
Concept Index   Concepts.
Programming Index   Data types, functions, and variables. 
 — The Detailed Node Listing —

Introduction
1.1 Managing Software the Guix Way   What’s special.
1.2 GNU Distribution   The packages and tools. 
Installation
2.1 Binary Installation   Getting Guix running in no time!
2.2 Setting Up the Daemon   Preparing the build daemon’s environment.
2.3 Invoking guix-daemon   Running the build daemon.
2.4 Application Setup   Application-specific setup.
2.5 Upgrading Guix   Upgrading Guix and its build daemon. 
Setting Up the Daemon
2.2.1 Build Environment Setup   Preparing the isolated build environment.
2.2.2 Using the Offload Facility   Offloading builds to remote machines.
2.2.3 SELinux Support   Using an SELinux policy for the daemon. 
System Installation
3.1 Limitations   What you can expect.
3.2 Hardware Considerations   Supported hardware.
3.3 USB Stick and DVD Installation   Preparing the installation medium.
3.4 Preparing for Installation   Networking, partitioning, etc.
3.5 Guided Graphical Installation   Easy graphical installation.
3.6 Manual Installation   Manual installation for wizards.
3.7 After System Installation   When installation succeeded.
3.8 Installing Guix in a Virtual Machine   Guix System playground.
3.9 Building the Installation Image   How this comes to be. 
Manual Installation
3.6.1 Keyboard Layout, Networking, and Partitioning   Initial setup.
3.6.2 Proceeding with the Installation   Installing. 
Package Management
5.1 Features   How Guix will make your life brighter.
5.2 Invoking guix package   Package installation, removal, etc.
5.3 Substitutes   Downloading pre-built binaries.
5.4 Packages with Multiple Outputs   Single source package, multiple outputs.
5.5 Invoking guix locate   Locating packages that provide a file.
5.6 Invoking guix gc   Running the garbage collector.
5.7 Invoking guix pull   Fetching the latest Guix and distribution.
5.8 Invoking guix time-machine   Running an older revision of Guix.
5.9 Inferiors   Interacting with another revision of Guix.
5.10 Invoking guix describe   Display information about your Guix revision.
5.11 Invoking guix archive   Exporting and importing store files. 
Substitutes
5.3.1 Official Substitute Servers   One particular source of substitutes.
5.3.2 Substitute Server Authorization   How to enable or disable substitutes.
5.3.3 Getting Substitutes from Other Servers   Substitute diversity.
5.3.4 Substitute Authentication   How Guix verifies substitutes.
5.3.5 Proxy Settings   How to get substitutes via proxy.
5.3.6 Substitution Failure   What happens when substitution fails.
5.3.7 On Trusting Binaries   How can you trust that binary blob? 
Channels
6.1 Specifying Additional Channels   Extending the package collection.
6.2 Using a Custom Guix Channel   Using a customized Guix.
6.3 Replicating Guix   Running the exact same Guix.
6.5 Channel Authentication   How Guix verifies what it fetches.
6.6 Channels with Substitutes   Using channels with available substitutes.
6.7 Creating a Channel   How to write your custom channel.
6.8 Package Modules in a Sub-directory   Specifying the channel’s package modules location.
6.9 Declaring Channel Dependencies   How to depend on other channels.
6.10 Specifying Channel Authorizations   Defining channel authors authorizations.
6.11 Primary URL   Distinguishing mirror to original.
6.12 Writing Channel News   Communicating information to channel’s users. 
Development
7.1 Invoking guix shell   Spawning one-off software environments.
7.2 Invoking guix environment   Setting up development environments.
7.3 Invoking guix pack   Creating software bundles.
7.4 The GCC toolchain   Working with languages supported by GCC.
7.5 Invoking guix git authenticate   Authenticating Git repositories. 
Programming Interface
8.1 Package Modules   Packages from the programmer’s viewpoint.
8.2 Defining Packages   Defining new packages.
8.3 Defining Package Variants   Customizing packages.
8.4 Writing Manifests   The bill of materials of your environment.
8.5 Build Systems   Specifying how packages are built.
8.6 Build Phases   Phases of the build process of a package.
8.7 Build Utilities   Helpers for your package definitions and more.
8.8 Search Paths   Declaring search path environment variables.
8.9 The Store   Manipulating the package store.
8.10 Derivations   Low-level interface to package derivations.
8.11 The Store Monad   Purely functional interface to the store.
8.12 G-Expressions   Manipulating build expressions.
8.13 Invoking guix repl   Programming Guix in Guile
8.14 Using Guix Interactively   Fine-grain interaction at the REPL. 
Defining Packages
8.2.1 package Reference   The package data type.
8.2.2 origin Reference   The origin data type. 
Utilities
9.1 Invoking guix build   Building packages from the command line.
9.2 Invoking guix edit   Editing package definitions.
9.3 Invoking guix download   Downloading a file and printing its hash.
9.4 Invoking guix hash   Computing the cryptographic hash of a file.
9.5 Invoking guix import   Importing package definitions.
9.6 Invoking guix refresh   Updating package definitions.
9.7 Invoking guix style   Styling package definitions.
9.8 Invoking guix lint   Finding errors in package definitions.
9.9 Invoking guix size   Profiling disk usage.
9.10 Invoking guix graph   Visualizing the graph of packages.
9.11 Invoking guix publish   Sharing substitutes.
9.12 Invoking guix challenge   Challenging substitute servers.
9.13 Invoking guix copy   Copying to and from a remote store.
9.14 Invoking guix container   Process isolation.
9.15 Invoking guix weather   Assessing substitute availability.
9.16 Invoking guix processes   Listing client processes. 
Invoking guix build
9.1.1 Common Build Options   Build options for most commands.
9.1.2 Package Transformation Options   Creating variants of packages.
9.1.3 Additional Build Options   Options specific to ’guix build’.
9.1.4 Debugging Build Failures   Real life packaging experience. 
Foreign Architectures
10.1 Cross-Compilation   Cross-compiling for another architecture.
10.2 Native Builds   Targeting another architecture through native builds. 
System Configuration
11.1 Getting Started   Your first steps.
11.2 Using the Configuration System   Customizing your GNU system.
11.3 operating-system Reference   Detail of operating-system declarations.
11.4 File Systems   Configuring file system mounts.
11.5 Mapped Devices   Block device extra processing.
11.6 Swap Space   Backing RAM with disk space.
11.7 User Accounts   Specifying user accounts.
11.8 Keyboard Layout   How the system interprets key strokes.
11.9 Locales   Language and cultural convention settings.
11.10 Services   Specifying system services.
11.11 Privileged Programs   Programs running with elevated privileges.
11.12 X.509 Certificates   Authenticating HTTPS servers.
11.13 Name Service Switch   Configuring libc’s name service switch.
11.14 Initial RAM Disk   Linux-Libre bootstrapping.
11.15 Bootloader Configuration   Configuring the boot loader.
11.16 Invoking guix system   Instantiating a system configuration.
11.17 Invoking guix deploy   Deploying a system configuration to a remote host.
11.18 Running Guix in a Virtual Machine   How to run Guix System in a virtual machine.
11.19 Defining Services   Adding new service definitions. 
File Systems
11.4.1 Btrfs file system   
Services
11.10.1 Base Services   Essential system services.
11.10.2 Scheduled Job Execution   The mcron service.
11.10.3 Log Rotation   The rottlog service.
11.10.4 Networking Setup   Setting up network interfaces.
11.10.5 Networking Services   Firewall, SSH daemon, etc.
11.10.6 Unattended Upgrades   Automated system upgrades.
11.10.7 X Window   Graphical display.
11.10.8 Printing Services   Local and remote printer support.
11.10.9 Desktop Services   D-Bus and desktop services.
11.10.10 Sound Services   ALSA and Pulseaudio services.
11.10.11 File Search Services   Tools to search for files.
11.10.12 Database Services   SQL databases, key-value stores, etc.
11.10.13 Mail Services   IMAP, POP3, SMTP, and all that.
11.10.14 Messaging Services   Messaging services.
11.10.15 Telephony Services   Telephony services.
11.10.16 File-Sharing Services   File-sharing services.
11.10.17 Monitoring Services   Monitoring services.
11.10.18 Kerberos Services   Kerberos services.
11.10.19 LDAP Services   LDAP services.
11.10.20 Web Services   Web servers.
11.10.21 Certificate Services   TLS certificates via Let’s Encrypt.
11.10.22 DNS Services   DNS daemons.
11.10.23 VNC Services   VNC daemons.
11.10.24 VPN Services   VPN daemons.
11.10.25 Network File System   NFS related services.
11.10.26 Samba Services   Samba services.
11.10.27 Continuous Integration   Cuirass and Laminar services.
11.10.28 Power Management Services   Extending battery life.
11.10.29 Audio Services   The MPD.
11.10.30 Virtualization Services   Virtualization services.
11.10.31 Version Control Services   Providing remote access to Git repositories.
11.10.32 Game Services   Game servers.
11.10.33 PAM Mount Service   Service to mount volumes when logging in.
11.10.34 Guix Services   Services relating specifically to Guix.
11.10.35 Linux Services   Services tied to the Linux kernel.
11.10.36 Hurd Services   Services specific for a Hurd System.
11.10.37 Miscellaneous Services   Other services. 
Defining Services
11.19.1 Service Composition   The model for composing services.
11.19.2 Service Types and Services   Types and services.
11.19.3 Service Reference   API reference.
11.19.4 Shepherd Services   A particular type of service.
11.19.5 Complex Configurations   Defining bindings for complex configurations. 
System Troubleshooting Tips
12.1 Chrooting into an existing system   
Home Configuration
13.1 Declaring the Home Environment   Customizing your Home.
13.2 Configuring the Shell   Enabling home environment.
13.3 Home Services   Specifying home services.
13.4 Invoking guix home   Instantiating a home configuration. 
Home Services
13.3.1 Essential Home Services   Environment variables, packages, on-* scripts.
13.3.2 Shells   POSIX shells, Bash, Zsh.
13.3.3 Scheduled User’s Job Execution  
13.3.4 Power Management Home Services   Services for battery power.
13.3.5 Managing User Daemons   Managing User’s Daemons.
13.3.6 Secure Shell   Setting up the secure shell client.
13.3.7 GNU Privacy Guard   Setting up GPG and related tools.
13.3.8 Desktop Home Services   Services for graphical environments.
13.3.9 Guix Home Services   Services for Guix.
13.3.10 Fonts Home Services   Services for managing User’s fonts.
13.3.11 Sound Home Services   Dealing with audio.
13.3.12 Mail Home Services   Services for managing mail.
13.3.13 Messaging Home Services   Services for managing messaging.
13.3.14 Media Home Services   Services for managing media.
13.3.15 Networking Home Services   Networking services.
13.3.16 Miscellaneous Home Services   More services. 
Platforms
15.1 platform Reference   Detail of platform declarations.
15.2 Supported Platforms   Description of the supported platforms. 
Creating System Images
16.1 image Reference   Detail of image declarations.
16.2 Instantiate an Image   How to instantiate an image record.
16.3 image-type Reference   Detail of image types declaration.
16.4 Image Modules   Definition of image modules. 
image Reference
16.1.1 partition Reference   
Installing Debugging Files
17.1 Separate Debug Info   Installing ’debug’ outputs.
17.2 Rebuilding Debug Info   Building missing debug info. 
Bootstrapping
20.1 The Full-Source Bootstrap   A Bootstrap worthy of GNU.
20.2 Preparing to Use the Bootstrap Binaries   Building that what matters most. 







[ < ]
[ > ]
   
[Contents]
[Index]
[ ? ]




 
  This document was generated on September 30, 2024 using texi2html 5.0.