From 4f9158e533ddd4e84f36e9846dd29afa5677b138 Mon Sep 17 00:00:00 2001 From: Robert Helgesson Date: Thu, 4 Jan 2018 13:27:29 +0100 Subject: [PATCH] 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. --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index f83af3366..7c7d4b123 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/