doc: Use @lisp and clarify 'setuid-program' examples.

* doc/guix.texi (Setuid Programs): Use @lisp instead of @example.  Add
scope for the 'setuid-programs' field snippet.
This commit is contained in:
Ludovic Courtès 2022-01-10 19:30:10 +01:00
parent 9a112a8fe1
commit 1b87dc2f2a
No known key found for this signature in database
GPG key ID: 090B11993D9AEBB5

View file

@ -34123,21 +34123,23 @@ Configuration System}). For instance, the @command{mount.nfs} program,
which is part of the nfs-utils package, with a setuid root can be which is part of the nfs-utils package, with a setuid root can be
designated like this: designated like this:
@example @lisp
(setuid-program (setuid-program
(program (file-append nfs-utils "/sbin/mount.nfs"))) (program (file-append nfs-utils "/sbin/mount.nfs")))
@end example @end lisp
And then, to make @command{mount.nfs} setuid on your system, add the And then, to make @command{mount.nfs} setuid on your system, add the
previous example to your operating system declaration by appending it to previous example to your operating system declaration by appending it to
@code{%setuid-programs} like this: @code{%setuid-programs} like this:
@example @lisp
(setuid-programs (operating-systems
;; Some fields omitted...
(setuid-programs
(append (list (setuid-program (append (list (setuid-program
(program (file-append nfs-utils "/sbin/mount.nfs")))) (program (file-append nfs-utils "/sbin/mount.nfs")))
%setuid-programs)) %setuid-programs))))
@end example @end lisp
@deftp {Data Type} setuid-program @deftp {Data Type} setuid-program
This data type represents a program with a setuid or setgid bit set. This data type represents a program with a setuid or setgid bit set.