Merge pull request #15213 from zimbatm/autojump-share

autojump: include a way to find the share dir

2 files changed, 23 insertions, 3 deletions

diff --git a/doc/package-notes.xml b/doc/package-notes.xml
index 4148e87e0189..f0015a7f9ace 100644
--- a/doc/package-notes.xml
+++ b/doc/package-notes.xml
@@ -366,4 +366,20 @@ it. Place the resulting <filename>package.nix</filename> file into
 
 </section>
 
+<section xml:id="sec-autojump">
+
+<title>Autojump</title>
+
+<para>
+  autojump needs the shell integration to be useful but unlike other systems,
+  nix doesn't have a standard share directory location. This is why a
+  <command>autojump-share</command> script is shipped that prints the location
+  of the shared folder. This can then be used in the .bashrc like this:
+<screen>
+  source "$(autojump-share)/autojump.bash"
+</screen>
+</para>
+
+</section>
+
 </chapter>
diff --git a/pkgs/tools/misc/autojump/default.nix b/pkgs/tools/misc/autojump/default.nix
index 3bd44fb07b7e..f0dfee7882a1 100644
--- a/pkgs/tools/misc/autojump/default.nix
+++ b/pkgs/tools/misc/autojump/default.nix
@@ -22,9 +22,13 @@ in
       mkdir -p "$out/etc/bash_completion.d"
       cp -v $out/share/autojump/autojump.bash "$out/etc/bash_completion.d"
 
-      # FIXME: What's the right place for `autojump.zsh'?
-      # This can be used as a workaround in .zshrc:
-      # . $HOME/.nix-profile/share/autojump/autojump.zsh
+      cat <<SCRIPT > $out/bin/autojump-share
+      #!/bin/sh
+      # Run this script to find the autojump shared folder where all the shell
+      # integration scripts are living.
+      echo $out/share/autojump
+      SCRIPT
+      chmod +x $out/bin/autojump-share
     '';
 
     meta = {