summaryrefslogtreecommitdiff
path: root/doc/guix-cookbook.texi
Commit message (Collapse)AuthorAgeFilesLines
* doc: cookbook: Update "Build system arguments" section.Marco Rimoldi6 days1-14/+23
| | | | | | | | | | * doc/guix-cookbook.texi (Build system arguments) Remove recommendation on phase return value. Ensure code examples can run and are up-to-date. Change-Id: I143babf79983751578d6d4e20b20195ea000656d Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* doc: Fix markup.Florian Pelz2025-01-011-1/+1
| | | | | | * doc/guix-cookbook.texi (Upgrade Postgres for Cuirass): Escape '@'. Change-Id: Ifb34a20d107721df0523c343259e598503c87afb
* doc: cookbook: Document postgres upgrade for cuirass.Gabriel Wicki2024-12-121-0/+103
| | | | | | | | * doc/guix-cookbook.texi(System Management): New chapter. [Upgrade Postgres for Cuirass] New node. Change-Id: I23aae16b1f50b6c40c56b78712dfd6eae3834761 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* doc: Fix typos.Florian Pelz2024-10-311-1/+1
| | | | | | | * doc/guix.texi (Sway window manager): Fix typo. * doc/guix-cookbook.texi (Top): Rename Portuguese cookbook. Change-Id: I61569aa882862871d9bf02fa1a97f3f3b902b494
* doc: Fix markup.Florian Pelz2024-10-311-4/+4
| | | | | | | | | | | | * doc/contributing.texi (Source Tree Structure, Submitting Patches, Translating Guix): Write @command instead of @code when invoking guix. (Submitting Patches): Write @code instead of @command for a field name. * doc/guix-cookbook.texi (A ``Hello World'' package): Use @xref at the beginning of a sentence. (Auto-Login to a Specific TTY): Remove a space before @pxref. (Basic setup with manifests): Write @ref instead of (@pxref) after ``see''. Change-Id: I1ced2ebc4062b3a80878a7e0eea8f7a3d4baf7da
* doc: cookbook: Fix typo in screen-locker-service-typeRoman Scherer2024-09-091-1/+1
| | | | | | | | | | The screen locker service type is called screen-locker-service-type, and not screen-locker-services-type. * doc/guix-cookbook.texi (Xorg): Fix typo. Change-Id: I191b0cb971f435f283ff8d0278e581372d16ae95 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* Replace some more occurrences of ‘setuid-programs’.Tobias Geerinckx-Rice2024-08-181-4/+6
| | | | | | | | | | | | | | * gnu/packages/containers.scm (podman, buildah)[arguments]: Substitute /run/privileged/bin for /run/setuid-programs. * gnu/packages/mail.scm (opensmtpd)[arguments]: Likewise. * gnu/packages/spice.scm (spice-gtk)[arguments]: Likewise. * gnu/packages/patches/enlightenment-fix-setuid-path.patch: Likewise. * gnu/packages/xdisorg.scm (xsecurelock)[description]: Rewrite example code to use the ‘privileged-program(s)’ terminology. * doc/guix-cookbook.texi (Network bridge for QEMU): Likewise. * gnu/packages/disk.scm (udevil)[arguments]: Update a comment. Change-Id: I7f467e8743a3ef556cd89bac41509bf51d9edb30
* nls: Update translations.Florian Pelz2024-06-031-2/+3
| | | | | | | | | | | | * po/doc/guix-cookbook.sv.po: New file. * po/doc/local.mk: Add 'sv' cookbook. * po/doc/po4a.cfg (po4a_langs): Add 'sv'. * doc/local.mk: Add 'sv' cookbook. * doc/htmlxref.cnf: Update URLs for cookbook. * doc/build.scm (%cookbook-languages): Add 'sv'. * doc/guix-cookbook.texi (Top): Mention 'sv' cookbook. Change-Id: Ibfeb7254f583f1c8827e8c2756bbb02880bcba46
* doc: cookbook: Fix direnv example.Florian Pelz2024-06-031-2/+2
| | | | | | | | | | | | When replacing `guix environment' with `guix shell', I forgot to add a `--development' argument. Follow-up to 9c3a8a380bcfebdb77af61532e7bfec523d7bde8. * doc/guix-cookbook.texi (Environment management) [Guix environment via direnv]: Fix example. Change-Id: I0a0df33b3b547bfc3ada10c4648e593be6608070
* gnu: linux: Turn %default-extra-linux-options into a procedure.Maxim Cournoyer2024-05-291-8/+9
| | | | | | | | | | | | | | | | This is to allow version-specific options to the list of defaults. * gnu/packages/linux.scm (%default-extra-linux-options): Transform to... (default-extra-linux-options): ... this procedure, which accepts a 'version' argument. (make-linux-libre, linux-libre-arm-generic, linux-libre-arm-generic-5.10) (linux-libre-arm-generic-5.4, linux-libre-arm64-generic) (linux-libre-arm64-generic-5.10, linux-libre-arm64-generic-5.4) (linux-libre-riscv64-generic, linux-libre-mips64el-fuloong2e) (linux-libre-with-bpf): Adjust accordingly. * doc/guix-cookbook.texi (Customizing the Kernel): Adjust accordingly. Change-Id: Ifd3be8b7ed8699bada224a938dbc84205366ff3d
* configure.ac: Set default value for the 'prefix' variable.Maxim Cournoyer2024-05-251-1/+1
| | | | | | | | | | | | | | | The Guix standard configuration uses a localstatedir of /var and a sysconfdir of /etc. To ease things for everyone, make the default values match that standard expected configuration. See <https://lists.gnu.org/archive/html/guix-devel/2024-05/msg00003.html> for a related discussion. * configure.ac: Default $prefix to '' unless already set. * doc/contributing.texi (Building from Git): Streamline doc. * doc/guix-cookbook.texi (Guix environment via direnv): Likewise. Reviewed-by: Ludovic Courtès <ludo@gnu.org> Change-Id: I23cd12b58a842d246fbc9fdc740311c573eb0212
* doc: cookbook: Fix overlong lines.Florian Pelz2024-05-191-19/+48
| | | | | | | | | | | | | | | | | | | | | | Fixes <https://issues.guix.gnu.org/63680>. Thanks to Nigko Yerden for telling me ExecStart lines can be multi-line <https://lists.gnu.org/archive/html/bug-guix/2024-05/msg00153.html>. * doc/guix-cookbook.texi (System Configuration) [Customizing the Kernel]: Split lines. [Customizing a Window Manager]<StumpWM>: Likewise. [Setting up a bind mount]: Move comments. [Getting substitutes from Tor]: Split line with backslash. [Music Server with Bluetooth Audio]: Likewise. (Advanced package management)[Guix Profiles in Practice] <Basic setup with manifests>: Likewise. <Reproducible profiles>: Likewise. (Environment management)[Guix environment via direnv]: Likewise. (Installing Guix on a Cluster)[Setting Up a Head Node]: On Info and PDF, split ExecStart= command with backslash. Change-Id: I31ef5b0417b319c3f6946d65f83edafb86c8f36b
* system: Remove nss-certs from OS templates, adjust doc.Maxim Cournoyer2024-04-181-5/+3
| | | | | | | | | | | | | | | | | | | | | | | | | This is a follow-up to commit 86afaadb51 ("system: Add 'nss-certs' to %base-packages-networking.") * doc/guix-cookbook.texi (Running Guix on a Linode Server): Remove nss-certs from operating system's packages field. (Running Guix on a Kimsufi Server): Likewise. * doc/guix.texi (Using the Configuration System): Likewise. (X.509 Certificates): Adjust to mention nss-certs *is* part of %base-packages. * gnu/installer/services.scm (%system-services): Remove recommendation to install nss-certs. * gnu/system/examples/bare-bones.tmpl (host-name): Remove obsolete comments. * gnu/system/examples/desktop.tmpl (packages): Remove nss-certs. * gnu/system/examples/lightweight-desktop.tmpl (packages): Likewise. * gnu/system/examples/plasma.tmpl (packages): Likewise. * gnu/system/examples/raspberry-pi-64-nfs-root.tmpl (packages): Likewise. * gnu/system/examples/raspberry-pi-64.tmpl (packages): Likewise. * gnu/system/examples/vm-image.tmpl (packages): Likewise. * gnu/system/images/orangepi-r1-plus-lts-rk3328.scm (packages): Likewise. * gnu/system/images/pine64.scm (packages): Likewise. * gnu/system/install.scm (installation-os) [packages]: Likewise. Change-Id: If09123a69b987178bcb0aab61c4570c14fc1286f
* nls: Update translations.Florian Pelz2024-04-011-3/+5
| | | | | | | | | | | | | * po/guix/ar.po: New file. * po/guix/LINGUAS: Add 'ar'. * po/doc/guix-cookbook.pt_BR.po: New file. * po/doc/local.mk: Add 'pt_BR' cookbook. * doc/local.mk: Add 'pt_BR' cookbook. * doc/htmlxref.cnf: Update URLs for cookbook. * doc/build.scm (%cookbook-languages): Add 'ko', 'pt_BR'. * doc/guix-cookbook.texi (Top): Mention 'ko', 'pt_BR' cookbook. Change-Id: Id1846ca100263b3fc1fa2ed52654c670270ee809
* doc: cookbook: Fix typo.Maxim Cournoyer2024-03-311-1/+1
| | | | | | * doc/guix-cookbook.texi (Network bridge for QEMU): Fix typo. Change-Id: I32f88bd85157a6b2cee9f68840f9e77101596518
* doc: cookbook: Account for ‘guix pull’ in /etc/profile instructions.Ludovic Courtès2024-03-191-7/+10
| | | | | | | * doc/guix-cookbook.texi (Setting Up Compute Nodes): Include $HOME/.config/guix/current. Change-Id: I6c1c42394991af8f1fa7c2630bdb4b0aef946c2b
* doc: cookbook: Fix typo.Jonathan Brielmaier2023-12-311-1/+1
| | | | | | | | | Follow-up: f24b14767d362a84e6469682b4fe303b50f4b589 * doc/guix-cookbook.texi (Routed network for libvirt): Fix typo in section name. Change-Id: I1ba7ee2cba89764283f6a702a793ee9100585a87
* Add network bridge guide to the cookbook.Maxim Cournoyer2023-12-301-0/+236
| | | | Change-Id: If478196985aac7947067329957516f82bcb95ca4
* Update cookbook Texinfo menus.Maxim Cournoyer2023-12-181-1/+11
| | | | | | Automated via C-c C-u C-a with Emacs. Change-Id: I9e595430529f8f994988c1ac3c919bdaef930dc1
* doc: cookbook: Fix a broken cross-reference.Florian Pelz2023-10-251-1/+1
| | | | | | * doc/guix-cookbook.texi (Building with Guix): Adjust xref target. Change-Id: I87d6dc2648ff8898e3dd3b5ffca748193f14751e
* doc: cookbook: Add cross references to the manual regarding manifests.Ludovic Courtès2023-10-241-4/+8
| | | | | * doc/guix-cookbook.texi (The benefits of manifests) (Reproducible profiles): Add cross-references.
* doc: cookbook: Suggest ‘guix shell’ as an alternative to multiple profiles.Ludovic Courtès2023-10-241-23/+16
| | | | | | | | | | Multiple profiles are relatively hard to set up and maintain, especially for newcomers. Thus, suggest ‘guix shell’ as an alternative. * doc/guix-cookbook.texi (Guix Profiles in Practice): Add note linking to ‘guix shell’. (The benefits of manifests): Remove outdated info about ‘guix environment’ and profiles that may be GC’d. Update.
* doc: cookbook: Add “Software Development” chapter.Ludovic Courtès2023-10-111-1/+650
| | | | * doc/guix-cookbook.texi (Software Development): New chapter.
* cookbook: Add a recipe for running Guix System on a Kimsufi server.Thomas Ieong2023-09-011-0/+250
| | | | | | | * doc/guix-cookbook.texi (Running Guix on a Kimsufi Server): New section. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Modified-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
* doc: cookbook: Document the configuration of a Yubikey with KeePassXC.Maxim Cournoyer2023-09-011-0/+45
| | | | | | | * doc/guix-cookbook.texi (Using security keys) [Requiring a Yubikey to open a KeePassXC database]: New subsection. Series-to: 65354@debbugs.gnu.org
* image: Add mbr-raw-image-type and use by default.Josselin Poiret2023-08-251-3/+9
| | | | | | | | | | | | * gnu/system/image.scm (mbr-disk-image, mbr-raw-image-type): New variables. (qcow2-image-type): Inherit mbr-disk-image. * guix/scripts/system.scm (%default-options): Use mbr-raw-image-type by default. * gnu/tests/install.scm (run-install): Use mbr-raw in the tests. * doc/guix-cookbook.texi (Guix System Image API): Update the list of image types. * doc/guix.texi (Invoking guix system, System Images, image-type Reference): Add mbr-raw and switch documented default to it.
* doc: cookbook: Document how to disable the Yubikey OTP application.Maxim Cournoyer2023-08-171-3/+21
| | | | | | | * doc/guix-cookbook.texi (Using security keys) <Disabling OTP code generation for a Yubikey>: New subsection. Reviewed-by: John Kehayias <john.kehayias@protonmail.com>
* doc: cookbook: Document a dynamic DNS update mcron job.Maxim Cournoyer2023-08-161-2/+57
| | | | | | | * doc/guix-cookbook.texi (System Configuration) <Dynamic DNS mcron job>: New subsection. Reviewed-by: Ludovic Courtès <ludo@gnu.org>
* doc: Update Cookbook Texinfo menus.Maxim Cournoyer2023-08-161-31/+129
| | | | Automated via C-c C-u C-a (M-x texinfo-all-menus-update) in Emacs.
* doc: cookbook: Mention common SRFI-1 procedures.Ludovic Courtès2023-08-151-1/+29
| | | | | * doc/guix-cookbook.texi (A Scheme Crash Course): Add item about SRFI-1.
* doc: cookbook: Add 'use-modules' in gexp example.Ludovic Courtès2023-08-151-0/+3
| | | | | * doc/guix-cookbook.texi (A Scheme Crash Course): Add 'use-modules' line in gexp example.
* doc: cookbook: Link to "Package Modules".Ludovic Courtès2023-08-151-0/+3
| | | | | * doc/guix-cookbook.texi (A Scheme Crash Course): Add link to "Package Modules".
* doc: Mention gexps in the "Scheme Crash Course".Ludovic Courtès2023-07-141-7/+40
| | | | * doc/guix-cookbook.texi (A Scheme Crash Course): Add note on gexps.
* doc: cookbook: Update example my-libgit2 package.Efraim Flashner2023-06-051-6/+8
| | | | | * doc/guix-cookbook.texi (Packaging Tutorial): Improve the code quality of the example my-libgit2 package.
* services: screen-locker-service-type: Configurable PAM and setuid.muradm2023-06-041-1/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | screen-locker-service-type by default does both define PAM entry and make program setuid binary. Normally both methods are mutually exclusive, if binary has setuid set it does not really needs PAM, otherway around also similar, if PAM is enabled binary should not relay on setuid. Recent swaylock package now compiled with PAM support. When PAM support is compiled in, swaylock rejects executing if binary is also setuid program. This change turns screen-locker-configuration from strict PAM AND setuid to more flexible PAM AND/OR setuid. Allowing swaylock to be configured properly while supporting other screen locker preferences. * gnu/services/xorg.scm (screen-locker-configuration): Switch from define-record-type to define-configuration. [using-pam?]: New field to control PAM entry existence. [using-setuid?]: New field to control setuid binary existence. (screen-locker-pam-services): Should not make unix-pam-service if using-pam? is set to #f. (screen-locker-setuid-programs): Should not make program setuid program if using-setuid? is set to #f. (screen-locker-generate-doc): Internal function to generate configuration documentation. (screen-locker-service): Adapt to new screen-locker-configuration. * gnu/services/desktop.scm (desktop-services-for-system): Adapt to new screen-locker-configuration. * doc/guix.texi: Reflect new changes to screen-locker-configuration. Signed-off-by: Josselin Poiret <dev@jpoiret.xyz>
* nls: Update translations.Florian Pelz2023-05-311-3/+5
| | | | * doc/guix-cookbook.texi (Top): Mention Slovak.
* doc: cookbook: Remove outdated section about GUIX_PACKAGE_PATH.Ludovic Courtès2023-05-061-30/+53
| | | | | | | | | | | The section insisted on GUIX_PACKAGE_PATH, mentioned version 0.16, and didn't say much about channels, which made it look obsolete. * doc/guix-cookbook.texi (GUIX_PACKAGE_PATH): Remove section. (Guix channels): Rename to... (Channels): ... this. Merge most of the explanations previously in the GUIX_PACKAGE_PATH section. Say more about channels and add cross-references.
* doc: cookbook: Add "Installing Guix on a Cluster" chapter.Ludovic Courtès2023-01-091-19/+414
| | | | | | | | This is derived from the article at <https://hpc.guix.info/blog/2017/11/installing-guix-on-a-cluster/>, with clarifications and updates. * doc/guix-cookbook.texi (Installing Guix on a Cluster): New chapter.
* doc: cookbook: Remove 404 link to mitpress.mit.edu.Ludovic Courtès2023-01-061-4/+2
| | | | | * doc/guix-cookbook.texi (A Scheme Crash Course): Remove 404 link to mitpress.mit.edu.
* doc: cookbook: Fix commands in example.Florian Pelz2022-11-271-2/+2
| | | | | | | Fixes <https://issues.guix.gnu.org/59463>. Reported by Luca Cirrottola <luca.cirrottola@inria.fr>. * doc/guix-cookbook.texi (Reproducible profiles): Make it work.
* doc: Add a security keys section to the cookbook.Maxim Cournoyer2022-11-241-0/+62
| | | | | | * doc/guix-cookbook.texi (Top): Register new menu. (System Configuration): Likewise. (Using security keys): New section.
* doc: cookbook: Add section on MPD with bluealsa.Ricardo Wurmus2022-11-061-0/+191
| | | | | * doc/guix-cookbook.texi (Music Server with Bluetooth Audio): New section under System Configuration.
* doc: cookbook: Update detailed menu for "System Configuration".Ricardo Wurmus2022-11-061-2/+9
| | | | * doc/guix-cookbook.texi: Update menu.
* doc: Add chapter on containers to Cookbook.Ricardo Wurmus2022-10-131-1/+401
| | | | * doc/guix-cookbook.texi (Containers): New chapter.
* doc: cookbook: Link to "A Scheme Primer".Ludovic Courtès2022-07-081-15/+32
| | | | | * doc/guix-cookbook.texi (A Scheme Crash Course): Link to "A Scheme Primer". Group references in @quotation for clarity.
* doc: cookbook: Suggest 'guix shell'.Ludovic Courtès2022-07-081-3/+3
| | | | | | * doc/guix-cookbook.texi (A Scheme Crash Course): Suggest 'guix shell' instead of 'guix environment'. (Customizing the Kernel, The benefits of manifests): Likewise.
* doc: cookbook: Refer to the "Writing Manifests" manual node.Ludovic Courtès2022-06-011-4/+5
| | | | | | * doc/guix-cookbook.texi (Basic setup with manifests): Tweak introductory paragraph. Refer to the new "Writing Manifests" node of the manual.
* doc: cookbook: Fix cross-reference to SICP.Ludovic Courtès2022-04-081-1/+1
| | | | | | Reported by Greg Hogan <code@greghogan.com>. * doc/guix-cookbook.texi (A Scheme Crash Course): Fix xref to SICP.
* doc: cookbook: Fix cross-reference to the manual.Ludovic Courtès2022-04-081-1/+1
| | | | | | | Reported by Greg Hogan <code@greghogan.com>. * doc/guix-cookbook.texi (Extended example): Fix node name in xref to "package Reference".
* doc: cookbook: Update Tor onion service name.Ludovic Courtès2022-03-181-2/+7
| | | | | * doc/guix-cookbook.texi: New variable. (Getting substitutes from Tor): Use it.
generated by cgit v1.2.3 (git 2.47.1) at 2025-01-18 09:08:35 +0000