deploy: 691cbcc03a

options.html

@@ -6187,10 +6187,18 @@ boolean</p><p><span class="emphasis"><em>Default:</em></span>
 package</p><p><span class="emphasis"><em>Default:</em></span>
 <code class="literal">pkgs.k9s</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/k9s.nix" target="_top">
 &lt;home-manager/modules/programs/k9s.nix&gt;
-</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.k9s.hotkey"></a><a class="term" href="options.html#opt-programs.k9s.hotkey"><code class="option">programs.k9s.hotkey</code></a></span></dt><dd><p>hotkeys written to
+</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.k9s.aliases"></a><a class="term" href="options.html#opt-programs.k9s.aliases"><code class="option">programs.k9s.aliases</code></a></span></dt><dd><p>Aliases written to <code class="filename">$XDG_CONFIG_HOME/k9s/aliases.yml</code>. See
-<code class="filename">$XDG_CONFIG_HOME/k9s/hotkey.yml</code>. See
+<a class="link" href="https://k9scli.io/topics/aliases/" target="_top">https://k9scli.io/topics/aliases/</a> for supported values.</p><p><span class="emphasis"><em>Type:</em></span>
-<a class="link" href="https://k9scli.io/topics/hotkeys/" target="_top">https://k9scli.io/topics/hotkeys/</a>
+YAML value</p><p><span class="emphasis"><em>Default:</em></span>
-for supported values.</p><p><span class="emphasis"><em>Type:</em></span>
+<code class="literal">{ }</code></p><p><span class="emphasis"><em>Example:</em></span></p><pre class="programlisting">alias = {
+  # Use pp as an alias for Pod
+  pp = "v1/pods";
+};
+
+</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/k9s.nix" target="_top">
+&lt;home-manager/modules/programs/k9s.nix&gt;
+</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.k9s.hotkey"></a><a class="term" href="options.html#opt-programs.k9s.hotkey"><code class="option">programs.k9s.hotkey</code></a></span></dt><dd><p>Hotkeys written to <code class="filename">$XDG_CONFIG_HOME/k9s/hotkey.yml</code>. See
+<a class="link" href="https://k9scli.io/topics/hotkeys/" target="_top">https://k9scli.io/topics/hotkeys/</a> for supported values.</p><p><span class="emphasis"><em>Type:</em></span>
 YAML value</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">hotkey = {
   # Make sure this is camel case
@@ -6205,10 +6213,34 @@ YAML value</p><p><span class="emphasis"><em>Default:</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/k9s.nix" target="_top">
 &lt;home-manager/modules/programs/k9s.nix&gt;
-</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.k9s.settings"></a><a class="term" href="options.html#opt-programs.k9s.settings"><code class="option">programs.k9s.settings</code></a></span></dt><dd><p>Configuration written to
+</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.k9s.plugin"></a><a class="term" href="options.html#opt-programs.k9s.plugin"><code class="option">programs.k9s.plugin</code></a></span></dt><dd><p>Plugins written to <code class="filename">$XDG_CONFIG_HOME/k9s/plugin.yml</code>. See
-<code class="filename">$XDG_CONFIG_HOME/k9s/config.yml</code>. See
+<a class="link" href="https://k9scli.io/topics/plugins/" target="_top">https://k9scli.io/topics/plugins/</a> for supported values.</p><p><span class="emphasis"><em>Type:</em></span>
-<a class="link" href="https://k9scli.io/topics/config/" target="_top">https://k9scli.io/topics/config/</a>
+YAML value</p><p><span class="emphasis"><em>Default:</em></span>
-for supported values.</p><p><span class="emphasis"><em>Type:</em></span>
+<code class="literal">{ }</code></p><p><span class="emphasis"><em>Example:</em></span></p><pre class="programlisting">plugin = {
+  # Defines a plugin to provide a `ctrl-l` shortcut to
+  # tail the logs while in pod view.
+  fred = {
+    shortCut = "Ctrl-L";
+    description = "Pod logs";
+    scopes = [ "po" ];
+    command = "kubectl";
+    background = false;
+    args = [
+      "logs"
+      "-f"
+      "$NAME"
+      "-n"
+      "$NAMESPACE"
+      "--context"
+      "$CLUSTER"
+    ];
+  };
+};
+
+</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/k9s.nix" target="_top">
+&lt;home-manager/modules/programs/k9s.nix&gt;
+</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.k9s.settings"></a><a class="term" href="options.html#opt-programs.k9s.settings"><code class="option">programs.k9s.settings</code></a></span></dt><dd><p>Configuration written to <code class="filename">$XDG_CONFIG_HOME/k9s/config.yml</code>. See
+<a class="link" href="https://k9scli.io/topics/config/" target="_top">https://k9scli.io/topics/config/</a> for supported values.</p><p><span class="emphasis"><em>Type:</em></span>
 YAML value</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">k9s = {
   refreshRate = 2;
@@ -6216,10 +6248,8 @@ YAML value</p><p><span class="emphasis"><em>Default:</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/k9s.nix" target="_top">
 &lt;home-manager/modules/programs/k9s.nix&gt;
-</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.k9s.skin"></a><a class="term" href="options.html#opt-programs.k9s.skin"><code class="option">programs.k9s.skin</code></a></span></dt><dd><p>Skin written to
+</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.k9s.skin"></a><a class="term" href="options.html#opt-programs.k9s.skin"><code class="option">programs.k9s.skin</code></a></span></dt><dd><p>Skin written to <code class="filename">$XDG_CONFIG_HOME/k9s/skin.yml</code>. See
-<code class="filename">$XDG_CONFIG_HOME/k9s/skin.yml</code>. See
+<a class="link" href="https://k9scli.io/topics/skins/" target="_top">https://k9scli.io/topics/skins/</a> for supported values.</p><p><span class="emphasis"><em>Type:</em></span>
-<a class="link" href="https://k9scli.io/topics/skins/" target="_top">https://k9scli.io/topics/skins/</a>
-for supported values.</p><p><span class="emphasis"><em>Type:</em></span>
 YAML value</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">k9s = {
   body = {
@@ -6227,6 +6257,27 @@ YAML value</p><p><span class="emphasis"><em>Default:</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/k9s.nix" target="_top">
+&lt;home-manager/modules/programs/k9s.nix&gt;
+</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.k9s.views"></a><a class="term" href="options.html#opt-programs.k9s.views"><code class="option">programs.k9s.views</code></a></span></dt><dd><p>Resource column views written to <code class="filename">$XDG_CONFIG_HOME/k9s/views.yml</code>.
+See <a class="link" href="https://k9scli.io/topics/columns/" target="_top">https://k9scli.io/topics/columns/</a> for supported values.</p><p><span class="emphasis"><em>Type:</em></span>
+YAML value</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">k9s = {
+  views = {
+    "v1/pods" = {
+      columns = [
+        "AGE"
+        "NAMESPACE"
+        "NAME"
+        "IP"
+        "NODE"
+        "STATUS"
+        "READY"
+      ];
+    };
+  };
+};
+
 </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/k9s.nix" target="_top">
 &lt;home-manager/modules/programs/k9s.nix&gt;
 </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kakoune.enable"></a><a class="term" href="options.html#opt-programs.kakoune.enable"><code class="option">programs.kakoune.enable</code></a></span></dt><dd><p>Whether to enable the kakoune text editor.</p><p><span class="emphasis"><em>Type:</em></span>