aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRobert Helgesson <robert@rycee.net>2018-01-04 13:27:29 +0100
committerRobert Helgesson <robert@rycee.net>2018-01-07 17:52:13 +0100
commit4f9158e533ddd4e84f36e9846dd29afa5677b138 (patch)
tree8afe3284d02b82d0c35819d5859e0a4924031a3d /README.md
parente624b9aa6a7caf99eaacfd4ffd9c3ef839c68a66 (diff)
readme: add note about session variables file
If a user does not want to manage their shell configuration through Home Manager then they have to manually make sure that the session variables are set.
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index f83af33662f..7c7d4b12386 100644
--- a/README.md
+++ b/README.md
@@ -89,6 +89,24 @@ Currently the easiest way to install Home Manager is as follows:
Home Manager should now be active and available in your user
environment.
+5. If you do not plan on having Home Manager manage your shell
+ configuration then you must source the
+
+ ```
+ "$HOME/.nix-profile/etc/profile.d/hm-session-vars.sh"
+ ```
+
+ file in your shell configuration. Unfortunately, we currently only
+ support POSIX.2-like shells such as [Bash][] or [Z shell][].
+
+ For example, if you use Bash then add
+
+ ```bash
+ . "$HOME/.nix-profile/etc/profile.d/hm-session-vars.sh"
+ ```
+
+ to your `~/.profile` file.
+
Note, because the `HM_PATH` variable above points to the live Home
Manager repository you will automatically get updates whenever you
build a new generation. If you dislike automatic updates then perform
@@ -240,8 +258,10 @@ in your system configuration and
in your Home Manager configuration.
+[Bash]: https://www.gnu.org/software/bash/
[Nix]: https://nixos.org/nix/
[NixOS]: https://nixos.org/
[Nixpkgs]: https://nixos.org/nixpkgs/
[nixAllowedUsers]: https://nixos.org/nix/manual/#conf-allowed-users
[nixosAllowedUsers]: https://nixos.org/nixos/manual/options.html#opt-nix.allowedUsers
+[Z shell]: http://zsh.sourceforge.net/