From 90a911b31f39b4c3e7e36438cdc79053e2523cf9 Mon Sep 17 00:00:00 2001
From: SDL Wiki Bot <[EMAIL REDACTED]>
Date: Tue, 28 Feb 2023 16:52:06 +0000
Subject: [PATCH] Sync SDL3 wiki -> header
---
docs/README-linux.md | 185 +++++++++++++++++++++----------------------
1 file changed, 92 insertions(+), 93 deletions(-)
diff --git a/docs/README-linux.md b/docs/README-linux.md
index ed515e2933b5..e162478b8ab2 100644
--- a/docs/README-linux.md
+++ b/docs/README-linux.md
@@ -1,93 +1,92 @@
-Linux
-================================================================================
-
-By default SDL will only link against glibc, the rest of the features will be
-enabled dynamically at runtime depending on the available features on the target
-system. So, for example if you built SDL with XRandR support and the target
-system does not have the XRandR libraries installed, it will be disabled
-at runtime, and you won't get a missing library error, at least with the
-default configuration parameters.
-
-
-Build Dependencies
---------------------------------------------------------------------------------
-
-Ubuntu 18.04, all available features enabled:
-
- sudo apt-get install build-essential git make \
- pkg-config cmake ninja-build gnome-desktop-testing libasound2-dev libpulse-dev \
- libaudio-dev libjack-dev libsndio-dev libsamplerate0-dev libx11-dev libxext-dev \
- libxrandr-dev libxcursor-dev libxfixes-dev libxi-dev libxss-dev \
- libxkbcommon-dev libdrm-dev libgbm-dev libgl1-mesa-dev libgles2-mesa-dev \
- libegl1-mesa-dev libdbus-1-dev libibus-1.0-dev libudev-dev fcitx-libs-dev
-
-Ubuntu 22.04+ can also add `libpipewire-0.3-dev libwayland-dev libdecor-0-dev` to that command line.
-
-Fedora 35, all available features enabled:
-
- sudo yum install gcc git-core make cmake \
- alsa-lib-devel pulseaudio-libs-devel nas-devel pipewire-devel \
- libX11-devel libXext-devel libXrandr-devel libXcursor-devel libXfixes-devel \
- libXi-devel libXScrnSaver-devel dbus-devel ibus-devel fcitx-devel \
- systemd-devel mesa-libGL-devel libxkbcommon-devel mesa-libGLES-devel \
- mesa-libEGL-devel vulkan-devel wayland-devel wayland-protocols-devel \
- libdrm-devel mesa-libgbm-devel libusb-devel libdecor-devel \
- libsamplerate-devel pipewire-jack-audio-connection-kit-devel \
-
-NOTES:
-- This includes all the audio targets except arts and esd, because Ubuntu
- (and/or Debian) pulled their packages, but in theory SDL still supports them.
- The sndio audio target is also unavailable on Fedora.
-- libsamplerate0-dev lets SDL optionally link to libresamplerate at runtime
- for higher-quality audio resampling. SDL will work without it if the library
- is missing, so it's safe to build in support even if the end user doesn't
- have this library installed.
-
-
-Joystick does not work
---------------------------------------------------------------------------------
-
-If you compiled or are using a version of SDL with udev support (and you should!)
-there's a few issues that may cause SDL to fail to detect your joystick. To
-debug this, start by installing the evtest utility. On Ubuntu/Debian:
-
- sudo apt-get install evtest
-
-Then run:
-
- sudo evtest
-
-You'll hopefully see your joystick listed along with a name like "/dev/input/eventXX"
-Now run:
-
- cat /dev/input/event/XX
-
-If you get a permission error, you need to set a udev rule to change the mode of
-your device (see below)
-
-Also, try:
-
- sudo udevadm info --query=all --name=input/eventXX
-
-If you see a line stating ID_INPUT_JOYSTICK=1, great, if you don't see it,
-you need to set up an udev rule to force this variable.
-
-A combined rule for the Saitek Pro Flight Rudder Pedals to fix both issues looks
-like:
-
- SUBSYSTEM=="input", ATTRS{idProduct}=="0763", ATTRS{idVendor}=="06a3", MODE="0666", ENV{ID_INPUT_JOYSTICK}="1"
- SUBSYSTEM=="input", ATTRS{idProduct}=="0764", ATTRS{idVendor}=="06a3", MODE="0666", ENV{ID_INPUT_JOYSTICK}="1"
-
-You can set up similar rules for your device by changing the values listed in
-idProduct and idVendor. To obtain these values, try:
-
- sudo udevadm info -a --name=input/eventXX | grep idVendor
- sudo udevadm info -a --name=input/eventXX | grep idProduct
-
-If multiple values come up for each of these, the one you want is the first one of each.
-
-On other systems which ship with an older udev (such as CentOS), you may need
-to set up a rule such as:
-
- SUBSYSTEM=="input", ENV{ID_CLASS}=="joystick", ENV{ID_INPUT_JOYSTICK}="1"
-
+Linux
+================================================================================
+
+By default SDL will only link against glibc, the rest of the features will be
+enabled dynamically at runtime depending on the available features on the target
+system. So, for example if you built SDL with XRandR support and the target
+system does not have the XRandR libraries installed, it will be disabled
+at runtime, and you won't get a missing library error, at least with the
+default configuration parameters.
+
+
+Build Dependencies
+--------------------------------------------------------------------------------
+
+Ubuntu 18.04, all available features enabled:
+
+ sudo apt-get install build-essential git make \
+ pkg-config cmake ninja-build gnome-desktop-testing libasound2-dev libpulse-dev \
+ libaudio-dev libjack-dev libsndio-dev libsamplerate0-dev libx11-dev libxext-dev \
+ libxrandr-dev libxcursor-dev libxfixes-dev libxi-dev libxss-dev \
+ libxkbcommon-dev libdrm-dev libgbm-dev libgl1-mesa-dev libgles2-mesa-dev \
+ libegl1-mesa-dev libdbus-1-dev libibus-1.0-dev libudev-dev fcitx-libs-dev
+
+Ubuntu 22.04+ can also add `libpipewire-0.3-dev libwayland-dev libdecor-0-dev` to that command line.
+
+Fedora 35, all available features enabled:
+
+ sudo yum install gcc git-core make cmake \
+ alsa-lib-devel pulseaudio-libs-devel nas-devel pipewire-devel \
+ libX11-devel libXext-devel libXrandr-devel libXcursor-devel libXfixes-devel \
+ libXi-devel libXScrnSaver-devel dbus-devel ibus-devel fcitx-devel \
+ systemd-devel mesa-libGL-devel libxkbcommon-devel mesa-libGLES-devel \
+ mesa-libEGL-devel vulkan-devel wayland-devel wayland-protocols-devel \
+ libdrm-devel mesa-libgbm-devel libusb-devel libdecor-devel \
+ libsamplerate-devel pipewire-jack-audio-connection-kit-devel \
+
+NOTES:
+- The sndio audio target is unavailable on Fedora (but probably not what you
+ should want to use anyhow).
+- libsamplerate0-dev lets SDL optionally link to libresamplerate at runtime
+ for higher-quality audio resampling. SDL will work without it if the library
+ is missing, so it's safe to build in support even if the end user doesn't
+ have this library installed.
+
+
+Joystick does not work
+--------------------------------------------------------------------------------
+
+If you compiled or are using a version of SDL with udev support (and you should!)
+there's a few issues that may cause SDL to fail to detect your joystick. To
+debug this, start by installing the evtest utility. On Ubuntu/Debian:
+
+ sudo apt-get install evtest
+
+Then run:
+
+ sudo evtest
+
+You'll hopefully see your joystick listed along with a name like "/dev/input/eventXX"
+Now run:
+
+ cat /dev/input/event/XX
+
+If you get a permission error, you need to set a udev rule to change the mode of
+your device (see below)
+
+Also, try:
+
+ sudo udevadm info --query=all --name=input/eventXX
+
+If you see a line stating ID_INPUT_JOYSTICK=1, great, if you don't see it,
+you need to set up an udev rule to force this variable.
+
+A combined rule for the Saitek Pro Flight Rudder Pedals to fix both issues looks
+like:
+
+ SUBSYSTEM=="input", ATTRS{idProduct}=="0763", ATTRS{idVendor}=="06a3", MODE="0666", ENV{ID_INPUT_JOYSTICK}="1"
+ SUBSYSTEM=="input", ATTRS{idProduct}=="0764", ATTRS{idVendor}=="06a3", MODE="0666", ENV{ID_INPUT_JOYSTICK}="1"
+
+You can set up similar rules for your device by changing the values listed in
+idProduct and idVendor. To obtain these values, try:
+
+ sudo udevadm info -a --name=input/eventXX | grep idVendor
+ sudo udevadm info -a --name=input/eventXX | grep idProduct
+
+If multiple values come up for each of these, the one you want is the first one of each.
+
+On other systems which ship with an older udev (such as CentOS), you may need
+to set up a rule such as:
+
+ SUBSYSTEM=="input", ENV{ID_CLASS}=="joystick", ENV{ID_INPUT_JOYSTICK}="1"
+