deploy: 9e9d8ffc7c

options.html

@@ -3569,6 +3569,207 @@ for options.
 }
 </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/i3status.nix#blob-path" target="_top">
                     &lt;home-manager/modules/programs/i3status.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status-rust.enable"></a><a class="term" href="options.html#opt-programs.i3status-rust.enable"><code class="option">programs.i3status-rust.enable</code></a></span></dt><dd><p>Whether to enable a replacement for i3-status written in Rust.</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/i3status-rust.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/i3status-rust.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status-rust.package"></a><a class="term" href="options.html#opt-programs.i3status-rust.package"><code class="option">programs.i3status-rust.package</code></a></span></dt><dd><p>Package providing i3status-rust</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
+        pkgs.i3status-rust
+      </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/i3status-rust.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/i3status-rust.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status-rust.bars"></a><a class="term" href="options.html#opt-programs.i3status-rust.bars"><code class="option">programs.i3status-rust.bars</code></a></span></dt><dd><p>Attribute set of i3status-rust bars, each with their own configuration.
+Each bar <code class="varname">name</code> generates a config file suffixed with
+the bar's <code class="varname">name</code> from the attribute set, like so:
+<code class="filename">config-<em class="replaceable"><code>name</code></em>.toml</code>.
+</p><p>
+This way, multiple config files can be generated, such as for having a
+top and a bottom bar.
+</p><p>
+See
+<span class="citerefentry"><span class="refentrytitle">i3status-rust</span>(1)</span>
+for options.
+</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodules</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
+        
+        {
+        default = 
+        {
+        blocks = 
+        [
+        
+        {
+        alert = ; alias = "/"; block = "disk_space"; info_type = "available"; interval = 60; path = "/"; unit = "GB"; warning = ; 
+        }
+     
+        {
+        block = "memory"; display_type = "memory"; format_mem = "{Mup}%"; format_swap = "{SUp}%"; 
+        }
+     
+        {
+        block = "cpu"; interval = 1; 
+        }
+     
+        {
+        block = "load"; format = "{1m}"; interval = 1; 
+        }
+     
+        {
+        block = "sound"; 
+        }
+     
+        {
+        block = "time"; format = "%a %d/%m %R"; interval = 60; 
+        }
+     
+        ]
+    ; 
+        }
+    ; 
+        }
+    
+      </code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">bottom = {
+  blocks = [
+    {
+       block = "disk_space";
+       path = "/";
+       alias = "/";
+       info_type = "available";
+       unit = "GB";
+       interval = 60;
+       warning = 20.0;
+       alert = 10.0;
+     }
+     {
+       block = "memory";
+       display_type = "memory";
+       format_mem = "{Mup}%";
+       format_swap = "{SUp}%";
+     }
+     {
+       block = "cpu";
+       interval = 1;
+     }
+     {
+       block = "load";
+       interval = 1;
+       format = "{1m}";
+     }
+     { block = "sound"; }
+     {
+       block = "time";
+       interval = 60;
+       format = "%a %d/%m %R";
+     }
+  ];
+  settings = {
+    theme =  {
+      name = "solarized-dark";
+      overrides = {
+        idle_bg = "#123456";
+        idle_fg = "#abcdef";
+      };
+    };
+  };
+  icons = "awesome5";
+  theme = "gruvbox-dark";
+};
+</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/i3status-rust.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/i3status-rust.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status-rust.bars._name_.blocks"></a><a class="term" href="options.html#opt-programs.i3status-rust.bars._name_.blocks"><code class="option">programs.i3status-rust.bars.&lt;name&gt;.blocks</code></a></span></dt><dd><p>Configuration blocks to add to i3status-rust
+<code class="filename">config</code>. See
+<a class="link" href="https://github.com/greshake/i3status-rust/blob/master/blocks.md" target="_top">https://github.com/greshake/i3status-rust/blob/master/blocks.md</a>
+for block options.
+</p><p><span class="emphasis"><em>Type:</em></span> TOML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
+        
+        [
+        
+        {
+        alert = ; alias = "/"; block = "disk_space"; info_type = "available"; interval = 60; path = "/"; unit = "GB"; warning = ; 
+        }
+     
+        {
+        block = "memory"; display_type = "memory"; format_mem = "{Mup}%"; format_swap = "{SUp}%"; 
+        }
+     
+        {
+        block = "cpu"; interval = 1; 
+        }
+     
+        {
+        block = "load"; format = "{1m}"; interval = 1; 
+        }
+     
+        {
+        block = "sound"; 
+        }
+     
+        {
+        block = "time"; format = "%a %d/%m %R"; interval = 60; 
+        }
+     
+        ]
+    
+      </code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
+  {
+    block = "disk_space";
+    path = "/";
+    alias = "/";
+    info_type = "available";
+    unit = "GB";
+    interval = 60;
+    warning = 20.0;
+    alert = 10.0;
+  }
+  {
+    block = "sound";
+    format = "{output_name} {volume}%";
+    on_click = "pavucontrol --tab=3";
+    mappings = {
+     "alsa_output.pci-0000_00_1f.3.analog-stereo" = "";
+     "bluez_sink.70_26_05_DA_27_A4.a2dp_sink" = ""
+    };
+  }
+];
+</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/i3status-rust.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/i3status-rust.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status-rust.bars._name_.icons"></a><a class="term" href="options.html#opt-programs.i3status-rust.bars._name_.icons"><code class="option">programs.i3status-rust.bars.&lt;name&gt;.icons</code></a></span></dt><dd><p>The icons set to use. See
+<a class="link" href="https://github.com/greshake/i3status-rust/blob/master/themes.md" target="_top">https://github.com/greshake/i3status-rust/blob/master/themes.md</a>
+for a list of available icon sets.
+</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
+        "none"
+      </code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
+        "awesome5"
+      </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/i3status-rust.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/i3status-rust.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status-rust.bars._name_.settings"></a><a class="term" href="options.html#opt-programs.i3status-rust.bars._name_.settings"><code class="option">programs.i3status-rust.bars.&lt;name&gt;.settings</code></a></span></dt><dd><p>Any extra options to add to i3status-rust
+<code class="filename">config</code>.
+</p><p><span class="emphasis"><em>Type:</em></span> TOML 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">{
+  theme =  {
+    name = "solarized-dark";
+    overrides = {
+      idle_bg = "#123456";
+      idle_fg = "#abcdef";
+    };
+  };
+}
+</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/i3status-rust.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/i3status-rust.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.i3status-rust.bars._name_.theme"></a><a class="term" href="options.html#opt-programs.i3status-rust.bars._name_.theme"><code class="option">programs.i3status-rust.bars.&lt;name&gt;.theme</code></a></span></dt><dd><p>The theme to use. See
+<a class="link" href="https://github.com/greshake/i3status-rust/blob/master/themes.md" target="_top">https://github.com/greshake/i3status-rust/blob/master/themes.md</a>
+for a list of available themes.
+</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
+        "plain"
+      </code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
+        "gruvbox-dark"
+      </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/i3status-rust.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/i3status-rust.nix&gt;
                 </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.info.enable"></a><a class="term" href="options.html#opt-programs.info.enable"><code class="option">programs.info.enable</code></a></span></dt><dd><p>Whether to enable GNU Info.</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">

