diff options
| author | github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> | 2020-12-05 06:16:24 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-12-05 06:16:24 +0000 |
| commit | 55b348fe1b0417fa20902bfb1133aebf833cae44 (patch) | |
| tree | 1c6707ff57715fb765dae98a760b8a51371a17ab /doc/builders | |
| parent | 4763e8b8fd805f63a707257b3c0bd6a1af90d7d8 (diff) | |
| parent | 7ba8820008a9fc767377bbc5f67bf85aee514bee (diff) | |
Merge master into staging-next
Diffstat (limited to 'doc/builders')
| -rw-r--r-- | doc/builders/packages/index.xml | 2 | ||||
| -rw-r--r-- | doc/builders/packages/shell-helpers.section.md | 12 | ||||
| -rw-r--r-- | doc/builders/packages/shell-helpers.xml | 21 |
3 files changed, 13 insertions, 22 deletions
diff --git a/doc/builders/packages/index.xml b/doc/builders/packages/index.xml index 38d72a4748f6..c7a4aa9f47dc 100644 --- a/doc/builders/packages/index.xml +++ b/doc/builders/packages/index.xml @@ -17,7 +17,7 @@ <xi:include href="locales.xml" /> <xi:include href="nginx.section.xml" /> <xi:include href="opengl.section.xml" /> - <xi:include href="shell-helpers.xml" /> + <xi:include href="shell-helpers.section.xml" /> <xi:include href="steam.xml" /> <xi:include href="cataclysm-dda.section.xml" /> <xi:include href="urxvt.section.xml" /> diff --git a/doc/builders/packages/shell-helpers.section.md b/doc/builders/packages/shell-helpers.section.md new file mode 100644 index 000000000000..57b8619c5007 --- /dev/null +++ b/doc/builders/packages/shell-helpers.section.md @@ -0,0 +1,12 @@ +# Interactive shell helpers {#sec-shell-helpers} + +Some packages provide the shell integration to be more useful. But unlike other systems, nix doesn't have a standard `share` directory location. This is why a bunch `PACKAGE-share` scripts are shipped that print the location of the corresponding shared folder. Current list of such packages is as following: + +- `fzf` : `fzf-share` + +E.g. `fzf` can then used in the `.bashrc` like this: + +```bash +source "$(fzf-share)/completion.bash" +source "$(fzf-share)/key-bindings.bash" +``` diff --git a/doc/builders/packages/shell-helpers.xml b/doc/builders/packages/shell-helpers.xml deleted file mode 100644 index a4ac9022c4ce..000000000000 --- a/doc/builders/packages/shell-helpers.xml +++ /dev/null @@ -1,21 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xml:id="sec-shell-helpers"> - <title>Interactive shell helpers</title> - - <para> - Some packages provide the shell integration to be more useful. But unlike other systems, nix doesn't have a standard share directory location. This is why a bunch <command>PACKAGE-share</command> scripts are shipped that print the location of the corresponding shared folder. Current list of such packages is as following: - <itemizedlist> - <listitem> - <para> - <literal>fzf</literal>: <command>fzf-share</command> - </para> - </listitem> - </itemizedlist> - E.g. <literal>fzf</literal> can then used in the .bashrc like this: -<screen> - source "$(fzf-share)/completion.bash" - source "$(fzf-share)/key-bindings.bash" -</screen> - </para> -</section> |