nixos: nixos/doc/manual/configuration/wayland.xml to CommonMark

This commit is contained in:
Bobby Rong 2021-07-03 19:38:06 +08:00
parent 361056334d
commit f04b9023e3
4 changed files with 60 additions and 34 deletions

View file

@ -18,7 +18,7 @@
<xi:include href="../from_md/configuration/user-mgmt.chapter.xml" />
<xi:include href="file-systems.xml" />
<xi:include href="../from_md/configuration/x-windows.chapter.xml" />
<xi:include href="wayland.xml" />
<xi:include href="../from_md/configuration/wayland.chapter.xml" />
<xi:include href="gpu-accel.xml" />
<xi:include href="xfce.xml" />
<xi:include href="networking.xml" />

View file

@ -0,0 +1,27 @@
# Wayland {#sec-wayland}
While X11 (see [](#sec-x11)) is still the primary display technology
on NixOS, Wayland support is steadily improving. Where X11 separates the
X Server and the window manager, on Wayland those are combined: a
Wayland Compositor is like an X11 window manager, but also embeds the
Wayland \'Server\' functionality. This means it is sufficient to install
a Wayland Compositor such as sway without separately enabling a Wayland
server:
```nix
programs.sway.enable = true;
```
This installs the sway compositor along with some essential utilities.
Now you can start sway from the TTY console.
If you are using a wlroots-based compositor, like sway, and want to be
able to share your screen, you might want to activate this option:
```nix
xdg.portal.wlr.enable = true;
```
and configure Pipewire using
[`services.pipewire.enable`](options.html#opt-services.pipewire.enable)
and related options.

View file

@ -1,33 +0,0 @@
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
version="5.0"
xml:id="sec-wayland">
<title>Wayland</title>
<para>
While X11 (see <xref linkend="sec-x11"/>) is still the primary display
technology on NixOS, Wayland support is steadily improving.
Where X11 separates the X Server and the window manager, on Wayland those
are combined: a Wayland Compositor is like an X11 window manager, but also
embeds the Wayland 'Server' functionality. This means it is sufficient to
install a Wayland Compositor such as <package>sway</package> without
separately enabling a Wayland server:
<programlisting>
<xref linkend="opt-programs.sway.enable"/> = true;
</programlisting>
This installs the <package>sway</package> compositor along with some
essential utilities. Now you can start <package>sway</package> from the TTY
console.
</para>
<para>
If you are using a wlroots-based compositor, like sway, and want to be able to
share your screen, you might want to activate this option:
<programlisting>
<xref linkend="opt-xdg.portal.wlr.enable"/> = true;
</programlisting>
and configure Pipewire using <xref linkend="opt-services.pipewire.enable"/>
and related options.
</para>
</chapter>

View file

@ -0,0 +1,32 @@
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-wayland">
<title>Wayland</title>
<para>
While X11 (see <xref linkend="sec-x11" />) is still the primary
display technology on NixOS, Wayland support is steadily improving.
Where X11 separates the X Server and the window manager, on Wayland
those are combined: a Wayland Compositor is like an X11 window
manager, but also embeds the Wayland 'Server' functionality. This
means it is sufficient to install a Wayland Compositor such as sway
without separately enabling a Wayland server:
</para>
<programlisting language="bash">
programs.sway.enable = true;
</programlisting>
<para>
This installs the sway compositor along with some essential
utilities. Now you can start sway from the TTY console.
</para>
<para>
If you are using a wlroots-based compositor, like sway, and want to
be able to share your screen, you might want to activate this
option:
</para>
<programlisting language="bash">
xdg.portal.wlr.enable = true;
</programlisting>
<para>
and configure Pipewire using
<link xlink:href="options.html#opt-services.pipewire.enable"><literal>services.pipewire.enable</literal></link>
and related options.
</para>
</chapter>