summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2022-01-10 19:30:10 +0100
committerLudovic Courtès <ludo@gnu.org>2022-01-10 19:31:03 +0100
commit1b87dc2f2a897f5fe0b3f8984c2544335ac87b56 (patch)
tree895cb69eec06eda2a1199bebc086e0a7a550d3d2
parent9a112a8fe18390ab30150f510918e20b39a451b5 (diff)
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.
-rw-r--r--doc/guix.texi18
1 files changed, 10 insertions, 8 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 390c4347d6..cc89e55ec9 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -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
designated like this:
-@example
+@lisp
(setuid-program
(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
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 nfs-utils "/sbin/mount.nfs"))))
- %setuid-programs))
-@end example
+@lisp
+(operating-systems
+ ;; Some fields omitted...
+ (setuid-programs
+ (append (list (setuid-program
+ (program (file-append nfs-utils "/sbin/mount.nfs")))
+ %setuid-programs))))
+@end lisp
@deftp {Data Type} setuid-program
This data type represents a program with a setuid or setgid bit set.