tools.html

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix B. Tools</title><link rel="stylesheet" type="text/css" href="style.css" /><link rel="stylesheet" type="text/css" href="overrides.css" /><link rel="stylesheet" type="text/css" href="mono-blue.css" /><script src="highlight.pack.js" type="text/javascript"></script><script src="highlight.load.js" type="text/javascript"></script><meta name="generator" content="DocBook XSL Stylesheets V1.79.2" /><link rel="home" href="index.html" title="Home Manager Manual" /><link rel="up" href="index.html" title="Home Manager Manual" /><link rel="prev" href="options.html" title="Appendix A. Configuration Options" /><link rel="next" href="release-notes.html" title="Appendix C. Release Notes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix B. Tools</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="options.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="release-notes.html">Next</a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="ch-tools"></a>Appendix B. Tools</h1></div></div></div><div class="toc"><dl class="toc"><dt><span class="refentrytitle"><a href="tools.html#idm140737312247264"><span class="command"><strong>home-manager</strong></span>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix B. Tools</title><link rel="stylesheet" type="text/css" href="style.css" /><link rel="stylesheet" type="text/css" href="overrides.css" /><link rel="stylesheet" type="text/css" href="mono-blue.css" /><script src="highlight.pack.js" type="text/javascript"></script><script src="highlight.load.js" type="text/javascript"></script><meta name="generator" content="DocBook XSL Stylesheets V1.79.2" /><link rel="home" href="index.html" title="Home Manager Manual" /><link rel="up" href="index.html" title="Home Manager Manual" /><link rel="prev" href="options.html" title="Appendix A. Configuration Options" /><link rel="next" href="release-notes.html" title="Appendix C. Release Notes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix B. Tools</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="options.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="release-notes.html">Next</a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="ch-tools"></a>Appendix B. Tools</h1></div></div></div><div class="toc"><dl class="toc"><dt><span class="refentrytitle"><a href="tools.html#idm140737312198256"><span class="command"><strong>home-manager</strong></span>
-  </a></span><span class="refpurpose"> — reconfigure a user environment</span></dt></dl></div><div class="refentry"><a id="idm140737312247264"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p><span class="command"><strong>home-manager</strong></span>
+  </a></span><span class="refpurpose"> — reconfigure a user environment</span></dt></dl></div><div class="refentry"><a id="idm140737312198256"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p><span class="command"><strong>home-manager</strong></span>
    — reconfigure a user environment</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">home-manager</code>  { 
     build
      |   
