eeva/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-23 19:49:45 +01:00
Code Issues Releases Wiki Activity

deploy: 0ebed30a10

Browse source
This commit is contained in:
rycee 2021-12-11 18:21:26 +00:00
parent 99a4a34de2
commit 56495fa2cc
3 changed files with 95 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
index.html
View file

File diff suppressed because one or more lines are too long

86
options.html
View file

@ -7369,6 +7369,92 @@ key in <code class="filename">$XDG_CONFIG_HOME/grobi.conf</code>.
]
</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/services/grobi.nix#blob-path" target="_top">
&lt;home-manager/modules/services/grobi.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.enable"></a><a class="term" href="options.html#opt-services.gromit-mpx.enable"><code class="option">services.gromit-mpx.enable</code></a></span></dt><dd><p>Whether to enable Gromit-MPX annotation tool.</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/services/gromit-mpx.nix#blob-path" target="_top">
&lt;home-manager/modules/services/gromit-mpx.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.package"></a><a class="term" href="options.html#opt-services.gromit-mpx.package"><code class="option">services.gromit-mpx.package</code></a></span></dt><dd><p>The gromit-mpx 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.gromit-mpx"</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/services/gromit-mpx.nix#blob-path" target="_top">
&lt;home-manager/modules/services/gromit-mpx.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.hotKey"></a><a class="term" href="options.html#opt-services.gromit-mpx.hotKey"><code class="option">services.gromit-mpx.hotKey</code></a></span></dt><dd><p>A keysym or raw keycode that toggles the activation state of
gromit-mpx. Set to <code class="literal">null</code> to disable the
hotkey in which case you'll have to activate gromit-mpx
manually using the command line.
</p><p><span class="emphasis"><em>Type:</em></span> null or string or positive integer, meaning &gt;0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"F9"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"Insert"</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/services/gromit-mpx.nix#blob-path" target="_top">
&lt;home-manager/modules/services/gromit-mpx.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.opacity"></a><a class="term" href="options.html#opt-services.gromit-mpx.opacity"><code class="option">services.gromit-mpx.opacity</code></a></span></dt><dd><p>Opacity of the drawing overlay.</p><p><span class="emphasis"><em>Type:</em></span> float between 0.0 and 1.0 (inclusive)</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"></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/services/gromit-mpx.nix#blob-path" target="_top">
&lt;home-manager/modules/services/gromit-mpx.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.tools"></a><a class="term" href="options.html#opt-services.gromit-mpx.tools"><code class="option">services.gromit-mpx.tools</code></a></span></dt><dd><p>Tool definitions for gromit-mpx to use.
</p><p><span class="emphasis"><em>Type:</em></span> list of submodules</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
[
{
color = "red"; device = "default"; size = 5; type = "pen";
}
{
color = "blue"; device = "default"; modifiers =
[
"SHIFT"
]
; size = 5; type = "pen";
}
{
color = "yellow"; device = "default"; modifiers =
[
"CONTROL"
]
; size = 5; type = "pen";
}
{
arrowSize = 1; color = "green"; device = "default"; modifiers =
[
"2"
]
; size = 6; type = "pen";
}
{
device = "default"; modifiers =
[
"3"
]
; size = 75; type = "eraser";
}
]
</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/services/gromit-mpx.nix#blob-path" target="_top">
&lt;home-manager/modules/services/gromit-mpx.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.tools._.arrowSize"></a><a class="term" href="options.html#opt-services.gromit-mpx.tools._.arrowSize"><code class="option">services.gromit-mpx.tools.*.arrowSize</code></a></span></dt><dd><p>If not <code class="literal">null</code>, automatically draw an arrow
at the end of a stroke with the given size.
</p><p><span class="emphasis"><em>Type:</em></span> null or positive integer, meaning &gt;0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">2</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/services/gromit-mpx.nix#blob-path" target="_top">
&lt;home-manager/modules/services/gromit-mpx.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.tools._.color"></a><a class="term" href="options.html#opt-services.gromit-mpx.tools._.color"><code class="option">services.gromit-mpx.tools.*.color</code></a></span></dt><dd><p>The stroke (or recolor) color of the tool.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"red"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"#ff00ff"</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/services/gromit-mpx.nix#blob-path" target="_top">
&lt;home-manager/modules/services/gromit-mpx.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.tools._.device"></a><a class="term" href="options.html#opt-services.gromit-mpx.tools._.device"><code class="option">services.gromit-mpx.tools.*.device</code></a></span></dt><dd><p>Use this tool with the given xinput device. The device with
the name default works with any input.
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"default"</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/services/gromit-mpx.nix#blob-path" target="_top">
&lt;home-manager/modules/services/gromit-mpx.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.tools._.modifiers"></a><a class="term" href="options.html#opt-services.gromit-mpx.tools._.modifiers"><code class="option">services.gromit-mpx.tools.*.modifiers</code></a></span></dt><dd><p>Only activate this tool if the given modifiers are also active.
</p><p><span class="emphasis"><em>Type:</em></span> list of one of "1", "2", "3", "4", "5", "SHIFT", "CONTROL", "ALT", "META"s</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">
[
"SHIFT"
]
</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/services/gromit-mpx.nix#blob-path" target="_top">
&lt;home-manager/modules/services/gromit-mpx.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.tools._.size"></a><a class="term" href="options.html#opt-services.gromit-mpx.tools._.size"><code class="option">services.gromit-mpx.tools.*.size</code></a></span></dt><dd><p>The tool size.</p><p><span class="emphasis"><em>Type:</em></span> positive integer, meaning &gt;0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">5</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">3</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/services/gromit-mpx.nix#blob-path" target="_top">
&lt;home-manager/modules/services/gromit-mpx.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.tools._.type"></a><a class="term" href="options.html#opt-services.gromit-mpx.tools._.type"><code class="option">services.gromit-mpx.tools.*.type</code></a></span></dt><dd><p>Which type of tool this is.</p><p><span class="emphasis"><em>Type:</em></span> one of "pen", "eraser", "recolor"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"pen"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"eraser"</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/services/gromit-mpx.nix#blob-path" target="_top">
&lt;home-manager/modules/services/gromit-mpx.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.gromit-mpx.undoKey"></a><a class="term" href="options.html#opt-services.gromit-mpx.undoKey"><code class="option">services.gromit-mpx.undoKey</code></a></span></dt><dd><p>A keysym or raw keycode that causes gromit-mpx to undo the
last stroke. Use this key along with the shift key to redo an
undone stoke. Set to <code class="literal">null</code> to disable the
undo hotkey.
</p><p><span class="emphasis"><em>Type:</em></span> null or string or positive integer, meaning &gt;0</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"F10"</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/services/gromit-mpx.nix#blob-path" target="_top">
&lt;home-manager/modules/services/gromit-mpx.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.hound.enable"></a><a class="term" href="options.html#opt-services.hound.enable"><code class="option">services.hound.enable</code></a></span></dt><dd><p>Whether to enable hound.</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/services/hound.nix#blob-path" target="_top">
&lt;home-manager/modules/services/hound.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.hound.databasePath"></a><a class="term" href="options.html#opt-services.hound.databasePath"><code class="option">services.hound.databasePath</code></a></span></dt><dd><p>The Hound database path.</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"$XDG_DATA_HOME/hound"</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/services/hound.nix#blob-path" target="_top">

14
tools.html
View file

@ -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 D. 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="nix-darwin-options.html" title="Appendix C. nix-darwin Module Options" /><link rel="next" href="release-notes.html" title="Appendix E. Release Notes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix D. Tools</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="nix-darwin-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 D. Tools</h1></div></div></div><div class="toc"><dl class="toc"><dt><span class="refentrytitle"><a href="tools.html#idm140737310134048"><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="idm140737310134048"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p><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 D. 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="nix-darwin-options.html" title="Appendix C. nix-darwin Module Options" /><link rel="next" href="release-notes.html" title="Appendix E. Release Notes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix D. Tools</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="nix-darwin-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 D. Tools</h1></div></div></div><div class="toc"><dl class="toc"><dt><span class="refentrytitle"><a href="tools.html#idm140737310068128"><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="idm140737310068128"></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
|
@ -82,7 +82,7 @@
|
--verbose
}
]</p></div></div><div class="refsection"><a id="idm140737310097168"></a><h2>Description</h2><p>
]</p></div></div><div class="refsection"><a id="idm140737310031104"></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> or <code class="filename">~/.config/nixpkgs/flake.nix</code>.
</p><p>
@ -151,7 +151,7 @@
available for immediate garbage collection.
</p></li></ul></div><p>
</p></dd></dl></div><p>
</p></div><div class="refsection"><a id="idm140737310059472"></a><h2>Options</h2><p>
</p></div><div class="refsection"><a id="idm140737309993504"></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>
@ -259,15 +259,15 @@
<code class="option">--verbose</code>
</span></dt><dd><p>
Activates verbose output.
</p></dd></dl></div></div><div class="refsection"><a id="idm140737309995760"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">
</p></dd></dl></div></div><div class="refsection"><a id="idm140737309929888"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">
<code class="filename">$XDG_DATA_HOME/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="idm140737309992464"></a><h2>Bugs</h2><p>
</p></dd></dl></div></div><div class="refsection"><a id="idm140737309926592"></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="idm140737309990464"></a><h2>See also</h2><p>
</p></div><div class="refsection"><a id="idm140737309924592"></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="nix-darwin-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 C. nix-darwin Module Options </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Appendix E. Release Notes</td></tr></table></div></body></html>