pyrox.dev
1.Dd January 1, 1980
2.Dt nixos-option 8
3.Os
4.Sh NAME
5.Nm nixos-option
6.Nd inspect a NixOS configuration
7.
8.
9.
10.Sh SYNOPSIS
11.Nm
12.Op Fl r | -recursive
13.Op Fl I Ar path
14.Ar option.name
15.
16.
17.
18.Sh DESCRIPTION
19This command evaluates the configuration specified in
20.Pa /etc/nixos/configuration.nix
21and returns the properties of the option name given as argument.
22.
23.Pp
24When the option name is not an option, the command prints the list of attributes
25contained in the attribute set.
26.
27.
28.
29.Sh OPTIONS
30.Bl -tag -width indent
31.It Fl r , -recursive
32Print all the values at or below the specified path recursively.
33.
34.It Fl I Ar path
35This option is passed to the underlying
36.Xr nix-instantiate 1
37invocation.
38.El
39.
40.
41.
42.Sh ENVIRONMENT
43.Bl -tag -width indent
44.It Ev NIXOS_CONFIG
45Path to the main NixOS configuration module. Defaults to
46.Pa /etc/nixos/configuration.nix Ns
47\&.
48.El
49.
50.
51.
52.Sh EXAMPLES
53Investigate option values:
54.Bd -literal -offset indent
55$ nixos-option boot.loader
56This attribute set contains:
57generationsDir
58grub
59initScript
60
61$ nixos-option boot.loader.grub.enable
62Value:
63true
64
65Default:
66true
67
68Description:
69Whether to enable the GNU GRUB boot loader.
70
71Declared by:
72 "/nix/var/nix/profiles/per-user/root/channels/nixos/nixpkgs/nixos/modules/system/boot/loader/grub/grub.nix"
73
74Defined by:
75 "/nix/var/nix/profiles/per-user/root/channels/nixos/nixpkgs/nixos/modules/system/boot/loader/grub/grub.nix"
76.Ed
77.
78.
79.
80.Sh SEE ALSO
81.Xr configuration.nix 5
82.
83.
84.
85.Sh AUTHORS
86.An -nosplit
87.An Nicolas Pierron
88and
89.An the Nixpkgs/NixOS contributors