diff options
Diffstat (limited to 'doc/guix.texi')
| -rw-r--r-- | doc/guix.texi | 170 |
1 files changed, 154 insertions, 16 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index efc59c1aaf..d2038d18e1 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -21,7 +21,7 @@ @set SUBSTITUTE-URL https://@value{SUBSTITUTE-SERVER} @copying -Copyright @copyright{} 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 Ludovic Courtès@* +Copyright @copyright{} 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Ludovic Courtès@* Copyright @copyright{} 2013, 2014, 2016 Andreas Enge@* Copyright @copyright{} 2013 Nikita Karetnikov@* Copyright @copyright{} 2014, 2015, 2016 Alex Kost@* @@ -29,7 +29,7 @@ Copyright @copyright{} 2015, 2016 Mathieu Lirzin@* Copyright @copyright{} 2014 Pierre-Antoine Rault@* Copyright @copyright{} 2015 Taylan Ulrich Bayırlı/Kammer@* Copyright @copyright{} 2015, 2016, 2017, 2019 Leo Famulari@* -Copyright @copyright{} 2015, 2016, 2017, 2018, 2019 Ricardo Wurmus@* +Copyright @copyright{} 2015, 2016, 2017, 2018, 2019, 2020 Ricardo Wurmus@* Copyright @copyright{} 2016 Ben Woodcroft@* Copyright @copyright{} 2016, 2017, 2018 Chris Marusich@* Copyright @copyright{} 2016, 2017, 2018, 2019 Efraim Flashner@* @@ -49,7 +49,7 @@ Copyright @copyright{} 2017 Christopher Allan Webber@* Copyright @copyright{} 2017, 2018, 2019 Marius Bakke@* Copyright @copyright{} 2017, 2019 Hartmut Goebel@* Copyright @copyright{} 2017, 2019 Maxim Cournoyer@* -Copyright @copyright{} 2017, 2018, 2019 Tobias Geerinckx-Rice@* +Copyright @copyright{} 2017, 2018, 2019, 2020 Tobias Geerinckx-Rice@* Copyright @copyright{} 2017 George Clemmer@* Copyright @copyright{} 2017 Andy Wingo@* Copyright @copyright{} 2017, 2018, 2019 Arun Isaac@* @@ -69,6 +69,7 @@ Copyright @copyright{} 2019 Jakob L. Kreuze@* Copyright @copyright{} 2019 Kyle Andrews@* Copyright @copyright{} 2019 Alex Griffin@* Copyright @copyright{} 2019 Guillaume Le Vaillant@* +Copyright @copyright{} 2020 Leo Prikler@* Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or @@ -2245,8 +2246,8 @@ bootloaders. Once you are done partitioning the target hard disk drive, you have to create a file system on the relevant partition(s)@footnote{Currently -Guix System only supports ext4 and btrfs file systems. In particular, code -that reads file system UUIDs and labels only works for these file system +Guix System only supports ext4, btrfs, and JFS file systems. In particular, +code that reads file system UUIDs and labels only works for these file system types.}. For the ESP, if you have one and assuming it is @file{/dev/sda1}, run: @@ -14154,8 +14155,8 @@ Package object of the Open vSwitch. @defvr {Scheme Variable} pagekite-service-type This is the service type for the @uref{https://pagekite.net, PageKite} service, a tunneling solution for making localhost servers publicly visible, even from -behind NAT or restrictive firewalls. The value for this service type is a -@code{pagekite-configuration} record. +behind restrictive firewalls or NAT without forwarded ports. The value for +this service type is a @code{pagekite-configuration} record. Here's an example exposing the local HTTP and SSH daemons: @@ -15951,6 +15952,58 @@ pcm.!default @{ See @uref{https://www.alsa-project.org/main/index.php/Asoundrc} for the details. +@deffn {Scheme Variable} pulseaudio-service-type +This is the type for the @uref{http://www.pulseaudio.org/, PulseAudio} +sound server. It exists to allow system overrides of the default settings +via @code{pulseaudio-configuration}, see below. + +@quotation Warning +This service on its own does not ensure, that the @code{pulseaudio} package +exists on your machine. It merely adds configuration files for it, as +detailed below. In the (admittedly unlikely) case, that you find yourself +without a @code{pulseaudio} package, consider enabling it through the +@code{alsa-service-type} above. +@end quotation +@end deffn + +@deftp {Data Type} pulseaudio-configuration +Data type representing the configuration for @code{pulseaudio-service}. + +@table @asis +@item @var{client-conf} (default: @code{'()}) +List of settings to set in @file{client.conf}. +Accepts a list of strings or a symbol-value pairs. A string will be +inserted as-is with a newline added. A pair will be formatted as +``key = value'', again with a newline added. + +@item @var{daemon-conf} (default: @code{'((flat-volumes . no))}) +List of settings to set in @file{daemon.conf}, formatted just like +@var{client-conf}. + +@item @var{script-file} (default: @code{(file-append pulseaudio "/etc/pulse/default.pa")}) +Script file to use as as @file{default.pa}. + +@item @var{system-script-file} (default: @code{(file-append pulseaudio "/etc/pulse/system.pa")}) +Script file to use as as @file{system.pa}. +@end table +@end deftp + +@deffn {Scheme Variable} ladspa-service-type +This service sets the @var{LADSPA_PATH} variable, so that programs, which +respect it, e.g. PulseAudio, can load LADSPA plugins. + +The following example will setup the service to enable modules from the +@code{swh-plugins} package: + +@lisp +(service ladspa-service-type + (ladspa-configuration (plugins (list swh-plugins)))) +@end lisp + +See @uref{http://plugin.org.uk/ladspa-swh/docs/ladspa-swh.html} for the +details. + +@end deffn @node Database Services @subsection Database Services @@ -21926,6 +21979,78 @@ The @code{(gnu services nfs)} module provides the following services, which are most commonly used in relation to mounting or exporting directory trees as @dfn{network file systems} (NFS). +While it is possible to use the individual components that together make +up a Network File System service, we recommended to configure an NFS +server with the @code{nfs-service-type}. + +@subsubheading NFS Service +@cindex NFS, server + +The NFS service takes care of setting up all NFS component services, +kernel configuration file systems, and installs configuration files in +the locations that NFS expects. + +@defvr {Scheme Variable} nfs-service-type +A service type for a complete NFS server. +@end defvr + +@deftp {Data Type} nfs-configuration +This data type represents the configuration of the NFS service and all +of its subsystems. + +It has the following parameters: +@table @asis +@item @code{nfs-utils} (default: @code{nfs-utils}) +The nfs-utils package to use. + +@item @code{nfs-version} (default: @code{#f}) +If a string value is provided, the @command{rpc.nfsd} daemon will be +limited to supporting the given version of the NFS protocol. + +@item @code{exports} (default: @code{'()}) +This is a list of directories the NFS server should export. Each entry +is a list consisting of two elements: a directory name and a string +containing all options. This is an example in which the directory +@file{/export} is served to all NFS clients as a read-only share: + +@lisp +(nfs-configuration + (exports + '(("/export" + "*(ro,insecure,no_subtree_check,crossmnt,fsid=0)")))) +@end lisp + +@item @code{rpcmountd-port} (default: @code{#f}) +The network port that the @command{rpc.mountd} daemon should use. + +@item @code{rpcstatd-port} (default: @code{#f}) +The network port that the @command{rpc.statd} daemon should use. + +@item @code{rpcbind} (default: @code{rpcbind}) +The rpcbind package to use. + +@item @code{idmap-domain} (default: @code{"localdomain"}) +The local NFSv4 domain name. + +@item @code{nfsd-port} (default: @code{2049}) +The network port that the @command{nfsd} daemon should use. + +@item @code{nfsd-threads} (default: @code{8}) +The number of threads used by the @command{nfsd} daemon. + +@item @code{pipefs-directory} (default: @code{"/var/lib/nfs/rpc_pipefs"}) +The directory where the pipefs file system is mounted. + +@item @code{debug} (default: @code{'()"}) +A list of subsystems for which debugging output should be enabled. This +is a list of symbols. Any of these symbols are valid: @code{nfsd}, +@code{nfs}, @code{rpc}, @code{idmap}, @code{statd}, or @code{mountd}. +@end table +@end deftp + +If you don't need a complete NFS service or prefer to build it yourself +you can use the individual component services that are documented below. + @subsubheading RPC Bind Service @cindex rpcbind @@ -22030,6 +22155,9 @@ The local NFSv4 domain name. This must be a string or @code{#f}. If it is @code{#f} then the daemon will use the host's fully qualified domain name. +@item @code{verbosity} (default: @code{0}) +The verbosity level of the daemon. + @end table @end deftp @@ -25958,26 +26086,36 @@ supported: Display available service type definitions that match the given regular expressions, sorted by relevance: +@cindex HDPI +@cindex HiDPI +@cindex resolution @example -$ guix system search console font +$ guix system search console name: console-fonts -location: gnu/services/base.scm:729:2 +location: gnu/services/base.scm:806:2 extends: shepherd-root -description: Install the given fonts on the specified ttys (fonts are -+ per virtual console on GNU/Linux). The value of this service is a list -+ of tty/font pairs like: +description: Install the given fonts on the specified ttys (fonts are per ++ virtual console on GNU/Linux). The value of this service is a list of ++ tty/font pairs. The font can be the name of a font provided by the `kbd' ++ package or any valid argument to `setfont', as in this example: + -+ '(("tty1" . "LatGrkCyr-8x16")) -relevance: 20 ++ '(("tty1" . "LatGrkCyr-8x16") ++ ("tty2" . (file-append ++ font-tamzen ++ "/share/kbd/consolefonts/TamzenForPowerline10x20.psf")) ++ ("tty3" . (file-append ++ font-terminus ++ "/share/consolefonts/ter-132n"))) ; for HDPI +relevance: 9 name: mingetty -location: gnu/services/base.scm:1048:2 +location: gnu/services/base.scm:1190:2 extends: shepherd-root description: Provide console login using the `mingetty' program. relevance: 2 name: login -location: gnu/services/base.scm:775:2 +location: gnu/services/base.scm:860:2 extends: pam description: Provide a console log-in service as specified by its + configuration value, a `login-configuration' object. |