@@ -67,7 +67,7 @@
       |   
      --verbose
      }
-   ]</p></div></div><div class="refsection"><a id="idm140737312215504"></a><h2>Description</h2><p>
+   ]</p></div></div><div class="refsection"><a id="idm140737312166496"></a><h2>Description</h2><p>
    This command updates the user environment so that it corresponds to the
    configuration specified in <code class="filename">~/.config/nixpkgs/home.nix</code>.
   </p><p>
@@ -132,7 +132,7 @@
           available for immediate garbage collection.
          </p></li></ul></div><p>
       </p></dd></dl></div><p>
-  </p></div><div class="refsection"><a id="idm140737312181936"></a><h2>Options</h2><p>
+  </p></div><div class="refsection"><a id="idm140737312132880"></a><h2>Options</h2><p>
    The tool accepts the options
   </p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
      <code class="option">-A <em class="replaceable"><code>attrPath</code></em></code>
@@ -219,15 +219,15 @@
      <code class="option">--verbose</code>
     </span></dt><dd><p>
       Activates verbose output.
-     </p></dd></dl></div></div><div class="refsection"><a id="idm140737312131744"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">
+     </p></dd></dl></div></div><div class="refsection"><a id="idm140737312082784"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">
      <code class="filename">~/.local/share/home-manager/news-read-ids</code>
     </span></dt><dd><p>
       Identifiers of news items that have been shown. Can be deleted to reset
       the read news indicator.
-     </p></dd></dl></div></div><div class="refsection"><a id="idm140737312128448"></a><h2>Bugs</h2><p>
+     </p></dd></dl></div></div><div class="refsection"><a id="idm140737312079488"></a><h2>Bugs</h2><p>
    Please report any bugs on the
    <a class="link" href="https://github.com/nix-community/home-manager/issues" target="_top">project
    issue tracker</a>.
-  </p></div><div class="refsection"><a id="idm140737312126448"></a><h2>See also</h2><p>
+  </p></div><div class="refsection"><a id="idm140737312077488"></a><h2>See also</h2><p>
    <span class="citerefentry"><span class="refentrytitle">home-configuration.nix</span>(5)</span>
   </p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="options.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="release-notes.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Appendix A. Configuration Options </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Appendix C. Release Notes</td></tr></table></div></body></html>