README.rst

   1 libdrm - userspace library for drm
   2 ----------------------------------
   3
   4 This is libdrm, a userspace library for accessing the DRM, direct rendering
   5 manager, on Linux, BSD and other operating systems that support the ioctl
   6 interface.
   7 The library provides wrapper functions for the ioctls to avoid exposing the
   8 kernel interface directly, and for chipsets with drm memory manager, support
   9 for tracking relocations and buffers.
  10 New functionality in the kernel DRM drivers typically requires a new libdrm,
  11 but a new libdrm will always work with an older kernel.
  12
  13 libdrm is a low-level library, typically used by graphics drivers such as
  14 the Mesa drivers, the X drivers, libva and similar projects.
  15
  16
  17 Compiling
  18 ---------
  19
  20 libdrm has two build systems, a legacy autotools build system, and a newer
  21 meson build system. The meson build system is much faster, and offers a
  22 slightly different interface, but otherwise provides an equivalent feature set.
  23
  24 To use it:
  25
  26     meson builddir/
  27
  28 By default this will install into /usr/local, you can change your prefix
  29 with --prefix=/usr (or `meson configure builddir/ -Dprefix=/usr` after
  30 the initial meson setup).
  31
  32 Then use ninja to build and install:
  33
  34     ninja -C builddir/ install
  35
  36 If you are installing into a system location you will need to run install
  37 separately, and as root.
  38
  39
  40 Alternatively you can invoke autotools configure:
  41
  42         ./configure
  43
  44 By default, libdrm  will install into the /usr/local/  prefix.  If you
  45 want  to  install   this  DRM  to  replace  your   system  copy,  pass
  46 --prefix=/usr and  --exec-prefix=/ to configure.  If  you are building
  47 libdrm  from a  git checkout,  you first  need to  run  the autogen.sh
  48 script.  You can  pass any options to autogen.sh  that you would other
  49 wise  pass to configure,  or you  can just  re-run configure  with the
  50 options you need once autogen.sh finishes.
  51
  52 Next step is to build libdrm:
  53
  54         make
  55
  56 and once make finishes successfully, install the package using
  57
  58         make install
  59
  60 If you are installing into a system location, you will need to be root
  61 to perform the install step.