Merge pull request #3896 from raspberrypi/pi-os-update-october-2024

Update instructions for latest version of Raspberry Pi OS

Author: nathan-contino

documentation/asciidoc/accessories/display/display_intro.adoc

@@ -75,22 +75,17 @@ WARNING: When using a micro USB cable to power the display, mount it inside a ch
 
 === Use an on-screen keyboard
 
-In Raspberry Pi OS Bookworm and later, you can use the https://github.com/jjsullivan5196/wvkbd[`wvkbd`] on-screen keyboard as an input device. To install `wvkbd`, run the following command:
+Raspberry Pi OS _Bookworm_ and later include the Squeekboard on-screen keyboard by default. When a touch display is attached, the on-screen keyboard should automatically show when it is possible to enter text and automatically hide when it is not possible to enter text.
 
-[source,console]
-----
-$ sudo apt install wvkbd
-----
+For applications which do not support text entry detection, use the keyboard icon at the right end of the taskbar to manually show and hide the keyboard.
 
-TIP: In Raspberry Pi OS releases prior to Bookworm, you can use `matchbox-keyboard` instead.
-
-=== Change screen orientation
+You can also permanently show or hide the on-screen keyboard in the Display tab of Raspberry Pi Configuration or the `Display` section of `raspi-config`.
 
-If you want to physically rotate the display, or mount it in a specific position, you can use software to adjust the orientation of the screen to better match your setup.
+TIP: In Raspberry Pi OS releases prior to _Bookworm_, use `matchbox-keyboard` instead. If you use the wayfire desktop compositor, use `wvkbd` instead.
 
-==== Rotate screen from the desktop
+=== Change screen orientation
 
-To set the screen orientation from the desktop environment, select **Screen Configuration** from the **Preferences** menu. Right-click on the DSI-1 display rectangle in the layout editor, select **Orientation**, then pick the best option to fit your needs. You can also ensure that the touch overlay is assigned to the correct display with the **Touchscreen** option.
+If you want to physically rotate the display, or mount it in a specific position, select **Screen Configuration** from the **Preferences** menu. Right-click on the DSI-1 display rectangle in the layout editor, select **Orientation**, then pick the best option to fit your needs. You can also ensure that the touch overlay is assigned to the correct display with the **Touchscreen** option.
 
 image::images/display-rotation.png[Screenshot of orientation options in screen configuration, width="80%"]
 
