aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2015-05-20 11:52:45 +0200
committerLudovic Courtès <ludo@gnu.org>2015-05-20 12:13:39 +0200
commitdbc31ab25c355eae373e1766b4a77fccbe462bf3 (patch)
treebadd7863749d9f3783eae95a33751abf0bfe0857 /doc
parent755e1147aa33d1c305bb9db6c5e03cf1063079fc (diff)
downloadguix-dbc31ab25c355eae373e1766b4a77fccbe462bf3.tar
guix-dbc31ab25c355eae373e1766b4a77fccbe462bf3.tar.gz
guix package: Add optional argument to --search-paths.
* guix/scripts/package.scm (search-path-environment-variables): Add #:kind parameter. Pass it to 'environment-variable-definition'. (display-search-paths): Add #:kind parameter and pass it to 'search-path-environment-variables'. (%options): Add an optional parameter for "--search-paths". (guix-package)[process-query]: Handle it. * tests/guix-package-net.sh: Adjust existing test. * tests/guix-package.sh: Adjust existing tests and add new test. * doc/guix.texi (Invoking guix package): Document it.
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi14
1 files changed, 13 insertions, 1 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 8e1bdb6f93..53c9fb2d44 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -1098,7 +1098,7 @@ The difference between @code{--roll-back} and
not make a zeroth generation, so if a specified generation does not
exist, the current generation will not be changed.
-@item --search-paths
+@item --search-paths[=@var{kind}]
@cindex search paths
Report environment variable definitions, in Bash syntax, that may be
needed in order to use the set of installed packages. These environment
@@ -1113,6 +1113,18 @@ library are installed in the profile, then @code{--search-paths} will
suggest setting these variables to @code{@var{profile}/include} and
@code{@var{profile}/lib}, respectively.
+The typical use case is to define these environment variables in the
+shell:
+
+@example
+$ eval `guix package --search-paths`
+@end example
+
+@var{kind} may be one of @code{exact}, @code{prefix}, or @code{suffix},
+meaning that the returned environment variable definitions will either
+be exact settings, or prefixes or suffixes of the current value of these
+variables. When omitted, @var{kind} defaults to @code{exact}.
+
@item --profile=@var{profile}
@itemx -p @var{profile}
Use @var{profile} instead of the user's default profile.