docs/README-linux.md
author Sam Lantinga <slouken@libsdl.org>
Fri, 07 Oct 2016 17:46:58 -0700
changeset 10486 5bf595c48fd4
parent 10376 a18a3cd50984
child 10500 c3874aa1f2d1
permissions -rw-r--r--
Converted README documentation to DOS text format
     1 Linux
     2 ================================================================================
     3 
     4 By default SDL will only link against glibc, the rest of the features will be
     5 enabled dynamically at runtime depending on the available features on the target
     6 system. So, for example if you built SDL with Xinerama support and the target
     7 system does not have the Xinerama libraries installed, it will be disabled
     8 at runtime, and you won't get a missing library error, at least with the 
     9 default configuration parameters.
    10 
    11 
    12 ================================================================================
    13 Build Dependencies
    14 ================================================================================
    15     
    16 Ubuntu 13.04, all available features enabled:
    17 
    18 sudo apt-get install build-essential mercurial make cmake autoconf automake \
    19 libtool libasound2-dev libpulse-dev libaudio-dev libx11-dev libxext-dev \
    20 libxrandr-dev libxcursor-dev libxi-dev libxinerama-dev libxxf86vm-dev \
    21 libxss-dev libgl1-mesa-dev libesd0-dev libdbus-1-dev libudev-dev \
    22 libgles1-mesa-dev libgles2-mesa-dev libegl1-mesa-dev libibus-1.0-dev
    23 
    24 Ubuntu 16.04 can also add "libwayland-dev libxkbcommon-dev wayland-protocols"
    25 to that command line for Wayland support.
    26 
    27 Ubuntu 16.10 can also add "libmirclient-dev libxkbcommon-dev" to that command
    28 line for Mir support.
    29 
    30 NOTES:
    31 - This includes all the audio targets except arts, because Ubuntu pulled the 
    32   artsc0-dev package, but in theory SDL still supports it.
    33 - DirectFB isn't included because the configure script (currently) fails to find
    34   it at all. You can do "sudo apt-get install libdirectfb-dev" and fix the 
    35   configure script to include DirectFB support. Send patches.  :)
    36 
    37 
    38 ================================================================================
    39 Joystick does not work
    40 ================================================================================
    41 
    42 If you compiled or are using a version of SDL with udev support (and you should!)
    43 there's a few issues that may cause SDL to fail to detect your joystick. To
    44 debug this, start by installing the evtest utility. On Ubuntu/Debian:
    45 
    46     sudo apt-get install evtest
    47     
    48 Then run:
    49     
    50     sudo evtest
    51     
    52 You'll hopefully see your joystick listed along with a name like "/dev/input/eventXX"
    53 Now run:
    54     
    55     cat /dev/input/event/XX
    56 
    57 If you get a permission error, you need to set a udev rule to change the mode of
    58 your device (see below)    
    59     
    60 Also, try:
    61     
    62     sudo udevadm info --query=all --name=input/eventXX
    63     
    64 If you see a line stating ID_INPUT_JOYSTICK=1, great, if you don't see it,
    65 you need to set up an udev rule to force this variable.
    66 
    67 A combined rule for the Saitek Pro Flight Rudder Pedals to fix both issues looks 
    68 like:
    69     
    70    SUBSYSTEM=="input", ATTRS{idProduct}=="0763", ATTRS{idVendor}=="06a3", MODE="0666", ENV{ID_INPUT_JOYSTICK}="1"
    71    SUBSYSTEM=="input", ATTRS{idProduct}=="0764", ATTRS{idVendor}=="06a3", MODE="0666", ENV{ID_INPUT_JOYSTICK}="1"
    72    
    73 You can set up similar rules for your device by changing the values listed in
    74 idProduct and idVendor. To obtain these values, try:
    75     
    76     sudo udevadm info -a --name=input/eventXX | grep idVendor
    77     sudo udevadm info -a --name=input/eventXX | grep idProduct
    78     
    79 If multiple values come up for each of these, the one you want is the first one of each.    
    80 
    81 On other systems which ship with an older udev (such as CentOS), you may need
    82 to set up a rule such as:
    83     
    84     SUBSYSTEM=="input", ENV{ID_CLASS}=="joystick", ENV{ID_INPUT_JOYSTICK}="1"
    85