summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorTobias Geerinckx-Rice <me@tobias.gr>2020-08-09 17:53:58 +0200
committerTobias Geerinckx-Rice <me@tobias.gr>2020-08-09 19:40:06 +0200
commit4cafdce2102e3ebc7b3a6152464a62a454b6be45 (patch)
treed8a1bdc9680e0f4c474da623f66fdf05427d35b0 /doc
parent3de419b957e7ce4c294aaa09d94a0cc8779723e7 (diff)
downloadguix-4cafdce2102e3ebc7b3a6152464a62a454b6be45.tar.gz
doc: Explain how to select system package outputs.
* doc/guix.texi (operating-system Reference): Document that PACKAGES may
contain traces of tuples and give an example.
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi11
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 4b13d4a00e..7855983bf2 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -11962,8 +11962,15 @@ A string denoting the contents of the @file{/etc/issue} file, which is
 displayed when users log in on a text console.
 
 @item @code{packages} (default: @code{%base-packages})
-The set of packages installed in the global profile, which is accessible
-at @file{/run/current-system/profile}.
+A list of packages to be installed in the global profile, which is accessible
+at @file{/run/current-system/profile}.  Each element is either a package
+variable or a package/output tuple.  Here's a simple example of both:
+
+@lisp
+(cons* git                               ; only the default "out" output
+       (git "send-email")                ; another output of the git package
+       %base-packages)                   ; the default set
+@end lisp
 
 The default set includes core utilities and it is good practice to
 install non-core utilities in user profiles (@pxref{Invoking guix