doc: Try to clarify the setuid programs examples.

Based on user feedback, the shadow / passwd example was too obscure for those
who aren't familiar with the shadow collection of tools. And it was also
considered confusing for the two examples to use different packages.

* doc/guix.texi (Setuid Programs): Use 'nmtui' in the examples.
This commit is contained in:
Leo Famulari 2022-01-03 18:06:50 -05:00
parent 0c5a58e34d
commit 6a7945971d
No known key found for this signature in database
GPG Key ID: 2646FA30BACA7F08
1 changed files with 7 additions and 6 deletions

View File

@ -34077,22 +34077,23 @@ should be setuid root.
The @code{setuid-programs} field of an @code{operating-system}
declaration contains a list of @code{<setuid-program>} denoting the
names of programs to have a setuid or setgid bit set (@pxref{Using the
Configuration System}). For instance, the @command{passwd} program,
which is part of the Shadow package, with a setuid root can be
Configuration System}). For instance, the @command{nmtui} program,
which is part of the NetworkManager package, with a setuid root can be
designated like this:
@example
(setuid-program
(program (file-append shadow "/bin/passwd")))
(program (file-append network-manager "/bin/nmtui")))
@end example
And then it can be added to your operating system declaration by
appending it to @code{%setuid-programs} like this:
And then, to make @code{nmtui} setuid on your system, add the previous
example to your operating system declaration by appending it to
@code{%setuid-programs} like this:
@example
(setuid-programs
(append (list (setuid-program
(program (file-append swaylock "/bin/swaylock"))))
(program (file-append network-manager "/bin/nmtui"))))
%setuid-programs))
@end example