aboutsummaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAge
* doc: Explain how to use local guix repositories.André Batista2023-02-23
| | | | | | | * doc/guix.texi (Using a Custom Guix Channel): Add note and example on how to exempt a local guix repository from git ownership checks. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
* doc: Further clarify documentation of 'host' and 'hosts-service-type'.Ludovic Courtès2023-02-23
| | | | | * doc/guix.texi (Base Services): Use docstring of 'host' to document it and remove @deftp. Introduce example. Fix typos in file name.
* services: hosts: Do not export '%host'.Ludovic Courtès2023-02-23
| | | | | | | This was not meant to be exported. * gnu/services/base.scm (%host): Do not export. * doc/guix.texi (Base Services): Remove mention.
* doc: hosts-service-type: Improve documentation.Bruno Victal2023-02-23
| | | | | | * doc/guix.texi (Base Services): Improve hosts-service-type documentation. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* doc: hosts-service-type: Relocate to Base Services.Bruno Victal2023-02-23
| | | | | | | | | | hosts-service-type is under (gnu services base) * doc/guix.texi: Merge duplicated copyright lines. (Service Reference): Move hosts-service-type to ... (Base Services): ... here. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* pack: Add RPM format.Maxim Cournoyer2023-02-19
| | | | | | | | | | | | * guix/rpm.scm: New file. * guix/scripts/pack.scm (rpm-archive): New procedure. (%formats): Register it. (show-formats): Add it. (guix-pack): Register supported extra-options for the rpm format. * tests/pack.scm (rpm-for-tests): New variable. ("rpm archive can be installed/uninstalled"): New test. * tests/rpm.scm: New test. * doc/guix.texi (Invoking guix pack): Document it.
* build-system: Add tree-sitter-build-system.Pierre Langlois2023-02-12
| | | | | | | | | * guix/build-system/tree-sitter.scm: New module. * guix/build/tree-sitter-build-system.scm: Likewise. * Makefile.am (MODULES): Add them. * doc/guix.texi: Document it. Signed-off-by: Andrew Tropin <andrew@trop.in>
* doc: Fix documentation typo.Remco van 't Veer2023-02-11
| | | | | | * doc/guix.texi (Service Reference): Fix typo. Signed-off-by: Julien Lepiller <julien@lepiller.eu>
* services: lightdm: Sync documentation with source.Bruno Victal2023-02-08
| | | | | | | | | | Table entry @item nodes cannot span multiple lines. * gnu/services/lightdm.scm (lightdm-gtk-greeter-configuration): Fix cursor-theme-size description. * doc/guix.texi (lightdm-service-type): Sync with source. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
* services: Add block-facebook-hosts-service-type.Bruno Victal2023-02-09
| | | | | | | | | | | | Deprecates %facebook-host-aliases in favour of using hosts-service-type service extensions. * gnu/services/networking.scm (block-facebook-hosts-service-type): New variable. (%facebook-host-aliases): Deprecate variable. * doc/guix.texi: Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* system: Deprecate hosts-file.Bruno Victal2023-02-09
| | | | | | | | | | | | | | | | | | | * gnu/system.scm (operating-system-hosts-file): Deprecate procedure. (warn-hosts-file-field-deprecation): New procedure, helper for deprecated variable. (operating-system)[hosts-file]: Use helper to warn deprecated field. (local-host-aliases): Mark as deprecated. (local-host-entries): New procedure. (operating-system-default-essential-services, hurd-default-essential-services): Use hosts-service-type. Use '%operating-system-hosts-file' and 'local-host-entries'. (default-/etc/hosts): Remove procedure. (operating-system-etc-service): Remove hosts file. * doc/guix.texi (operating-system Reference) (Networking Services) (Virtualization Services): Rewrite documentation entries to use hosts-service-type. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
* services: Add hosts-service-type.Bruno Victal2023-02-09
| | | | | | | | | * gnu/services/base.scm (<host>): New record type. (host): New procedure. (hosts-service-type): New variable. * doc/guix.texi (Service Reference): Document it. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
* services: Add mympd-service-type.Bruno Victal2023-02-05
| | | | | | | | * gnu/services/audio.scm (mympd-service-type): New variable. * gnu/tests/audio.scm (%test-mympd): New variable. * doc/guix.texi: Document it. Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com>
* services: mpd: Do not hardcode environment variables.Bruno Victal2023-02-05
| | | | | | | | | | | | | | | | | | | | | | | | | | Services should not expect for XDG_RUNTIME_DIR to be set. Inferring from the past comment, this seemed to resolve an issue when the service was launched with an _interactive_ user-account, which tends to have this variable set by the login-manager. This is not the case for system accounts and setting this variable results in PulseAudio (launched by the same system user) failing to start since it attempts to use a nonexistent directory. Ideally, this service should have a home-service counterpart but the old behavior can be emulated by setting the environment-variables field to: (environment-variables (list (string-append "XDG_RUNTIME_DIR=/run/user/" (number->string (passwd:uid (getpwnam "myuser")))))) * gnu/services/audio.scm (mpd-configuration)[environment-variables]: New field. (mpd-shepherd-service)[start]: Use new field. * doc/guix.texi (Audio Services)[Music Player Daemon]: Document it. Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com>
* services: mpd: Refactor MPD service.Bruno Victal2023-02-05
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Refactor mpd-service-type to support additional mpd.conf directives and move activation-service-extension into service constructor. * gnu/services/audio.scm (mpd-plugin, mpd-partition): New records. (mpd-serialize-boolean): Alias to and integrate logic into... (mpd-serialize-field): ... this. (mpd-serialize-list-of-string): New variable. (mpd-plugin?, mpd-partition?, list-of-string?, list-of-symbol?) (list-of-mpd-plugin?, list-of-mpd-partition?) (list-of-mpd-plugin-or-output?, port?): New variables. (mpd-file-name, mpd-service-activation): Remove variables. (mpd-configuration) [package, group, shepherd-requirement, log-file, log-level, music-directory] [playlist-directory, endpoints, database, partitions, neighbors, inputs] [archive-plugins, input-cache-size, decoders, resampler, filters] [playlist-plugins, extra-options]: New fields. [music-dir, playlist-dir, address]: Deprecate shorthand fields. [db-file, state-file, sticker-file, port, outputs]: Change admissible type. (mpd-shepherd-service) [actions]: New shepherd actions: 'reopen' and 'configuration'. [requirement]: Splice with 'shepherd-requirement' field. [start]: Use 'package' field. Remove #:log-file parameter. Move activation-service extension into constructor. (mpd-accounts): Honor user and group names from configuration. (mpd-log-rotation): New procedure. (mpd-service-type)[extensions]: Add rottlog-service-type extension. Remove activation-service-type extension. (mpd-output-name, mpd-output-type, mpd-output-enabled?, mpd-output-format) (mpd-output-tags?, mpd-output-always-on?, mpd-output-mixer-type) (mpd-output-replay-gain-handler, mpd-output-extra-options) (mpd-plugin-plugin, mpd-plugin-name, mpd-plugin-enabled?) (mpd-plugin-extra-options) (mpd-partition-name, mpd-partition-extra-options) (mpd-configuration-package, mpd-configuration-user) (mpd-configuration-group, mpd-configuration-shepherd-requirement) (mpd-configuration-log-file, mpd-configuration-log-level) (mpd-configuration-music-directory, mpd-configuration-music-dir) (mpd-configuration-playlist-directory, mpd-configuration-playlist-dir) (mpd-configuration-db-file, mpd-configuration-state-file) (mpd-configuration-sticker-file, mpd-configuration-default-port) (mpd-configuration-endpoints, mpd-configuration-address) (mpd-configuration-database, mpd-configuration-partitions) (mpd-configuration-neighbors, mpd-configuration-inputs) (mpd-configuration-archive-plugins, mpd-configuration-input-cache-size) (mpd-configuration-decoders, mpd-configuration-resampler) (mpd-configuration-filters, mpd-configuration-outputs) (mpd-configuration-playlist-plugins, mpd-configuration-extra-options): Export accessors. * doc/guix.texi (Audio Services)[Music Player Daemon]: Update documentation. Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com>
* services: nar-herder: Add cached compression support.Christopher Baines2023-02-03
| | | | | | | | | | | | | | | | | * gnu/services/guix.scm (<nar-herder-cached-compression-configuration>): New record type. (nar-herder-configuration-cached-compressions, nar-herder-configuration-cached-compression-min-uses, nar-herder-configuration-cached-compression-workers, nar-herder-configuration-cached-compression-nar-source, nar-herder-cached-compression-configuration, nar-herder-cached-compression-configuration?, nar-herder-cached-compression-configuration-type, nar-herder-cached-compression-configuration-level, nar-herder-cached-compression-configuration-directory, nar-herder-cached-compression-configuration-directory-max-size): New procedures. * doc/guix.texi (Guix Services): Document this.
* home: services: fontutils: Add service value.Giacomo Leidi2023-01-31
| | | | | | | | | * gnu/home/services/fontutils.scm (add-fontconfig-config-file): Add support for multiple paths; (home-fontconfig-service-type): Honor it; * doc/guix.texi (Fonts Services): Document it. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
* doc: Substitute @deffn usage with @defvar for Scheme variables.Bruno Victal2023-01-23
| | | | | | | | | | | * doc/guix.texi (Base Services) (Networking Setup) (Networking Services) (Printing Services) (Desktop Services) (Sound Services) (Database Services) (Mail Services) (Messaging Services) (File-Sharing Services) (Web Services) (DNS Services) (Power Management Services) (Virtualization Services) (Linux Services) (Miscellaneous Services): Substitute @deffn usage with @defvar for Scheme variables. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* doc: Use @defvar instead of @defvr for Scheme variables.Bruno Victal2023-01-23
| | | | | | | | | | | | | | | | | | | * doc/guix.texi (Build Systems) (Search Paths) (The Store) (The Store Monad) (File Systems) (Mapped Devices) (User Accounts) (Locales) (Base Services) (Scheduled Job Execution) (Log Rotation) (Networking Setup) (Networking Services) (Unattended Upgrades) (X Window) (Desktop Services) (Database Services) (Messaging Services) (Kerberos Services) (Web Services) (Certificate Services) (VPN Services) (Network File System) (Samba Services) (Power Management Services) (Audio Services) (Virtualization Services) (Linux Services) (Hurd Services) (Miscellaneous Services) (Setuid Programs) (Name Service Switch) (Initial RAM Disk) (Service Reference) (Shepherd Services) (Essential Home Services) (Mcron Home Service) (Power Management Home Services) (Shepherd Home Service) (Secure Shell) (Desktop Home Services) (Guix Home Services) (Supported Platforms) (Instantiate an Image) (image-type Reference): Use @defvar instead of @defvr for Scheme variables. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* doc: Fix incorrect use of @defvar.Bruno Victal2023-01-23
| | | | | | | | * doc/guix.texi (Monitoring Services) (VNC Services) (Samba Services) (Game Services) (PAM Mount Service) (Guix Services): Fix incorrect use of @defvar. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* doc: Document the 'release-monitoring-url' package property.Ludovic Courtès2023-01-23
| | | | | * doc/guix.texi (Invoking guix refresh): Mention the 'release-monitoring-url' property.
* services: hpcguix-web: Provide default values.Ludovic Courtès2023-01-22
| | | | | | | * gnu/services/web.scm (<hpcguix-web-configuration>)[specs]: Default to #f. (hpcguix-web-shepherd-service): Do not pass '--config' when SPECS is #f. (hpcguix-web-service-type)[default-value]: New field. * doc/guix.texi (Web Services): Adjust accordingly.
* gnu: hpcguix-web: Update to 0.3.0.Ludovic Courtès2023-01-22
| | | | | | | | | * gnu/packages/web.scm (hpcguix-web): Update to 0.3.0. [inputs]: Add GUILE-SYNTAX-HIGHLIGHT. [arguments]: In 'wrap-program' phase, take guile-syntax-highlight into account. * gnu/tests/web.scm (%hpcguix-web-specs): Remove 'define'. * doc/guix.texi (Web Services): Adjust accordingly.
* doc: Fix Xvnc service example.Maxim Cournoyer2023-01-20
| | | | | | | Reported by bost on #guix (thank you!) * doc/guix.texi (VNC Services): Add the missing host argument in the SSH command example.
* doc: Fix typo.Maxim Cournoyer2023-01-18
| | | | | * doc/guix.texi (Cross-Compilation): Replace "penaly" with "penalty". Replace "few users" with "fewer users".
* doc: Use the right cross-reference command.Ludovic Courtès2023-01-17
| | | | * doc/guix.texi (Package Transformation Options): Use @pxref, not @ref.
* services: connman: Add iwd backend support.Declan Tsien2023-01-16
| | | | | | | | | * gnu/services/networking.scm (connman-configuration)[iwd?]: New field. (connman-shepherd-service): Add iwd? logic, remove wpa-supplicant requirement. * doc/guix.texi: Add information about connman-configuration iwd? option. Co-authored-by: Andrew Tropin <andrew@trop.in> Signed-off-by: Andrew Tropin <andrew@trop.in>
* doc: Fix erroneous copyright line.Maxim Cournoyer2023-01-16
| | | | * doc/guix.texi: Fix copyright line for Antero Mejr.
* scripts: repl: Add -i, --interactive flag.Antero Mejr2023-01-16
| | | | | | | | * guix/scripts/repl.scm (%options): Add -i, --interactive flag. (guix-repl): Honor -i, --interactive flag. * doc/guix.texi (Invoking guix repl): Add documentation for -i, --interactive. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
* scripts: repl: Add --list-types flag.Antero Mejr2023-01-16
| | | | | | | * guix/scripts/repl.scm (%options): Add --list-types. * doc/guix.texi (Invoking guix repl): Add documentation for --list-types. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
* transformations: Add '--with-version'.Ludovic Courtès2023-01-16
| | | | | | | | | | | | | | | This is a followup to 8aeccc6240ec45f0bc7bed655e0c8149ae4253eb. * guix/transformations.scm (package-with-upstream-version): New procedure. (transform-package-latest)[package-with-latest-upstream]: Remove. Use 'package-with-upstream-version' instead. (transform-package-version): New procedure. (%transformations, %transformation-options) (show-transformation-options-help/detailed): Add '-with-version'. * tests/transformations.scm ("options->transformation, with-version"): New test. * doc/guix.texi (Package Transformation Options): Document '--with-version'. (Defining Package Variants): Mention it.
* services: greetd: Add 'source-profile?' configuration field.Jelle Licht2023-01-15
| | | | | | | | * gnu/services/base.scm (<greetd-terminal-configuration>)[source-profile?]: New field. (make-greetd-terminal-configuration-file): Serialize new field to configuration file. * doc/guix.texi (Base Services): Document it.
* gnu: services: Add joycond-service.David Thompson2023-01-14
| | | | | | | * gnu/services/games.scm (joycond-configuration): New configuration type. (joycond-shepherd-service): New procedure. (joycond-service-type): New variable. * doc/guix.texi (Game Services): Document it.
* doc: Clarify how to use the #:go key of go-build-system.Leo Famulari2023-01-11
| | | | | | This is a followup to commit 9ec62d1b9c55104f9ab81b95d82988c627a23415. * doc/guix.texi (Build Systems): Clarify the '#:go' key.
* doc: Document the #:go key of the Go build system.Leo Famulari2023-01-11
| | | | * doc/guix.texi (Build Systems): Document '#:go'.
* doc: contributing: Note '-v REVISION' bug in 'git send-email'.(2023-01-11
| | | | | | | | * doc/contributing.texi ("Submitting Patches")["Sending a Patch Series"]: Note that a bug in 'git send-email' means '-v REVISION' (with a space) will not work. Signed-off-by: Christopher Baines <mail@cbaines.net>
* doc: contributing: Tweak the Commit Policy.Christopher Baines2023-01-11
| | | | | | | | | | | | | | | | | | | | | | | Add more examples of when it can be appropriate to push changes without review, as I think this can be appropriate in the case of trivial changes (as mentioned before), but also non-trivial fixes. No longer suggest pushing simple new packages or package upgrades (that don't cause lots of rebuilds) without sending to guix-patches. Now there's some automation for testing changes sent to guix-patches, sending changes there before pushing can mean that more rigorous testing takes place and help speed up substitutes becoming available. This is true, even if no human review takes place. Only suggest waiting one week for review for simpler changes, wait two weeks for more significant changes. Also, reorder some of the information in this section so it's grouped together better. * doc/contributing.texi (Commit Policy): Tweak. Signed-off-by: Christopher Baines <mail@cbaines.net>
* doc: Fix documentation typo.jgart2023-01-10
| | | | | | * doc/guix.texi (VNC Services): Fix typo. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
* services: unattended-upgrade: Add 'operating-system-expression' field.Giacomo Leidi2023-01-10
| | | | | | | | | * gnu/services/admin.scm (<unattended-upgrade-configuration>) [operating-system-expression]: New field. (unattended-upgrade-mcron-jobs): Honor it. * doc/guix.texi (Unattended Upgrades): Document it. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
* services: git-daemon: Deprecate 'git-daemon-service' procedure.Bruno Victal2023-01-10
| | | | | | | | | * gnu/services/version-control.scm (git-daemon-service): Define with 'define-deprecated' * doc/guix.texi (Version Control Services): Replace with 'git-daemon-service-type' Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* doc: Fix <openntpd-configuration> openntpd default.Tobias Geerinckx-Rice2023-01-08
| | | | | | * doc/guix.texi (Networking Services): <openntpd-configuration>'s openntpd field takes a package: it does not default to a FILE-APPEND call.
* doc: cookbook: Add "Installing Guix on a Cluster" chapter.Ludovic Courtès2023-01-09
| | | | | | | | 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.
* 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: cookbook: Remove 404 link to mitpress.mit.edu.Ludovic Courtès2023-01-06
| | | | | * doc/guix-cookbook.texi (A Scheme Crash Course): Remove 404 link to mitpress.mit.edu.
* 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.
generated by cgit v1.2.3 (git 2.45.0) at 2024-12-18 07:24:21 +0000