TakeV
/
guix
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: hosts-service-type: Relocate to Base Services. 

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>
This commit is contained in:
Bruno Victal 2023-02-21 21:37:07 +00:00 committed by Ludovic Courtès
parent f45fc72c28
commit ce02b23bb9
No known key found for this signature in database
GPG Key ID: 090B11993D9AEBB5
1 changed files with 72 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

145
doc/guix.texi
View File

@ -109,11 +109,10 @@ Copyright @copyright{} 2022 Reily Siegel@*
Copyright @copyright{} 2022 Simon Streit@*
Copyright @copyright{} 2022 (@*
Copyright @copyright{} 2022 John Kehayias@*
Copyright @copyright{} 2022 Bruno Victal@*
Copyright @copyright{} 2022⁠–⁠2023 Bruno Victal@*
Copyright @copyright{} 2022 Ivan Vilata-i-Balaguer@*
Copyright @copyright{} 2023 Giacomo Leidi@*
Copyright @copyright{} 2022 Antero Mejr@*
Copyright @copyright{} 2023 Bruno Victal@*
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
@ -18021,6 +18020,77 @@ package or any valid argument to @command{setfont}, as in this example:
@end lisp
@end defvar
@defvar hosts-service-type
Type of the service that populates the entries for (@file{/etc/hosts}).
This service type can be extended by passing it a list of
@code{host} records.
@c TRANSLATORS: The domain names below SHOULD NOT be translated.
@c They're domains reserved for use in documentation. (RFC6761 Section 6.5)
@c The addresses used are explained in RFC3849 and RFC5737.
@lisp
(simple-service 'add-extra-hosts
hosts-service-type
(list (host "192.0.2.1" "example.com"
'("example.net" "example.org"))
(host "2001:db8::1" "example.com"
'("example.net" "example.org"))))
@end lisp
@quotation Note
@cindex @file{/etc/host} default entries
By default @file{/etc/host} comes with the following entries:
@example
127.0.0.1 localhost @var{host-name}
::1 localhost @var{host-name}
@end example
For most setups this is what you want though if you find yourself in
the situation where you want to change the default entries, you can
do so in @code{operating-system}.@pxref{operating-system Reference,@code{essential-services}}
The following example shows how one would unset @var{host-name}
from being an alias of @code{localhost}.
@lisp
(operating-system
;; @dots{}
(essential-services
(modify-services
(operating-system-default-essential-services this-operating-system)
(hosts-service-type config => (list
(host "127.0.0.1" "localhost")
(host "::1" "localhost"))))))
@end lisp
@end quotation
@deftp {Data Type} host
Available @code{host} fields are:
@table @asis
@item @code{address} (type: string)
IP address.
@item @code{canonical-name} (type: string)
Hostname.
@item @code{aliases} (default: @code{'()}) (type: list-of-string)
Additional aliases that map to the same @code{canonical-name}.
@end table
@end deftp
@defun host address canonical-name [aliases]
Procedure for creating @code{host} records.
@end defun
@quotation Note
The @code{host} data type constructor is @code{%host} though it is
tiresome to create multiple records with it so in practice the procedure
@code{host} (which wraps around @code{%host}) is used instead.
@end quotation
@end defvar
@deffn {Scheme Procedure} login-service @var{config}
Return a service to run login according to @var{config}, a
@code{<login-configuration>} object, which specifies the message of the day,
@ -40508,77 +40578,6 @@ In this example, the effect would be to add an @file{/etc/issue} file
pointing to the given file.
@end defvar
@defvar hosts-service-type
Type of the service that populates the entries for (@file{/etc/hosts}).
This service type can be extended by passing it a list of
@code{host} records.
@c TRANSLATORS: The domain names below SHOULD NOT be translated.
@c They're domains reserved for use in documentation. (RFC6761 Section 6.5)
@c The addresses used are explained in RFC3849 and RFC5737.
@lisp
(simple-service 'add-extra-hosts
hosts-service-type
(list (host "192.0.2.1" "example.com"
'("example.net" "example.org"))
(host "2001:db8::1" "example.com"
'("example.net" "example.org"))))
@end lisp
@quotation Note
@cindex @file{/etc/host} default entries
By default @file{/etc/host} comes with the following entries:
@example
127.0.0.1 localhost @var{host-name}
::1 localhost @var{host-name}
@end example
For most setups this is what you want though if you find yourself in
the situation where you want to change the default entries, you can
do so in @code{operating-system}.@pxref{operating-system Reference,@code{essential-services}}
The following example shows how one would unset @var{host-name}
from being an alias of @code{localhost}.
@lisp
(operating-system
;; @dots{}
(essential-services
(modify-services
(operating-system-default-essential-services this-operating-system)
(hosts-service-type config => (list
(host "127.0.0.1" "localhost")
(host "::1" "localhost"))))))
@end lisp
@end quotation
@deftp {Data Type} host
Available @code{host} fields are:
@table @asis
@item @code{address} (type: string)
IP address.
@item @code{canonical-name} (type: string)
Hostname.
@item @code{aliases} (default: @code{'()}) (type: list-of-string)
Additional aliases that map to the same @code{canonical-name}.
@end table
@end deftp
@defun host address canonical-name [aliases]
Procedure for creating @code{host} records.
@end defun
@quotation Note
The @code{host} data type constructor is @code{%host} though it is
tiresome to create multiple records with it so in practice the procedure
@code{host} (which wraps around @code{%host}) is used instead.
@end quotation
@end defvar
@defvar setuid-program-service-type
Type for the ``setuid-program service''. This service collects lists of
executable file names, passed as gexps, and adds them to the set of