aboutsummaryrefslogtreecommitdiff
path: root/doc/guix.texi
Commit message (Collapse)AuthorAge
* services: base: Add environment support to guix-configuration.Mathieu Othacehe2023-01-09
| | | | | | * gnu/services/base.scm (<guix-configuration>)[extra-env]: New field. (guix-shepherd-service): Honor it. * doc/guix.texi (Base Services): Document it.
* Revert "services: base: Add extra-env support to guix-configuration."Mathieu Othacehe2023-01-07
| | | | | This reverts commit 78a9b4f996ba18b4460ba380b87e9538007c27e0. It was pushed by error, while not reviewed yet.
* services: base: Add extra-env support to guix-configuration.Mathieu Othacehe2023-01-07
| | | | | | * gnu/services/base.scm (<guix-configuration>)[extra-env]: New field. (guix-shepherd-service): Honor it. * doc/guix.texi (Base Services): Document it.
* doc: Introduce using swap space for hibernation, with examples.Ivan Vilata-i-Balaguer2023-01-05
| | | | | | | | | | * doc/guix.texi (Swap Space): Add a concise introduction to hibernation and specifying a swap space to the kernel to make resume work. Mention space requirements and the need of an offset for swap files. Include a trivial example on how to set up a mapped swap volume for hibernation and another one for a swap file, including how to compute the file offset. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* home: services: environment-variables: Add support for literal strings.Ludovic Courtès2023-01-05
| | | | | | | | | * gnu/home/services.scm (<literal-string>): New record type. (environment-variable-shell-definitions): Split 'shell-quote' into 'quote-string' and 'shell-double-quote'. Add 'shell-single-quote'. Add clause for 'literal-string' records. * tests/guix-home.sh: Test it. * doc/guix.texi (Essential Home Services): Document it.
* doc: Fix broken link for go-build-system.Bruno Victal2023-01-03
| | | | | | * doc/guix.texi (Build Systems): Fix broken link for go-build-system. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
* import/cran: Allow custom license prefix.Lars-Dominik Braun2022-12-31
| | | | | | | | | | | | * guix/import/cran.scm (string-licenses): Add license-prefix argument. (string->license): Ditto. (description->package): Ditto. (cran->guix-package): Ditto. (cran-recursive-import): Ditto. * guix/scripts/import/cran.scm (%options): Add new option -p/--license-prefix. (show-help): Document it. (parse-options): Pass it to importer. * doc/guix.texi (Invoking guix import): Document it.
* doc: Give example of when to use describe in .guix-channel file.Karl Hallsby2022-12-29
| | | | | | | * doc/guix.texi (Package Modules in a Sub-directory): Mention "guix deploy" files as an example. Signed-off-by: Ricardo Wurmus <rekado@elephly.net>
* doc: Describe format of channel that uses directory field.Karl Hallsby2022-12-29
| | | | | * doc/guix.texi (Package Modules in a Sub-directory): Explain that directory must be the module root.
* doc: Update expired URL.Marius Bakke2022-12-28
| | | | * doc/guix.texi (DNS Services): Update knot-resolver documentation link.
* doc: Describe how to update to a specific version.Hartmut Goebel2022-12-26
| | | | | * doc/guix.texi (Invoking guix refresh): Describe how to update to a specific version.
* gnu: services: Fix bluetooth-service docstring.Ivan Vilata i Balaguer2022-12-26
| | | | | | | | * gnu/services/desktop.scm (bluetooth-service): Sync docstring with info, remove mention to group not really needed to access D-Bus service. * doc/guix.texi (Desktop Services): Also remove mention to group here. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* services: wireguard: Allow specifying pre-shared keys.Timo Wilken2022-12-25
| | | | | | | * gnu/services/vpn.scm (<wireguard-peer>)[preshared-key]: New field. * doc/guix.texi (VPN Services): Document it. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
* doc: Wrap $localstatedir in Texinfo syntax.Ricardo Wurmus2022-12-23
| | | | * doc/guix.texi (Limitations): Use @file syntax.
* doc: Suggest remounting store before relabeling the file system.Ricardo Wurmus2022-12-23
| | | | | * doc/guix.texi (Installing the SELinux policy): Mention that the store may need to be remounted before writing to it.
* services: opensmtpd: Add 'shepherd-requirement' field.Bruno Victal2022-12-20
| | | | | | | | | * gnu/services/mail.scm (<opensmtpd-configuration>)[shepherd-requirement]: New field. (opensmtpd-shepherd-service): Honor it. * doc/guix.texi (Mail Services): Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* doc: Avoid 'match' on the <udev-configuration> record.Ludovic Courtès2022-12-20
| | | | | | | | Fixes <https://issues.guix.gnu.org/59907>. Reported by MANCINI Raffael <Raffael.MANCINI@mnhn.lu>. * doc/guix.texi (Service Types and Services): Change 'udev-configuration' example to avoid 'match'.
* Merge branch 'version-1.4.0'Ludovic Courtès2022-12-19
|\
| * doc: Use VM image file name consistently.Ludovic Courtès2022-12-15
| | | | | | | | | | | | | | | | | | | | | | Previously, what "/tmp/qemu-image" refers to could be unclear at first. * doc/guix.texi (Running Guix in a VM): Use the original image file name instead of /tmp/qemu-image. * po/doc/guix-manual.de.po, po/doc/guix-manual.es.po, po/doc/guix-manual.fr.po, po/doc/guix-manual.pt_BR.po, po/doc/guix-manual.ru.po, po/doc/guix-manual.zh_CN.po: Adjust accordingly.
| * doc: Fix formatting for 'computed-file'.Bruno Victal2022-12-14
| | | | | | | | | | | | * doc/guix.texi (G-Expressions): Fix formatting for 'computed-file'. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
| * doc: Verify the release with my own OpenPGP key.Ludovic Courtès2022-12-14
| | | | | | | | | | * doc/guix.texi (OPENPGP-SIGNING-KEY-ID, OPENPGP-SIGNING-KEY-URL): Switch to my key.
* | doc: Tweak cross-ref Texinfo command.Ludovic Courtès2022-12-18
| | | | | | | | | | * doc/guix.texi (Swap Space): Use @pxref instead of @xref at the end of a sentence.
* | services: ganeti: Add support for cluster hooks.Marius Bakke2022-12-17
| | | | | | | | | | | | | | | | | | | | * gnu/services/ganeti.scm (<ganeti-configuration>): Add HOOKS. (hooks->directory): Rename to ... (debootstrap-hooks->directory): ... this, for clarity. (debootstrap-configuration-compiler): Adjust accordingly. (ganeti-directory): Add HOOKS when set. (ganeti-etc-service): Pass HOOKS. * doc/guix.texi (Virtualization Services): Mention it.
* | gnu: slapd-configuration: Update default for run-dir.Ricardo Wurmus2022-12-14
| | | | | | | | | | | | * gnu/services/ldap.scm (slapd-configuration): Update default value for run-dir to match defaults of 389-ds-base package. * doc/guix.texi: Update documentation.
* | gnu: Add directory-server-service-type.Ricardo Wurmus2022-12-14
| | | | | | | | | | | | * gnu/services/ldap.scm: New file. * gnu/local.mk (GNU_SYSTEM_MODULES): Add it. * doc/guix.texi (LDAP Services): Document it.
* | doc: Fix formatting for 'computed-file'.Bruno Victal2022-12-14
| | | | | | | | | | | | * doc/guix.texi (G-Expressions): Fix formatting for 'computed-file'. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* | services: nix: Add more configuration fields.Petr Hodina2022-12-13
| | | | | | | | | | | | | | | | * gnu/services/nix.scm (<nix-configuration>)[build-directory]: New field. (nix-service-etc, nix-shepherd-service): Take them into account. * doc/guix.texi (Nix): Update it. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* | doc: Replace reference to Freenode.Ludovic Courtès2022-12-08
| | | | | | | | | | * doc/guix.texi (Reduced Binary Seed Bootstrap): Libera.Chat, not Freenode.
* | services: zabbix: Don't write user to configuration file.Marius Bakke2022-12-07
| | | | | | | | | | | | | | | | | | | | | | | | | | | | The service already runs with the specified user and group, so there is no use in writing it to the configuration files. This change is mainly done for compatibility with 'zabbix-agent2' which does not understand the User= setting, but also to document the correct data type for the "group" setting. * gnu/services/monitoring.scm (serialize-string): Filter USER and GROUP fields. (group?, serialize-group): Remove variables. (zabbix-server-configuration, zabbix-agent-configuration): Document the GROUP field as 'string'. * doc/guix.texi (Monitoring Services): Adjust accordingly.
* | gnu: bootloader: Rework chaining, add grub-efi-netboot-removable-bootloader.Stefan2022-12-01
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This rework allows to use an (efi-bootloader-chain) like this, which is able to boot over network or local storage, depending on whether the bootloader target has support for symbolic links: (operating-system (bootloader (bootloader-configuration (bootloader (efi-bootloader-chain grub-efi-netboot-removable-bootloader #:packages (list my-firmware-package my-u-boot-package) #:files (list (plain-file "config.txt" "kernel=u-boot.bin")) #:hooks my-special-bootloader-profile-manipulator)) (targets '("/booti/efi")) …)) …) * doc/guix.texi (Bootloader Configuration): Describe the new ‘grub-efi-netboot-removable-bootloader’. Mention the file names used and that the UEFI Boot Manager is not modified. Advise to disable write-access over TFTP. * gnu/bootloader.scm (efi-bootloader-profile): Allow a list of packages and collect everything directly in the profile, avoiding a separate collection directory. Renamed the profile from "bootloader-profile" to "efi-bootloader-profile". [bootloader-collection]: Rename to... [efi-bootloader-profile-hook]: ... this and remove unused modules. Do not create the now extraneous collection directory. (efi-bootloader-chain): Add PACKAGES and DISK-IMAGE-INSTALLER arguments. Remove handling of the collection directory, now only calling the given installer procedure. * gnu/bootloader/grub.scm (make-grub-efi-netboot-installer): New helper. (make-grub-configuration): New helper based on (grub-configuration-file). Add a GRUB argument, fix indentation, remove previous code retrieving GRUB from CONFIG. (grub-configuration-file): Make use of make-grub-configuration. (grub-efi-configuration-file): New procedure. (grub-cfg): New variable to replace "/boot/grub/grub.cfg". (install-grub-efi-netboot): Remove, splitting logic to... (make-grub-efi-netboot-installer): ... this new helper procedure, as well as to make-grub-efi-netboot, added below. (grub-bootloader): Adjust to use the GRUB-CFG. (grub-efi-bootloader): Likewise. Removed inheritance and declare all fields explicitly. (make-grub-efi-netboot-bootloader): New procedure. (grub-efi-netboot-bootloader): Use it. (grub-efi-netboot-removable-bootloader): New variable. * gnu/packages/bootloaders.scm (make-grub-efi-netboot): New procedure. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Modified-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
* | services: network-manager: Add iwd backend support.Andrew Tropin2022-12-01
| | | | | | | | | | | | | | * gnu/services/networking.scm (network-manager-configuration)[iwd?]: New field. (network-manager-shepherd-service): Add iwd to requirements if needed. * doc/guix.texi: Add information about iwd? option.
* | doc: Remove unimplemented 'herd rules udev'.Maxim Cournoyer2022-11-29
| | | | | | | | | | | | | | | | | | Since this text was added, the rules.d directory is now exposed straightforwardly via the standard /etc/udev/rules.d directory, so there's no need for a special 'rules' service action to print that directory. * doc/guix.texi (Base Services): Remove the paragraph documenting the nonexistent 'herd rules udev' command.
* | doc: Recommend avoiding execl, execle or execlp in mcron job specifications.Maxim Cournoyer2022-11-28
|/ | | | | * doc/guix.texi (Scheduled Job Execution): Adjust the 'updatedb' example and add a new tip.
* doc: Note that ‘guix package’ accepts file names.Tobias Geerinckx-Rice2022-11-20
| | | | | | | * doc/guix.texi (Package Management)[Invoking guix package]: Mention support for operating on store file names. Co-authored-by: Tobias Geerinckx-Rice <me@tobias.gr>
* offload: Increase default 'overload-threshold' value.Ludovic Courtès2022-11-23
| | | | | | | | | | | When offloading to a single machine, the previous default value would lead 'guix offload' to wait possibly for several minutes between subsequent builds until normalized load would finally go below 0.6. Increasing it mitigates that. * guix/scripts/offload.scm (<build-machine>)[overload-threshold]: Bump to 0.8. * doc/guix.texi (Daemon Offload Setup): Likewise.
* doc: Call out potential for security vulnerabilities in old software.pelzflorian (Florian Pelz)2022-11-22
| | | | | | * doc/guix.texi (Invoking guix time-machine): Add a note. Co-authored by: Simon Tournier <zimon.toutoune@gmail.com>
* guix: modify-input: Recommend prepend instead of append.Vivien Kraus2022-11-21
| | | | | | | | * doc/guix.texi (Defining Package Variants): Document the "prepend" clause of modify-inputs first. * guix/packages.scm (modify-inputs): use "prepend" in the docstring. Signed-off-by: Christopher Baines <mail@cbaines.net>
* services: Add Shepherd 'configuration' action to various services.Ludovic Courtès2022-11-18
| | | | | | | | | | | | | | | | | | * gnu/services/avahi.scm (avahi-shepherd-service): Add 'actions' field. * gnu/services/base.scm (nscd-actions): Add call to 'shepherd-configuration-action'. * gnu/services/desktop.scm (upower-shepherd-service): Add 'actions' field. (elogind-shepherd-service): Likewise. * gnu/services/dict.scm (dicod-shepherd-service): Likewise. * gnu/services/networking.scm (openntpd-shepherd-service): Likewise. (tor-shepherd-service): Likewise. * gnu/services/ssh.scm (openssh-shepherd-service): Likewise. * gnu/services/web.scm (nginx-shepherd-service): Likewise. * gnu/services/xorg.scm (gdm-shepherd-service): Likewise. * gnu/tests/base.scm (run-basic-test)["nscd configuration action"]: New test. * doc/guix.texi (Services): Document it.
* services: shepherd: Define 'shepherd-configuration-action' helper.Ludovic Courtès2022-11-18
| | | | | * gnu/services/shepherd.scm (shepherd-configuration-action): New * doc/guix.texi (Shepherd Services): Document it.
* linux-initrd: raw-initrd: Add keyword argument #:pre-mount.Hilton Chain2022-11-18
| | | | | | | | * gnu/system/linux-initrd.scm (raw-initrd): Add keyword argument #:pre-mount. Document it. * doc/guix.texi (initial RAM disk): Likewise. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* Revert "services: configuration: Revert to a working ‘guix home’."Maxim Cournoyer2022-11-17
| | | | | | This reverts commit 39e4e00f75be8055300cb0afffb8bd4b4d35f2cc, with fixes for the guix home issues reported and another one found while reconfiguring berlin in the subsequent commit.
* services: configuration: Revert to a working ‘guix home’.Tobias Geerinckx-Rice2022-11-13
| | | | | | | | | | | | | | | | | | | | | This reverts commit 543d971ed2a1d9eb934af1f51930741d7cc4e7ef, and its dependent commit 9b21cd2e9a614f1937769caf3917a791b151d841, which appear to have triggered a recent wave of ‘guix home’ regressions involving (services (list (service home-bash-service-type))): In gnu/home/services/shells.scm: 504:7 3 (home-bash-extensions #<<home-bash-configuration> package: #<package bash@5.1.8 gnu/packages/ba…> …) In unknown file: 2 (append #<<location> file: "…" line: 14 column: 12> ()) In ice-9/boot-9.scm: 1685:16 1 (raise-exception _ #:continuable? _) 1685:16 0 (raise-exception _ #:continuable? _) ice-9/boot-9.scm:1685:16: In procedure raise-exception: In procedure append: Wrong type argument in position 1 (expecting empty list): #<<location> file: "…" line: 14 column: 12> I should love to dive in & fix this rather than revert, but urgently need sleep.
* services: mcron: Add log? and log-format fields to mcron-configuration.Maxim Cournoyer2022-11-15
| | | | | | | | | | | | | * gnu/services/mcron.scm (list-of-gexps?): New predicate. (mcron-configuration): Rewrite using define-configuration. [log?, log-format]: New fields. (mcron-shepherd-services): Invoke mcron with the --log and --log-format arguments when log? is #t, (generate-doc): New procedure. * doc/guix.texi (Scheduled Job Execution): Update doc. (Mcron Home Service): Likewise. * gnu/home/services/mcron.scm: Keep in sync with the above changes to gnu/services/mcron.scm.
* guix: shell: Add '--symlink' option.Maxim Cournoyer2022-11-15
| | | | | | | | | | | | | | | | | * guix/scripts/pack.scm (%options): Extract symlink parsing logic to... (symlink-spec-option-parser): ... here. (self-contained-tarball/builder): Add a comment mentioning why a relative file name is used for the link target. * guix/scripts/environment.scm (show-environment-options-help): Document new --symlink option. (%default-options): Add default value for symlinks. (%options): Register new symlink option. (launch-environment/container): Add #:symlinks argument and extend doc, and create symlinks using evaluate-populate-directive. (guix-environment*): Pass symlinks arguments to launch-environment/container. * doc/guix.texi (Invoking guix shell): Document it. * tests/guix-shell.sh: Add a --symlink (negative) test. * tests/guix-environment-container.sh: Add tests.
* doc: Add missing closing parentheses in examples.Ludovic Courtès2022-11-15
| | | | | * doc/guix.texi (VNC Services, Guix Home Services): Add missing closing parentheses.
* doc: Link to the Git book instead of the git-scm.com homepage.pelzflorian (Florian Pelz)2022-11-15
| | | | | | | | | | The Pro Git book, unlike the git-scm.com homepage, is translated to many languages. Therefore translators of the Guix Manual can point to the appropriate translation now. * doc/guix.texi (Invoking guix pull): Point to the Pro Git book's URL. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* doc: Refer to the pt_BR translation.pelzflorian (Florian Pelz)2022-11-15
| | | | | | * doc/guix.texi (Top): Mention Brazilian Portuguese. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* installer: Report known-unsupported PCI devices.Ludovic Courtès2022-11-15
| | | | | | | | | | | | | | | | | * gnu/installer/hardware.scm: New file. * gnu/local.mk (INSTALLER_MODULES): Add it. * po/guix/POTFILES.in: Add it. * gnu/installer.scm (installer-steps): Pass #:pci-database to the 'welcome' step procedure. * gnu/installer/newt.scm (welcome-page): Add #:pci-database and pass it to 'run-welcome-page'. * gnu/installer/newt/welcome.scm (check-hardware-support): Add #:pci-database. Enumerate unsupported PCI devices and run an error page when unsupported devices are found. (run-welcome-page): Add #:pci-database and pass it to 'check-hardware-support' and to the recursive call. * gnu/installer/record.scm (<installer>)[welcome-page]: Adjust comment. * doc/guix.texi (Hardware Considerations): Mention it.
* services: gitolite: Add local-code configuration option.Alexey Abramov2022-11-07
| | | | | | | | | * gnu/services/version-control.scm (gitolite-rc-file): Add local-code field. (gitolite-rc-file-compiler): Serialize the field. * doc/guix.texi: Document it. Signed-off-by: Christopher Baines <mail@cbaines.net>
* guix gc: Add '--vacuum-database'.Efraim Flashner2022-11-06
| | | | | | * guix/scripts/gc.scm (show-help, %options): Add '--vacuum-database'. * guix/store/database.scm (vacuum-database): New procedure. * doc/guix.texi (Invoking guix gc): Document the option.