summary refs log tree commit diff
path: root/doc
AgeCommit message (Collapse)Author
2024-10-20doc: Do not use numeric values in readymedia extra-config.Arun Isaac
* doc/guix.texi (Miscellaneous Services)[DLNA/UPnP Services]: Use string value "60" instead of numeric value 60 in extra-config. Change-Id: Iea05409bb2f36fc4d0caafa375f0307bfae64a08
2024-10-20doc: Fix typo in readymedia example configuration.Arun Isaac
* doc/guix.texi (Miscellaneous Services)[DLNA/UPnP Services]: Change media-directoriess to media-directories. Change-Id: Iea05409bb2f36fc4d0caafa375f0307bfae64a08
2024-10-18gnu: services: Add readymedia service.Fabio Natali
* gnu/services/upnp.scm, gnu/tests/upnp.scm: New files. * gnu/local.mk (GNU_SYSTEM_MODULES): Add them. * doc/guix.texi (Miscellaneous Services): Document the service. Change-Id: I6a3c9db9e7504df308038343ed48e4409a323581 Signed-off-by: Arun Isaac <arunisaac@systemreboot.net>
2024-10-16Add copyright lines.Nigko Yerden
They are related to commit eb1515849efa3e0d3d838cb04ea87100084068a0. * doc/guix.texi: Add copyright message. * gnu/services/networking.scm: Add copyright message. Change-Id: Ica510fd6e80228f124f0c084403e1dea7c9baa1b Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-10-14doc: Define the purpose, membership, and creation of teams.Ludovic Courtès
* doc/contributing.texi (Teams): Define the purpose of teams; provide example; clarify membership and team creation. (Reviewing the Work of Others): Link to “Teams”. Change-Id: I5d75f69bc4653eb9da9c1d1f920718238ea83b9d
2024-10-14services: tor: Add support for pluggable transports.Nigko Yerden
Pluggable transports are programs that disguise Tor traffic, which can be useful in case Tor is censored. Pluggable transports cannot be configured by #:config-file file exclusively because Tor process is run via 'least-authority-wrapper' and cannot have access to transport plugin, which is a separate executable (Bug#70302, Bug#70332). * doc/guix.texi (Networking Services): Document 'tor-transport-plugin' data type and 'transport-plugins' option for 'tor-configuration. * gnu/services/networking.scm: Export 'tor-configuration-transport-plugins', 'tor-transport-plugin', 'tor-transport-plugin?', 'tor-plugin-role', 'tor-plugin-protocol', and 'tor-plugin-program'. (<tor-configuration>): Add 'transport-plugins' field. (<tor-transport-plugin>): New variable. (tor-configuration->torrc): Add content to 'torrc' computed-file. (tor-shepherd-service): Add file-system-mapping(s). Change-Id: I1b0319358778c7aee650bc843e021a6803a1cf3a Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-10-14image: Add support for btrfs.Roman Scherer
* gnu/build/image.scm (make-btrfs-image): New variable. * gnu/system/image.scm (system-disk-image): Support btrfs. Change-Id: I80a5b52ec478ce5927d6208e324cbb70282c647a Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-10-14image: Use file system options in make-vfat-image.Roman Scherer
* gnu/build/image.scm (make-vfat-image): Use file system options. Change-Id: I791aadd2803d1ef96fc79cf8910a74a0083d2b6e Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-10-14services: configuration: Document multiple configurations per field.Herman Rimm
* gnu/services/configuration.scm (generate-documentation): Filter for all configurations associated with each field-name. * doc/guix.texi (Complex Configurations): Describe use case for multiple field-names. Change-Id: I6d1e7b8858231aa05fda884b31a9bd0a48f07293 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-10-14doc: Document home-shepherd-configuration-daemonize?Dariqq
* gnu/home/services/shepherd.scm: Export home-shepherd-configuration-daemonize?. * doc/guix.texi (home-shepherd-configuration): Add entry for daemonize? field. Change-Id: Ifd1518c89fe8d5869d5e6469823dafd8457f24f1 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-10-14home: home-shepherd-configuration: Add silent? field.Dariqq
* gnu/home/services/shepherd.scm (home-shepherd-configuration): Add silent? field. (launch-shepherd-gexp): Conditionally invoke shepherd with --silent. * doc/guix.texi (home-shepherd-configuration): Document it. Change-Id: I1ce7a92c2777ebded39fe293b0bdcbd03562b4fc Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-10-14doc: Refer to ‘iso-codes’, not ‘iso-codes/pinned’.Ludovic Courtès
This effectively reverts 8e5c8303a414719c19a597247674be87fd500d45, which was unnecessary in this case and would break when evaluating ‘doc/build.scm’ against a previous Guix revision where ‘iso-codes/pinned’ is unbound. * doc/build.scm (localization-helper-module): Use ‘iso-codes’ rather than ‘iso-codes/pinned’. Change-Id: I95497fa474fb5ce89c7d2fe9bf0925a0cd438763
2024-10-14doc: Fix typos.Florian Pelz
* doc/guix.texi (Sound Services, Web Services, Miscellaneous Services, Invoking guix system, Sway window manager): Fix typos. Change-Id: I28c09ecb6034e4aae43ca6006b46fdb186832edd
2024-10-12doc: Add “Deprecation Policy” section.Ludovic Courtès
* doc/contributing.texi (Deprecation Policy): New node. (Commit Access): Link to ‘package-removal-policy’. Change-Id: I5d095559920a3d9b791b5d919aab4e2f2a0c2dee
2024-10-12home: services: Add 'home-sway-service-type'.Arnaud Daby-Seesaram
* gnu/home/services/sway.scm: New file. (home-sway-service-type): New variable. (sway-configuration->file): New procedure. (sway-configuration): New configuration record. (sway-bar): New configuration record. (sway-output): New configuration record. (sway-input): New configuration record. (point): New configuration record. (sway-color): New configuration record. (sway-border-color): New configuration record. (sway-mode): New configuration record. (flatmap): New procedure. * gnu/local.mk: Add gnu/home/services/sway.scm. * doc/guix.texi (Sway window manager): New node to document the above changes. Signed-off-by: Florian Pelz <pelzflorian@pelzflorian.de> Change-Id: I880261570c5afdb795f2ce18bac2b9a5c898677f
2024-10-08doc: Update documentation for wayland? option of gdm-configuration.Maxim Cournoyer
This is a follow-up to commit 06d01c610e ("services: gdm: Enable wayland by default."), which forgot updating the associated documentation. Change-Id: I3ea0402680e3e0f588db057988eb00af44ab4ae6
2024-10-07time-machine: Print profile path if no command is given.Tomas Volf
Instead of warning, print the profile path of the cached-channel-instance. * guix/scripts/time-machine.scm (guix-time-machine)[not command-line]: Print the profile directory. (show-help): Adjust usage message. * doc/guix.texi (Invoking guix time-machine): Document it. Change-Id: Id2c1ded514e6c5af45af9008ad1ef91beb509177 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-10-07services: Extend udev rules in joycond-service-type.Maxim Cournoyer
* gnu/services/games.scm (joycond-service-type): Also extend the udev service with the configured joycond package. * doc/guix.texi (Game Services): Update documentation. Change-Id: I9f7fb0da5cfc1f8a7e8bb5f2ce7161e5e66b2f5e
2024-10-07services: networking: Add 'version' field to dhcp-client-configuration.Maxim Cournoyer
* gnu/services/networking.scm (<dhcp-client-configuration>) [version]: New field. (dhcp-client-shepherd-service): Use 'match-record' instead of various accessors. Honor the new 'version field'. Include the version the PID file name when a non-default version is used. * doc/guix.texi (Networking Setup) <dhcp-client-configuration> [version]: Document it. Change-Id: I6236ae160967c95fe7a2c1785821cc9b0c183e77
2024-09-28gnu: iso-codes: Rename to iso-codes/pinned.Roman Scherer
* gnu/packages/iso-codes.scm (iso-codes): Rename to… (iso-codes/pinned): … this. * doc/build.scm, gnu/installer.scm, gnu/packages/fcitx.scm, gnu/packages/fcitx5.scm, gnu/packages/gnome.scm, gnu/packages/gstreamer.scm, gnu/packages/gtk.scm, gnu/packages/ibus.scm, gnu/packages/kde-frameworks.scm, gnu/packages/kde-plasma.scm, gnu/packages/mate.scm, gnu/packages/photo.scm, gnu/packages/video.scm: Adjust accordingly. Change-Id: Ia98fee15a27009583fee822cf411512727b1aa27 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-09-18services: guix-build-coordinator-agent: Add extra-options.Andreas Enge
* gnu/services/guix.scm (<guix-build-coordinator-agent-configuration>): Add field extra-options. (guix-build-coordinator-agent-shepherd-services): Add and use EXTRA-OPTIONS argument. * doc/guix.texi (Guix Services): Adapt the documentation. Change-Id: I9e7e258e03e2b6553aa1570f5fcfaf3b0ada3e15 Reviewed-by: Maxim Cournoyer <maxim.cournoyer@gmail>
2024-09-18services: guix-build-coordinator-agent: Remove defaults.Andreas Enge
* gnu/services/guix.scm (<guix-build-coordinator-agent-configuration>) [max-parallel-builds, max-parallel-uploads]: Set default to #f. (guix-build-coordinator-agent-shepherd-services): Check for max-parallel-builds. * doc/guix.texi (Guix Services): Adapt the documentation. If set to #f, the default values are now taken as the defaults of the guix-build-coordinator-agent command. Change-Id: Ide6dde0e88aa0dc851b6295095f414ca2ddc72ac Reviewed-by: Maxim Cournoyer <maxim.cournoyer@gmail>
2024-09-16services: admin: Support rebooting after an unattended upgradeRichard Sent
* gnu/services/admin.scm (unattended-upgrade-configuration): Add reboot? field. When truthy, unattended upgrade will stop the shepherd root service, triggering a reboot. * doc/guix.texi (Unattended Upgrades): Document it. Change-Id: I0af659b3c318421b1a7baa94dde3dadacc1fa10d Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-09-01doc: Add more newline.Tobias Geerinckx-Rice
* doc/guix.texi (partition Reference): Enumerate one list per paragraph. Change-Id: I939a73fa8a3e5063e2d9441d7a64cc4a41862abd
2024-09-01doc: Committers are people.Tobias Geerinckx-Rice
* doc/contributing.texi (Commit Access): Use ‘who’. Change-Id: I88304640f8f184f7ec0caae5bb862c7f170c0d79
2024-09-01doc: Add newlines.Tobias Geerinckx-Rice
* doc/contributing.texi (Commit Access): Split one trademark Guix megagraph™ into three of your human paragraphs. No other change. Change-Id: Ifd2a9166b1dfe1a22dcd0811044a408325cc22cb
2024-09-09doc: cookbook: Fix typo in screen-locker-service-typeRoman Scherer
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>
2024-09-06guix build: ‘--log-file’ honors the configured substitute URLs.Ludovic Courtès
* guix/scripts/build.scm (guix-build): When defining ‘urls’, add ‘substitute-urls’ call. * doc/guix.texi (Additional Build Options): Adjust ‘--log-file’ documentation. Change-Id: I40f0647efe64ba3a63a6379b8da80b0da8910f48
2024-09-04doc: Add index entries for ‘assume-file-name’ & co.Ludovic Courtès
* doc/guix.texi (G-Expressions): Add index entries for ‘assume-file-name’ and ‘assume-source-relative-file-name’. Change-Id: Iee51fb09f4cbd32dacf90f03cafca973e8c993f8
2024-09-04gexp: Add ‘assume-source-relative-file-name’.Richard Sent
* guix/gexp.scm (assume-source-relative-file-name): New macro. (local-file): Use assume-source-relative-file-name to look up a non-literal file relative to the current source directory. * doc/guix.texi (G-expressions): Document it. * tests/gexp.scm ("local-file, non-literal source relative file name"): New test. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Change-Id: I18573c8c7a6c87e8351b34412f9d26bb23b068b4
2024-09-03scripts: style: Add 'alphabetical-sort' option.Herman Rimm
* guix/scripts/style.scm (show-help): Describe option. (order-packages): Add procedure. (format-whole-file): Add 'order?' argument. (%options): Add 'alphabetical-sort' option. (guix-style): Alphabetically order packages in files. * tests/guix-style.sh: Test alphabetical ordering. * doc/guix.texi (Invoking guix style): Document option. Change-Id: I4aa7c0bd0b6d42529ae7d304587ffb10bf5f4006 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-09-02doc: build: Handle when guile source is packed with zstd.Florian Pelz
* doc/build.scm (guile-manual): Also include zstd in PATH. Change-Id: Iff49825fe84121bff777ed45c03fb14af0a0e719
2024-08-31services: agate: Change variable names and add system test.Rodion Goritskov
* doc/guix.texi (Web Services): Update documentation for agate-service-type. * gnu/services/web.scm (agate-configuration): Rename certs, addr, lang and central-conf variables. * gnu/tests/web.scm (%test-agate): Add system test for agate-service-type. Change-Id: Ie14814fca1d5158acd67899da0c3fc2c5b586c72 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-08-31doc: Document changes to `copy-recursively'.Romain GARBAGE
* doc/guix.texi: Document new key `select?' in `copy-recursively'. Change-Id: I4b14ae5a1b40e0939456604f75597b5596b76f83 Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2024-08-31build: copy-build-system: Allow specifying different output labels.Bruno Victal
* guix/build/copy-build-system.scm: Introduce '#:output' parameter to specify which output label to use for a given rule. * doc/guix.texi (Build Systems): Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-08-31search-paths: Add $XML_CATALOG_FILES and $SGML_CATALOG_FILES.Bruno Victal
These variables are used by some packages for XML/SGML catalog lookups. * guix/search-paths ($XML_CATALOG_FILES, $SGML_CATALOG_FILES): New variable, extracted from … * gnu/packages/xml.scm (libxml2, opensp)[native-search-paths]: … here. Refer to the variables from (guix search-paths) respectively. * gnu/packages/perl.scm (perl-app-xml-docbook-builder)[native-search-paths]: Use $XML_CATALOG_FILES. * doc/guix.texi (Search Paths): Update documentation to reflect changes. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2024-08-18doc: Fix typos.Tobias Geerinckx-Rice
* doc/guix.texi (Desktop Services): Transpose 2 adjacent bytes. (Complex Configurations): Add a missing one. Change-Id: Ia03404b500e22ed0f8a414e6b63a8f3cc6270379
2024-08-28home: services: Add home-beets-service-type.Fabio Natali
* gnu/home/services/music.scm: New file. * gnu/local.mk: Add this. * doc/guix.texi: Document this. Change-Id: Idc23a68276cb3fb07733bb38bc38b1c5a63c1d6a Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-08-26doc: Remove duplicate search paths instructions.Florian Pelz
* doc/guix.texi (Invoking guix pull): Remove instructions obsoleted by Binary Installation instructions. Change-Id: I18274aa8bacd11de8ee72bd83c817f945468cc13
2024-08-18Replace some more occurrences of ‘setuid-programs’.Tobias Geerinckx-Rice
* 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
2024-08-21services: elogind-configuration: Add more sleep configurationsMorgan Smith
* gnu/services/desktop.scm (<elogind-configuration>): Allow actions to be set to 'suspend-then-hibernate'. Add configuration for 'hibernate-delay-seconds' and 'suspend-estimation-seconds'. * doc/guix.texi (Desktop Services): Add documentation for 'hibernate-delay-seconds' and 'suspend-estimation-seconds'. Change-Id: Icf788fcc88451aa6174a608fbed309961b847430 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-08-11privilege: Add POSIX capabilities(7) support.Tobias Geerinckx-Rice
* gnu/system/privilege.scm (<privileged-program>): Add a field representing the program's POSIX capabilities. (privileged-program-capabilities): New public procedure. * doc/guix.texi (Privileged Programs): Document it. * gnu/build/activation.scm (activate-privileged-programs): Take a LIBCAP package argument providing setcap(8) to apply said capabilities. * gnu/services.scm (privileged-program->activation-gexp): Pass said package argument where supported. Include privileged-program-capabilities in the compatibility hack.
2024-08-11system: Add privileged-programs to <operating-system>.Tobias Geerinckx-Rice
* gnu/system.scm (<operating-system>): Add new privileged-programs field, that defaults to… (%default-privileged-programs): …this new variable, renamed from… (%setuid-programs): …this, which is now defined as the empty list. * doc/guix.texi (Setuid Programs): Rename this… (Privileged Programs): …to this. Adjust all refs. Update all mentions of ‘setuid’ (whether in prose, variable names, or code samples) to use the new ‘privilege[d]’ terminology instead. (operating-system Reference, X Window, Invoking guix system) (Service Reference): Adjust likewise.
2024-08-11services: setuid-program: Populate /run/privileged/bin.Tobias Geerinckx-Rice
Create /run/setuid-programs compatibility symlinks so that we can migrate all users (both package and human) piecemeal at our leisure. Apart from being symlinks, this should be a user-invisible change. * gnu/build/activation.scm (%privileged-program-directory): New variable. [activate-setuid-programs]: Put privileged copies in %PRIVILEGED-PROGRAM-DIRECTORY, with compatibility symlinks to each in %SETUID-DIRECTORY. * gnu/services.scm (setuid-program-service-type): Update docstring. * doc/guix.texi (Setuid Programs): Update @file{} name accordingly.
2024-08-11doc: Restructure the list of desktop services.Tobias Geerinckx-Rice
* doc/guix.texi (Desktop Services): Use a straight list for the list of service types, rather than hiding them in one growing paragraph of prose. Explain their purpose in general terms beneath it. Change-Id: I2408ccf38dd62323138854cc5aa46051d2a076ac
2024-08-11doc: Rewrite obsolete list of limitations.Tobias Geerinckx-Rice
* doc/guix.texi (Limitations): Now that KDE Plasma is available, rewrite the seemingly-exhaustive list to be more general. Change-Id: I41450302837c963d5f811211e5a498a04f938e55
2024-08-16doc: Fix punctuation and style.Florian Pelz
Follow-up to de714bcb46d61922e0efc10783ea23fb0202f583. * doc/guix.texi (Setting Up the Daemon): Fix typos. Reported-by: Ludovic Courtès <ludo@gnu.org> Change-Id: Id3e49f3b401e8b9ce2aa4c2588ae33cf25e2ca2d
2024-08-15doc: Improve example for guix-for-channels.Tomas Volf
The example was missing the (gnu packages package-management) import, so it did not work. While the module was mentioned below, I overlooked the sentence. So add it also into the example to make it more obvious. * doc/guix.texi (Customizing the System-Wide Guix): Add import to example. Change-Id: Ibc5b0be87d40531397660a3b0747f83b851b004b Signed-off-by: Florian Pelz <pelzflorian@pelzflorian.de>
2024-08-10doc: Setting Up the Daemon: Give guidance to whom this section is useful.Florian Pelz
* doc/guix.texi (Setting Up the Daemon): Specify intended audience. Change-Id: I784c5f720aa87bddb6455e42181a1e9de5d7ec9a
2024-08-04services: containerd: Provision separately from docker service.Oleg Pykhalov
containerd can operate independently without relying on Docker for its configuration. * gnu/services/docker.scm (docker-configuration): Deprecate containerd field. (containerd-configuration, containerd-service-type): New variables. (docker-shepherd-service): Use containerd-configuration. Delete duplicated variable binding. Allow to configure environment variables. (docker-service-type): Delete extension with containerd-service-type. * gnu/tests/docker.scm (%docker-os, %oci-os): Add containerd service. (run-docker-test, run-docker-system-test, run-oci-container-test): Run containerd service. * doc/guix.texi (Miscellaneous Services): Document containerd-service-type. Change-Id: Ife0924e50a3e0aa2302d6592dae51ed894600004