From fc0f4a3515ea28b8e4e9e05ad80f5172036784c9 Mon Sep 17 00:00:00 2001
From: ncfavier <ncfavier@users.noreply.github.com>
Date: Fri, 9 Jun 2023 20:33:11 +0000
Subject: [PATCH] deploy: 0945875a2a20de314093b0f9d4d5448e9b4fdccb

---
 options.html | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/options.html b/options.html
index 9d4603fe9..47bfbbe9b 100644
--- a/options.html
+++ b/options.html
@@ -2065,6 +2065,35 @@ for the default configuration.</p><p><span class="emphasis"><em>Type:</em></span
 }
 </pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/bottom.nix#blob-path" target="_top">
                     &lt;home-manager/modules/programs/bottom.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.boxxy.enable"></a><a class="term" href="options.html#opt-programs.boxxy.enable"><code class="option">programs.boxxy.enable</code></a></span></dt><dd><p>Whether to enable boxxy: Boxes in badly behaving applications.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/boxxy.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/boxxy.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.boxxy.package"></a><a class="term" href="options.html#opt-programs.boxxy.package"><code class="option">programs.boxxy.package</code></a></span></dt><dd><p>The boxxy package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.boxxy</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/boxxy.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/boxxy.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.boxxy.rules"></a><a class="term" href="options.html#opt-programs.boxxy.rules"><code class="option">programs.boxxy.rules</code></a></span></dt><dd><p>List of boxxy rules</p><p><span class="emphasis"><em>Type:</em></span> list of (YAML value)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">[ ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/boxxy.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/boxxy.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.boxxy.rules._.context"></a><a class="term" href="options.html#opt-programs.boxxy.rules._.context"><code class="option">programs.boxxy.rules.*.context</code></a></span></dt><dd><p>Apply redirection ONLY when in a certain directory.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">[ ]</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
+  "/home/example/Projects/my-project"
+]</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/boxxy.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/boxxy.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.boxxy.rules._.env"></a><a class="term" href="options.html#opt-programs.boxxy.rules._.env"><code class="option">programs.boxxy.rules.*.env</code></a></span></dt><dd><p>Give certain environment variables for said match.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">{ }</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
+  MY_ENV_VAR = "my_env_var_value";
+}
+</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/boxxy.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/boxxy.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.boxxy.rules._.mode"></a><a class="term" href="options.html#opt-programs.boxxy.rules._.mode"><code class="option">programs.boxxy.rules.*.mode</code></a></span></dt><dd><p>Does the current path redirect a file or a directory?</p><p><span class="emphasis"><em>Type:</em></span> one of "file", "directory"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"directory"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/boxxy.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/boxxy.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.boxxy.rules._.name"></a><a class="term" href="options.html#opt-programs.boxxy.rules._.name"><code class="option">programs.boxxy.rules.*.name</code></a></span></dt><dd><p>Unique identifier of the boxxy rule. This can be any single-line string.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/boxxy.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/boxxy.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.boxxy.rules._.only"></a><a class="term" href="options.html#opt-programs.boxxy.rules._.only"><code class="option">programs.boxxy.rules.*.only</code></a></span></dt><dd><p>Apply redirection ONLY to specified executable names.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">[ ]</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
+  "bash"
+  "/usr/bin/sh"
+]
+</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/boxxy.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/boxxy.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.boxxy.rules._.rewrite"></a><a class="term" href="options.html#opt-programs.boxxy.rules._.rewrite"><code class="option">programs.boxxy.rules.*.rewrite</code></a></span></dt><dd><p>Where that file/directory should be rewritten to.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"${config.xdg.configHome}/ssh"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/boxxy.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/boxxy.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.boxxy.rules._.target"></a><a class="term" href="options.html#opt-programs.boxxy.rules._.target"><code class="option">programs.boxxy.rules.*.target</code></a></span></dt><dd><p>What directory/file to redirect.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"~/.ssh"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/boxxy.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/boxxy.nix&gt;
                 </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.broot.enable"></a><a class="term" href="options.html#opt-programs.broot.enable"><code class="option">programs.broot.enable</code></a></span></dt><dd><p>Whether to enable Broot, a better way to navigate directories.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/broot.nix#blob-path" target="_top">
                     &lt;home-manager/modules/programs/broot.nix&gt;
                 </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.broot.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.broot.enableBashIntegration"><code class="option">programs.broot.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Bash integration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/broot.nix#blob-path" target="_top">