Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handbook/wayland: create initial structured synopsis #380

Closed
wants to merge 2 commits into from
Closed

Handbook/wayland: create initial structured synopsis #380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba5f990
handbook/wayland: create synopsis for consistency
concussious May 1, 2024
0309419
handbook: move wayland kwin note to desktop/kde
concussious May 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions documentation/content/en/books/handbook/desktop/_index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,14 @@ For this to work, the following line is needed in ~/.xinitrc:
% echo "exec dbus-launch --exit-with-x11 ck-launch-session startplasma-x11" > ~/.xinitrc
....

[NOTE]
====
As of May, 2021, plasma5-kwin does support Wayland on FreeBSD.
To use Plasma under Wayland, use the `startplasma-wayland` parameter to `ck-launch-session` and tie in dbus with:
`dbus-launch --exit-with-x11 ck-launch-session startplasma-wayland`
to get it working.
====

[[gnome-environment]]
=== GNOME

Expand Down
32 changes: 23 additions & 9 deletions documentation/content/en/books/handbook/wayland/_index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,29 @@ include::../../../../../shared/asciidoctor.adoc[]
endif::[]

[[wayland-synopsis]]
== Wayland Synopsis
== Synopsis

An installation of FreeBSD using bsdinstall does not automatically install a graphical user interface.
This chapter describes how to select, install, and configure a Wayland compositor, which provides a graphical environment.

Before reading this chapter, you should:

* Know how to install crossref:ports[ports,additional third-party software].

* How to identify and configure crossref:x11[x-graphic-card-drivers,drivers for your graphics hardware].

After reading this chapter, you will know:

* How to configure FreeBSD to host a Wayland graphical environment.

* How to install and configure a Wayland compositor.

* How to run programs designed for the older X Window System.

* How to configure remote desktop access to a Wayland graphical environment.

[[wayland-overview]]
== Wayland Overview
Wayland is a new display server, but it differs from Xorg in several important ways.
First, Wayland is only a protocol that acts as an intermediary between clients using a different mechanism which removes the dependency on an X server.
Xorg includes both the X11 protocol, used to run remote displays and the X server will accept connections and display windows.
Expand All @@ -71,14 +93,6 @@ Volunteers to help work on the NVIDIA(R) DRM are requested.
Currently, a lot of software will function with minimal issues on Wayland, including Firefox.
And a few desktops are also available, such as the Compiz Fusion replacement, known as Wayfire, and the i3 window manager replacement, Sway.

[NOTE]
====
As of May, 2021, plasma5-kwin does support Wayland on FreeBSD.
To use Plasma under Wayland, use the `startplasma-wayland` parameter to `ck-launch-session` and tie in dbus with:
`dbus-launch --exit-with-x11 ck-launch-session startplasma-wayland`
to get it working.
====

For compositors, a kernel supporting the man:evdev[4] driver must exist to utilize the keybinding functionality.
This is built into the [.filename]#GENERIC# kernel by default; however, if it has been customized and man:evdev[4] support was stripped out, the man:evdev[4] module will need to be loaded.
In addition, users of `Wayland` will need to be members of the `video` group.
Expand Down
Loading