installation-filesystem-layout.adoc: Adjust for LADI project

This commit is contained in:
Nedko Arnaudov 2023-05-27 21:01:23 +03:00
parent 6318725689
commit 317e0c8fe6
1 changed files with 13 additions and 19 deletions

View File

@ -4,24 +4,24 @@ This page represents installation layout on a Linux system.
This includes:
* `jackd` - classic JACK launcher executable
* `jackdbus` - D-Bus JACK service (installed if D-Bus integration is built)
* examples clients
* tools
* `libjack` - library that JACK-aware client applications link to
* `jackdbus` - The D-Bus frontend for JACK server
* `jack_control` - Commandline frontend to jackdbus
They are installed in `<PREFIX>/bin/`.
They are to be installed in `<PREFIX>/bin/`.
== Libraries
The `libjack`, `libjacknet` and `libjackserver` libraries are installed in `<PREFIX>/lib/`.
The `libjack`, `libjacknet` and `libjackserver` libraries are to installed in `<PREFIX>/lib64/` (for 64-bit libraries) or `<PREFIX>/lib/` (for 32-bit libraries).
A libtool-like installation is made with `.la` files and symbolic links, like this:
SONAME of libjack is libjack.so.0, so symbolic link should be created, like this:
libjack.la
libjack.so --> libjack.so.0.1.0
libjack.so.0 --> libjack.so.0.1.0
libjack.so.0.1.0
Depending on JACK server version, the libjack.so.0 symlink target
will be different. libjack.so.0.1.0 is the version from JACK2.
== Drivers
Jack drivers are installed into `<PREFIX>/lib/jack/` as dynamic libraries.
@ -32,17 +32,11 @@ In-process clients are installed into `<PREFIX>/lib/jack/`.
== D-Bus service file
If `jackdbus` is being installed, a D-Bus service file is installed too. This file instructs the D-Bus session bus how to activate the JACK controller object upon request.
`jackdbus` service is auto-activated upon request through a D-Bus service file installed system-wide. The org.jackaudio.service file instructs the D-Bus session bus how to activate the JACK controller object upon request.
By default the `org.jackaudio.service` file is installed in `<PREFIX>/share/dbus-1/services/`.
However, a user may force using the real D-Bus service directory by specifying `--enable-pkg-config-dbus-service-dir` when configuring the the sources for building.
The D-Bus service file directory `<PREFIX>/share/dbus-1/services/` will differ from the one specified in the pkg-config file of D-Bus when they are installed in different prefixes. If the service file is installed in a different prefix, the D-Bus session bus daemon should be instructed to search in the appropriate directory (out of scope of JACK installation process, as implemented in the distribution tarball).
== Systemd unit
A systemd unit file is installed as `<PREFIX>/lib/systemd/user/jack@.service`. System-wide configuration files for this systemd unit should be put in `/etc/jack` and user configuration files in `~/.config/jack` with a `.conf` filename extension.
NOTE: When not built as system-wide installed sesion bus dbus service, jackdbus can be configured with --enable-pkg-config-dbus-service-dir so to the system-wide D-Bus service directory. --enable-pkg-config-dbus-service-dir is unsupported in packged versions. If the service file is installed in a different prefix, the D-Bus session bus daemon configuration should be adjuste so to search in the appropriate directory.
== Headers
@ -50,7 +44,7 @@ C headers are installed in a JACK specific header directory, `<PREFIX>/include/j
== pkg-config
`jack.pc` is installed in `<PREFIX>/lib/pkgconfig/`.
`jack.pc` is installed in `<PREFIX>/lib64/pkgconfig/` (for 64-bit) or `<PREFIX>/lib/pkgconfig/` (for 32-bit).
== User documentation
@ -62,7 +56,7 @@ HTML documentation is installed in a JACK specific directory `<PREFIX>/share/jac
The index file of the HTML documentation is in `<PREFIX>/share/jack-audio-connection-kit/reference/html/`.
== Additional notes
== Filesystem relocation
Some unusual things related to installation relocateability: