blob: a2a6ec894088c24942e86832feda2984cf8fc2ff (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
This directory contains various NixOS modules.
If you add a module here, make sure that you define all options using a
`vuizvui.*` namespace, so that the documentation is generated and you don't
clash with modules from upstream [nixpkgs](https://github.com/NixOS/nixpkgs).
When writing modules, make sure to categorize them accordingly:
<table>
<tr>
<th>hardware</th>
<td>Hardware-related options</td>
</tr>
<tr>
<th>profiles</th>
<td>Options for a specific domain (like for example
`desktop`, `router`, `music`, ...)
</td>
</tr>
<tr>
<th>programs</th>
<td>Program-specific configuration options</td>
</tr>
<tr>
<th>services</th>
<td>Modules that implement systemd services</td>
</tr>
<tr>
<th>system</th>
<td>Everything system-related (like for example kernel)</td>
</tr>
<tr>
<th>tasks</th>
<td>Various one-shot services</td>
</tr>
</table>
If a module is highly specific to your own configuration, use the same
categories but put them under `user/$username/$category/$module`.
Their configuration options should be named
`vuizvui.user."${username}".*` accordingly.
Don't forget to add your module to `module-list.nix`, but make sure you have
options in place to disable them by default.
## Module option reference
There is also a Hydra job for the currently available options which are
specific to all of the modules listed in `module-list.nix`:
https://headcounter.org/hydra/job/openlab/vuizvui/manual/latest/download/1/manual.html
|
