summary refs log tree commit diff
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2020-09-28 11:32:35 +0200
committerLudovic Courtès <ludo@gnu.org>2020-09-28 11:43:47 +0200
commit09ffacd455e6e93651536321339e18b64a752233 (patch)
treec972c9fceca021964879ddca8796189d22414b22
parentaf56f60ef0394b35ab7926d10a4f825c2b1245f6 (diff)
downloadguix-09ffacd455e6e93651536321339e18b64a752233.tar.gz
doc: Clarify how to choose a user account shell.
* doc/guix.texi (User Accounts): Add example with custom shell and
custom home directory.  Add examples of shell gexps.
-rw-r--r--doc/guix.texi29
1 files changed, 26 insertions, 3 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 81f46cc18d..c600d577ac 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -12830,8 +12830,19 @@ User accounts and groups are entirely managed through the
                           "audio"   ;sound card
                           "video"   ;video devices such as webcams
                           "cdrom")) ;the good ol' CD-ROM
-  (comment "Bob's sister")
-  (home-directory "/home/alice"))
+  (comment "Bob's sister"))
+@end lisp
+
+Here's a user account that uses a different shell and a custom home
+directory (the default would be @file{"/home/bob"}):
+
+@lisp
+(user-account
+  (name "bob")
+  (group "users")
+  (comment "Alice's bro")
+  (shell (file-append zsh "/bin/zsh"))
+  (home-directory "/home/robert"))
 @end lisp
 
 When booting or upon completion of @command{guix system reconfigure},
@@ -12876,7 +12887,19 @@ if it does not exist yet.
 
 @item @code{shell} (default: Bash)
 This is a G-expression denoting the file name of a program to be used as
-the shell (@pxref{G-Expressions}).
+the shell (@pxref{G-Expressions}).  For example, you would refer to the
+Bash executable like this:
+
+@lisp
+(file-append bash "/bin/bash")
+@end lisp
+
+@noindent
+... and to the Zsh executable like that:
+
+@lisp
+(file-append zsh "/bin/zsh")
+@end lisp
 
 @item @code{system?} (default: @code{#f})
 This Boolean value indicates whether the account is a ``system''