@@ -132,27 +127,6 @@ Then, disable automatic display detection by removing the following line from `c
 display_auto_detect=1
 ----
 
-[NOTE]
-====
-In Raspberry Pi OS _Bookworm_, a bug in https://github.com/WayfireWM/wayfire[Wayfire] currently prevents cursor movement rotation when using WayVNC. There is no workaround for this bug in Wayfire. Instead, you can use https://github.com/labwc/labwc[`labwc`] (currently in beta).
-
-First install `labwc`:
-
-[source,console]
-----
-$ sudo apt install labwc
-----
-
-Then, use the Raspberry Pi Configuration CLI to switch to the `labwc` window compositor. Run the following command to open `raspi-config`:
-
-[source,console]
-----
-$ sudo raspi-config
-----
-
-Go to **Advanced Options**. Select **Wayland**, then select **labwc**. Exit `raspi-config` and reboot with `sudo reboot`. Switching to `labwc` may reset some configuration, including keyboard layout and rotation settings.
-====
-
 ==== Touch Display device tree option reference
 
 The `vc4-kms-dsi-7inch` overlay supports the following options:

documentation/asciidoc/computers/configuration/display-resolution.adoc

@@ -44,20 +44,12 @@ $ kmsprint | grep Connector
 
 ==== Set a custom resolution
 
-If you run the Wayland desktop compositor, you can set a custom display resolution by editing the `.config/wayfire.ini` file in your home directory. Edit the existing `[output:<device>]` section, or add a new `[output:<device>]` section for your xref:configuration.adoc#determine-display-device-name[display device] if one doesn't exist. To change your display resolution, add a `mode` line. For example, the following example shows a configuration for the device named `HDMI-A-1` with a resolution of 1080p at 60Hz:
-
-[source,ini]
-----
-[output:HDMI-A-1]
-mode = 1920x1080@60
-----
-
-For information about supported modes and the `mode` syntax, see the https://github.com/WayfireWM/wayfire-wiki/blob/master/Configuration.md#output-configuration[Wayfire documentation].
-
-Add the same configuration block to `/usr/share/greeter.ini` to configure the login screen resolution.
+To set a custom resolution, use our Screen Configuration tool, `raindrop`. If your Raspberry Pi OS installation doesn't already include `raindrop` (for instance, if you're still using the previous Screen Configuration tool, `arandr`), you can download `raindrop` from `apt` or the Recommended Software GUI.
 
 ==== Set a custom rotation
 
+To set a custom resolution, use our Screen Configuration tool, `raindrop`. If your Raspberry Pi OS installation doesn't already include `raindrop` (for instance, if you're still using the previous Screen Configuration tool, `arandr`), you can download `raindrop` from `apt` or the Recommended Software GUI.
+
 If you run the Wayland desktop compositor, you can set a custom display rotation with `wlr-randr`. The following commands rotate the display by 0°, 90°, 180°, and 270°:
 
 [source,console]
@@ -72,25 +64,7 @@ The `--output` option specifies the device to be rotated.
 
 NOTE: To run this command over SSH, add the following prefix: `WAYLAND_DISPLAY=wayland-1`, e.g. `WAYLAND_DISPLAY=wayland-1 wlr-randr --output HDMI-A-1 --transform 90`.
 
-You can also use one of the following `--transform` options to mirror the display at the same time as rotating it: `flipped`, `flipped-90`, `flipped-180`, `flipped-270`
-
-Alternatively, you can rotate the display using by editing the `.config/wayfire.ini` file in your home directory. Edit the existing `[output:<device>]` section, or add a new `[output:<device>]` section for your xref:configuration.adoc#determine-display-device-name[display device] if one doesn't exist. To rotate your display, add a `transform` line. For example, the following example shows a configuration for the device named `HDMI-A-1` with a resolution of 1080p at 60Hz and a 270° transform:
-
-[source,ini]
-----
-[output:HDMI-A-1]
-mode = 1920x1080@60
-transform = 270
-----
-
-Wayland supports the following `transform` options:
-
-* `normal`
-* `90`
-* `180`
-* `270`
-
-Add the same configuration block to `/usr/share/greeter.ini` to configure the login screen rotation.
+You can also use one of the following `--transform` options to mirror the display at the same time as rotating it: `flipped`, `flipped-90`, `flipped-180`, `flipped-270`.
 
 === Console resolution and rotation
 

documentation/asciidoc/computers/configuration/raspi-config.adoc

@@ -225,9 +225,9 @@ On the Raspberry Pi 4 and later, switch to the latest boot ROM software. Alterna
 
 ==== Wayland
 
-Switch between the X11 and Wayland backends. Raspberry Pi 4 and later use Wayland by default; other models of Raspberry Pi use X11 by default.
+Switch between the X11 and Wayland backends, and choose a window manager. Since Raspberry Pi OS _Bookworm_, all Raspberry Pi models run Wayland using labwc by default.
 
-NOTE: To use Wayland on Raspberry Pi models prior to Raspberry Pi 4, you must also add `wayland=on` to `/boot/firmware/cmdline.txt`.
+NOTE: To use Wayland on Raspberry Pi models prior to Raspberry Pi 4 running a version of Raspberry Pi OS earlier than _Bookworm_, add `wayland=on` to `/boot/firmware/cmdline.txt`.
 
 ==== Audio config
 
@@ -770,17 +770,18 @@ $ sudo raspi-config nonint do_boot_rom <E1/E2>
 
 ==== Wayland
 
-Switch between the X11 and Wayland backends. Raspberry Pi 4 and later use Wayland by default; other models of Raspberry Pi use X11 by default.
+Switch between the X11 and Wayland backends, and choose a window manager. Since Raspberry Pi OS _Bookworm_, all Raspberry Pi models run Wayland using the labwc window manager by default.
+
+NOTE: To use Wayland on Raspberry Pi models prior to Raspberry Pi 4 running a version of Raspberry Pi OS earlier than _Bookworm_, add `wayland=on` to `/boot/firmware/cmdline.txt`.
 
 [source,console]
 ----
 $ sudo raspi-config nonint do_wayland <W1/W2>
 ----
 
-* `W1`: use the X11 backend
-* `W2`: use the Wayland backend
-
-NOTE: To use Wayland on Raspberry Pi models prior to Raspberry Pi 4, you must also add `wayland=on` to `/boot/firmware/cmdline.txt`.
+* `W1`: use the Openbox window manager with X11 backend
+* `W2`: use the wayfire window manager with Wayland backend
+* `W3`: use the labwc window manager with Wayland backend
 
 ==== Audio config
 

documentation/asciidoc/computers/configuration/screensaver.adoc

@@ -27,16 +27,6 @@ $ sudo raspi-config
 
 Use the arrow keys to navigate and the *Enter* key to select. Select `Display Options` > `Screen Blanking`. Choose `yes` with the arrow keys to enable screen blanking, or `no` to disable screen blanking.
 
-Alternatively, you can add or edit the following lines to `~/.config/wayfire.ini`:
-
-[source,ini]
-----
-[idle]
-dpms_timeout=600
-----
-
-The `dpms_timeout` variable controls the number of seconds of inactivity required before Raspberry Pi OS blanks your screen. For example, a value of `600` blanks the screen after 600 seconds, or ten minutes. Set the value to `0` to never blank the screen.
-
 === Console
 
 The `dpms_timeout` screen blanking configuration used by Raspberry Pi Configuration only affects desktop sessions. In *console mode*, when your Raspberry Pi is connected to a monitor and keyboard with only a terminal for input, use the `consoleblank` setting in the kernel command line.

documentation/asciidoc/services/connect/use.adoc

@@ -56,7 +56,7 @@ Now that your device appears on your Connect dashboard, you can access your devi
 
 Connect includes the ability to share your device's screen in a browser. Use the following instructions to share your device's screen.
 
-NOTE: Screen sharing requires the **Wayland** window server. By default, Raspberry Pi OS only uses Wayland for **64-bit** distributions of Raspberry Pi OS **Bookworm** on Raspberry Pi 5, 4, or 400. Screen sharing is **not** compatible with Raspberry Pi OS Lite or systems that use the X window server.
+NOTE: Screen sharing requires the **Wayland** window server. Raspberry Pi OS _Bookworm_ and later use Wayland by default. Screen sharing is **not** compatible with Raspberry Pi OS Lite or systems that use the X window server.
 
 Visit https://connect.raspberrypi.com[connect.raspberrypi.com] on any computer.