INSTALL.rst

   1 ============
   2 Installation
   3 ============
   4
   5 (LADI) *a2jmidid* primary build system is the |waf| build system.
   6 *a2jmidid* can use the |meson| build system.
   7
   8
   9 Configure, build & install using |waf| with a2jmidid
  10 -------------------
  11
  12 Configure it::
  13
  14   ./waf configure
  15
  16 This will configure for installation to /usr/local prefix.
  17 If you want to use other prefix, use --prefix option::
  18
  19   ./waf configure --prefix=/usr
  20
  21 For full list of options, run::
  22
  23   ./waf configure --help
  24
  25 There are two custom options:
  26
  27  * "--disable-dbus will" force disable dbus support, even if dependencies are present
  28  * "--enable-pkg-config-dbus-service-dir" will force D-Bus service install
  29    dir to be one returned by pkg-config. This is usually needed when
  30    prefix is /usr/local because dbus daemon scans /usr for service
  31    files but does not in /usr/local
  32
  33 Build it::
  34
  35   ./waf
  36
  37 You can use -j option to enable building on more than one CPU::
  38
  39   ./waf -j 4
  40
  41 Install it::
  42
  43   ./waf install
  44
  45 You probably want to run later as superuser to install system-wide
  46
  47 Configure and build using |meson|
  48 -------------------
  49
  50 To configure the project, |meson|'s |meson_universal_options| (e.g. *prefix*)
  51 can be used to prepare a build directory::
  52
  53   meson --prefix=/usr build
  54
  55 One additional - project specific - option enables for building without |dbus|
  56 support::
  57
  58   meson --prefix=/usr -Ddisable-dbus=true build
  59
  60 To build the application |ninja| is required::
  61
  62   ninja -C build
  63
  64 Install using |meson|
  65 -------
  66
  67 |meson| is able to install the project components to the system directories
  68 (when run as root), while honoring the *DESTDIR* environment variable::
  69
  70   DESTDIR="/some/other/location" meson install -C build
  71
  72 .. |waf| raw:: html
  73
  74   <a href="https://waf.io/" target="_blank">WAF</a>
  75
  76 .. |meson| raw:: html
  77
  78   <a href="https://mesonbuild.com/" target="_blank">Meson</a>
  79
  80 .. |meson_universal_options| raw:: html
  81
  82   <a href="https://mesonbuild.com/Builtin-options.html#universal-options" target="_blank">universal options</a>
  83
  84 .. |dbus| raw:: html
  85
  86   <a href="https://www.freedesktop.org/wiki/Software/dbus/" target="_blank">D-Bus</a>
  87
  88 .. |ninja| raw:: html
  89
  90   <a href="https://ninja-build.org/" target="_blank">Ninja</a>
  91