pyrox.dev
lol
nixos/pantheon: convert manual chapter to MD
+214
-89
+74
nixos/modules/services/x11/desktop-managers/pantheon.md
+74
nixos/modules/services/x11/desktop-managers/pantheon.md
···
1
+
# Pantheon Desktop {#chap-pantheon}
2
+
3
+
Pantheon is the desktop environment created for the elementary OS distribution. It is written from scratch in Vala, utilizing GNOME technologies with GTK and Granite.
4
+
5
+
## Enabling Pantheon {#sec-pantheon-enable}
6
+
7
+
All of Pantheon is working in NixOS and the applications should be available, aside from a few [exceptions](https://github.com/NixOS/nixpkgs/issues/58161). To enable Pantheon, set
8
+
```
9
+
services.xserver.desktopManager.pantheon.enable = true;
10
+
```
11
+
This automatically enables LightDM and Pantheon's LightDM greeter. If you'd like to disable this, set
12
+
```
13
+
services.xserver.displayManager.lightdm.greeters.pantheon.enable = false;
14
+
services.xserver.displayManager.lightdm.enable = false;
15
+
```
16
+
but please be aware using Pantheon without LightDM as a display manager will break screenlocking from the UI. The NixOS module for Pantheon installs all of Pantheon's default applications. If you'd like to not install Pantheon's apps, set
17
+
```
18
+
services.pantheon.apps.enable = false;
19
+
```
20
+
You can also use [](#opt-environment.pantheon.excludePackages) to remove any other app (like `elementary-mail`).
21
+
22
+
## Wingpanel and Switchboard plugins {#sec-pantheon-wingpanel-switchboard}
23
+
24
+
Wingpanel and Switchboard work differently than they do in other distributions, as far as using plugins. You cannot install a plugin globally (like with {option}`environment.systemPackages`) to start using it. You should instead be using the following options:
25
+
26
+
- [](#opt-services.xserver.desktopManager.pantheon.extraWingpanelIndicators)
27
+
- [](#opt-services.xserver.desktopManager.pantheon.extraSwitchboardPlugs)
28
+
29
+
to configure the programs with plugs or indicators.
30
+
31
+
The difference in NixOS is both these programs are patched to load plugins from a directory that is the value of an environment variable. All of which is controlled in Nix. If you need to configure the particular packages manually you can override the packages like:
32
+
```
33
+
wingpanel-with-indicators.override {
34
+
indicators = [
35
+
pkgs.some-special-indicator
36
+
];
37
+
};
38
+
39
+
switchboard-with-plugs.override {
40
+
plugs = [
41
+
pkgs.some-special-plug
42
+
];
43
+
};
44
+
```
45
+
please note that, like how the NixOS options describe these as extra plugins, this would only add to the default plugins included with the programs. If for some reason you'd like to configure which plugins to use exactly, both packages have an argument for this:
46
+
```
47
+
wingpanel-with-indicators.override {
48
+
useDefaultIndicators = false;
49
+
indicators = specialListOfIndicators;
50
+
};
51
+
52
+
switchboard-with-plugs.override {
53
+
useDefaultPlugs = false;
54
+
plugs = specialListOfPlugs;
55
+
};
56
+
```
57
+
this could be most useful for testing a particular plug-in in isolation.
58
+
59
+
## FAQ {#sec-pantheon-faq}
60
+
61
+
[I have switched from a different desktop and Pantheon’s theming looks messed up.]{#sec-pantheon-faq-messed-up-theme}
62
+
: Open Switchboard and go to: Administration → About → Restore Default Settings → Restore Settings. This will reset any dconf settings to their Pantheon defaults. Note this could reset certain GNOME specific preferences if that desktop was used prior.
63
+
64
+
[I cannot enable both GNOME and Pantheon.]{#sec-pantheon-faq-gnome-and-pantheon}
65
+
: This is a known [issue](https://github.com/NixOS/nixpkgs/issues/64611) and there is no known workaround.
66
+
67
+
[Does AppCenter work, or is it available?]{#sec-pantheon-faq-appcenter}
68
+
: AppCenter has been available since 20.03. Starting from 21.11, the Flatpak backend should work so you can install some Flatpak applications using it. However, due to missing appstream metadata, the Packagekit backend does not function currently. See this [issue](https://github.com/NixOS/nixpkgs/issues/15932).
69
+
70
+
If you are using Pantheon, AppCenter should be installed by default if you have [Flatpak support](#module-services-flatpak) enabled. If you also wish to add the `appcenter` Flatpak remote:
71
+
72
+
```ShellSession
73
+
$ flatpak remote-add --if-not-exists appcenter https://flatpak.elementary.io/repo.flatpakrepo
74
+
```
+2
nixos/modules/services/x11/desktop-managers/pantheon.nix
+2
nixos/modules/services/x11/desktop-managers/pantheon.nix
···
17
17
{
18
18
19
19
meta = {
20
+
# Don't edit the docbook xml directly, edit the md and generate it:
21
+
# `pandoc pantheon.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > pantheon.xml`
20
22
doc = ./pantheon.xml;
21
23
maintainers = teams.pantheon.members;
22
24
};
+138
-89
nixos/modules/services/x11/desktop-managers/pantheon.xml
+138
-89
nixos/modules/services/x11/desktop-managers/pantheon.xml
···
1
-
<chapter xmlns="http://docbook.org/ns/docbook"
2
-
xmlns:xlink="http://www.w3.org/1999/xlink"
3
-
xml:id="chap-pantheon">
4
-
<title>Pantheon Desktop</title>
5
-
<para>
6
-
Pantheon is the desktop environment created for the elementary OS distribution. It is written from scratch in Vala, utilizing GNOME technologies with GTK and Granite.
7
-
</para>
8
-
<section xml:id="sec-pantheon-enable">
9
-
<title>Enabling Pantheon</title>
10
-
1
+
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="chap-pantheon">
2
+
<title>Pantheon Desktop</title>
11
3
<para>
12
-
All of Pantheon is working in NixOS and the applications should be available, aside from a few <link xlink:href="https://github.com/NixOS/nixpkgs/issues/58161">exceptions</link>. To enable Pantheon, set
13
-
<programlisting>
4
+
Pantheon is the desktop environment created for the elementary OS
5
+
distribution. It is written from scratch in Vala, utilizing GNOME
6
+
technologies with GTK and Granite.
7
+
</para>
8
+
<section xml:id="sec-pantheon-enable">
9
+
<title>Enabling Pantheon</title>
10
+
<para>
11
+
All of Pantheon is working in NixOS and the applications should be
12
+
available, aside from a few
13
+
<link xlink:href="https://github.com/NixOS/nixpkgs/issues/58161">exceptions</link>.
14
+
To enable Pantheon, set
15
+
</para>
16
+
<programlisting>
14
17
services.xserver.desktopManager.pantheon.enable = true;
15
18
</programlisting>
16
-
This automatically enables LightDM and Pantheon's LightDM greeter. If you'd like to disable this, set
17
-
<programlisting>
19
+
<para>
20
+
This automatically enables LightDM and Pantheon's LightDM greeter.
21
+
If you'd like to disable this, set
22
+
</para>
23
+
<programlisting>
18
24
services.xserver.displayManager.lightdm.greeters.pantheon.enable = false;
19
25
services.xserver.displayManager.lightdm.enable = false;
20
26
</programlisting>
21
-
but please be aware using Pantheon without LightDM as a display manager will break screenlocking from the UI. The NixOS module for Pantheon installs all of Pantheon's default applications. If you'd like to not install Pantheon's apps, set
22
-
<programlisting>
27
+
<para>
28
+
but please be aware using Pantheon without LightDM as a display
29
+
manager will break screenlocking from the UI. The NixOS module for
30
+
Pantheon installs all of Pantheon's default applications. If you'd
31
+
like to not install Pantheon's apps, set
32
+
</para>
33
+
<programlisting>
23
34
services.pantheon.apps.enable = false;
24
35
</programlisting>
25
-
You can also use <xref linkend="opt-environment.pantheon.excludePackages"/> to remove any other app (like <literal>elementary-mail</literal>).
26
-
</para>
27
-
</section>
28
-
<section xml:id="sec-pantheon-wingpanel-switchboard">
29
-
<title>Wingpanel and Switchboard plugins</title>
30
-
31
-
<para>
32
-
Wingpanel and Switchboard work differently than they do in other distributions, as far as using plugins. You cannot install a plugin globally (like with <option>environment.systemPackages</option>) to start using it. You should instead be using the following options:
33
-
<itemizedlist>
34
-
<listitem>
35
-
<para>
36
-
<xref linkend="opt-services.xserver.desktopManager.pantheon.extraWingpanelIndicators"/>
37
-
</para>
38
-
</listitem>
39
-
<listitem>
40
-
<para>
41
-
<xref linkend="opt-services.xserver.desktopManager.pantheon.extraSwitchboardPlugs"/>
42
-
</para>
43
-
</listitem>
44
-
</itemizedlist>
45
-
to configure the programs with plugs or indicators.
46
-
</para>
47
-
48
-
<para>
49
-
The difference in NixOS is both these programs are patched to load plugins from a directory that is the value of an environment variable. All of which is controlled in Nix. If you need to configure the particular packages manually you can override the packages like:
50
-
<programlisting>
36
+
<para>
37
+
You can also use
38
+
<xref linkend="opt-environment.pantheon.excludePackages"></xref>
39
+
to remove any other app (like <literal>elementary-mail</literal>).
40
+
</para>
41
+
</section>
42
+
<section xml:id="sec-pantheon-wingpanel-switchboard">
43
+
<title>Wingpanel and Switchboard plugins</title>
44
+
<para>
45
+
Wingpanel and Switchboard work differently than they do in other
46
+
distributions, as far as using plugins. You cannot install a
47
+
plugin globally (like with
48
+
<option>environment.systemPackages</option>) to start using it.
49
+
You should instead be using the following options:
50
+
</para>
51
+
<itemizedlist spacing="compact">
52
+
<listitem>
53
+
<para>
54
+
<xref linkend="opt-services.xserver.desktopManager.pantheon.extraWingpanelIndicators"></xref>
55
+
</para>
56
+
</listitem>
57
+
<listitem>
58
+
<para>
59
+
<xref linkend="opt-services.xserver.desktopManager.pantheon.extraSwitchboardPlugs"></xref>
60
+
</para>
61
+
</listitem>
62
+
</itemizedlist>
63
+
<para>
64
+
to configure the programs with plugs or indicators.
65
+
</para>
66
+
<para>
67
+
The difference in NixOS is both these programs are patched to load
68
+
plugins from a directory that is the value of an environment
69
+
variable. All of which is controlled in Nix. If you need to
70
+
configure the particular packages manually you can override the
71
+
packages like:
72
+
</para>
73
+
<programlisting>
51
74
wingpanel-with-indicators.override {
52
75
indicators = [
53
76
pkgs.some-special-indicator
···
60
83
];
61
84
};
62
85
</programlisting>
63
-
please note that, like how the NixOS options describe these as extra plugins, this would only add to the default plugins included with the programs. If for some reason you'd like to configure which plugins to use exactly, both packages have an argument for this:
64
-
<programlisting>
86
+
<para>
87
+
please note that, like how the NixOS options describe these as
88
+
extra plugins, this would only add to the default plugins included
89
+
with the programs. If for some reason you'd like to configure
90
+
which plugins to use exactly, both packages have an argument for
91
+
this:
92
+
</para>
93
+
<programlisting>
65
94
wingpanel-with-indicators.override {
66
95
useDefaultIndicators = false;
67
96
indicators = specialListOfIndicators;
···
72
101
plugs = specialListOfPlugs;
73
102
};
74
103
</programlisting>
75
-
this could be most useful for testing a particular plug-in in isolation.
76
-
</para>
77
-
</section>
78
-
<section xml:id="sec-pantheon-faq">
79
-
<title>FAQ</title>
80
-
81
-
<variablelist>
82
-
<varlistentry xml:id="sec-pantheon-faq-messed-up-theme">
83
-
<term>
84
-
I have switched from a different desktop and Pantheon’s theming looks messed up.
85
-
</term>
86
-
<listitem>
87
-
<para>
88
-
Open Switchboard and go to: Administration → About → Restore Default Settings → Restore Settings. This will reset any dconf settings to their Pantheon defaults. Note this could reset certain GNOME specific preferences if that desktop was used prior.
89
-
</para>
90
-
</listitem>
91
-
</varlistentry>
92
-
<varlistentry xml:id="sec-pantheon-faq-gnome-and-pantheon">
93
-
<term>
94
-
I cannot enable both GNOME and Pantheon.
95
-
</term>
96
-
<listitem>
97
-
<para>
98
-
This is a known <link xlink:href="https://github.com/NixOS/nixpkgs/issues/64611">issue</link> and there is no known workaround.
99
-
</para>
100
-
</listitem>
101
-
</varlistentry>
102
-
<varlistentry xml:id="sec-pantheon-faq-appcenter">
103
-
<term>
104
-
Does AppCenter work, or is it available?
105
-
</term>
106
-
<listitem>
107
-
<para>
108
-
AppCenter has been available since 20.03. Starting from 21.11, the Flatpak backend should work so you can install some Flatpak applications using it. However, due to missing appstream metadata, the Packagekit backend does not function currently. See this <link xlink:href="https://github.com/NixOS/nixpkgs/issues/15932">issue</link>.
109
-
</para>
110
-
<para>
111
-
If you are using Pantheon, AppCenter should be installed by default if you have <link linkend="module-services-flatpak">Flatpak support</link> enabled. If you also wish to add the <literal>appcenter</literal> Flatpak remote:
112
-
</para>
113
-
<screen>
114
-
<prompt>$ </prompt>flatpak remote-add --if-not-exists appcenter https://flatpak.elementary.io/repo.flatpakrepo
115
-
</screen>
116
-
</listitem>
117
-
</varlistentry>
118
-
</variablelist>
119
-
</section>
104
+
<para>
105
+
this could be most useful for testing a particular plug-in in
106
+
isolation.
107
+
</para>
108
+
</section>
109
+
<section xml:id="sec-pantheon-faq">
110
+
<title>FAQ</title>
111
+
<variablelist>
112
+
<varlistentry>
113
+
<term>
114
+
<anchor xml:id="sec-pantheon-faq-messed-up-theme" />I have
115
+
switched from a different desktop and Pantheon’s theming looks
116
+
messed up.
117
+
</term>
118
+
<listitem>
119
+
<para>
120
+
Open Switchboard and go to: Administration → About → Restore
121
+
Default Settings → Restore Settings. This will reset any
122
+
dconf settings to their Pantheon defaults. Note this could
123
+
reset certain GNOME specific preferences if that desktop was
124
+
used prior.
125
+
</para>
126
+
</listitem>
127
+
</varlistentry>
128
+
<varlistentry>
129
+
<term>
130
+
<anchor xml:id="sec-pantheon-faq-gnome-and-pantheon" />I
131
+
cannot enable both GNOME and Pantheon.
132
+
</term>
133
+
<listitem>
134
+
<para>
135
+
This is a known
136
+
<link xlink:href="https://github.com/NixOS/nixpkgs/issues/64611">issue</link>
137
+
and there is no known workaround.
138
+
</para>
139
+
</listitem>
140
+
</varlistentry>
141
+
<varlistentry>
142
+
<term>
143
+
<anchor xml:id="sec-pantheon-faq-appcenter" />Does AppCenter
144
+
work, or is it available?
145
+
</term>
146
+
<listitem>
147
+
<para>
148
+
AppCenter has been available since 20.03. Starting from
149
+
21.11, the Flatpak backend should work so you can install
150
+
some Flatpak applications using it. However, due to missing
151
+
appstream metadata, the Packagekit backend does not function
152
+
currently. See this
153
+
<link xlink:href="https://github.com/NixOS/nixpkgs/issues/15932">issue</link>.
154
+
</para>
155
+
<para>
156
+
If you are using Pantheon, AppCenter should be installed by
157
+
default if you have
158
+
<link linkend="module-services-flatpak">Flatpak
159
+
support</link> enabled. If you also wish to add the
160
+
<literal>appcenter</literal> Flatpak remote:
161
+
</para>
162
+
<programlisting>
163
+
$ flatpak remote-add --if-not-exists appcenter https://flatpak.elementary.io/repo.flatpakrepo
164
+
</programlisting>
165
+
</listitem>
166
+
</varlistentry>
167
+
</variablelist>
168
+
</section>
120
169
</chapter>