Installing Libinsane

GNU/Linux

If Libinsane is packaged in your distribution, you're advised to use this version by default. Otherwise you can compile it and install yourself.

Libinsane and its gobject bindings are built together. Packagers remain free to package them separately.

Build dependencies for Debian / Ubuntu

sudo apt install \
        make \
        meson \
        gtk-doc-tools doxygen plantuml graphviz \
        build-essential \
        libsane-dev \
        libgirepository1.0-dev gobject-introspection \
        python3-gi \
        libcunit1-ncurses-dev \
        valgrind \
        valac
 
# optional dependencies for static analysis
sudo apt install sparse clang-tidy-11

Build dependencies for Fedora

sudo dnf install \
        make \
        meson \
        gtk-doc \
        doxygen plantuml graphviz \
        sane-backends-devel \
        gobject-introspection-devel python3-gobject \
        CUnit-devel \
        valgrind \
        vala
 
# optional dependencies for static analysis
sudo dnf install sparse clang-tools-extra python3-pyyaml

GNU/Linux: Compilation

git clone https://gitlab.gnome.org/World/OpenPaperwork/libinsane.git
cd libinsane
# prefix must be set immediately (because of the way Meson and Ninja do things)
# (see below)
make PREFIX=/usr
make test PREFIX=/usr  # optional

GNU/Linux: Installation

sudo make install PREFIX=/usr  # PREFIX is optional, default is /usr/local

Important: If you intend to use another programming language than C, you will need GObject Introspection. By default, GObject Introspection only looks in /usr. If you install it somewhere else (/usr/local for instance), you will have to define the following environment variables before running your program:

# (values may vary depending on your distribution and version of Meson)
export LD_LIBRARY_PATH=/usr/local/lib/x86_64-linux-gnu
export GI_TYPELIB_PATH=/usr/local/lib/x86_64-linux-gnu/girepository-1.0

GNU/Linux: Uninstalling

Depending on your versions of Meson and Ninja, the following may or may not work:

sudo make uninstall

GNU/Linux: Not installing Libinsane

If you do not wish to install Libinsane system-wide, you can use the script activate_test_env.sh. It will set all the environment variables required so your program can find Libinsane.

cd libinsane
make
source ./activate_test_env.sh

Macos

Requires Homebrew.

brew install \
    cunit \
    doxygen \
    graphviz \
    gtk-doc \
    meson \
    plantuml \
    pygobject3 gobject-introspection \
    sane-backends \
    vala

Other than that, GNU/Linux instructions apply.

Windows (Msys2)

2018/10/16: Your user name must not contain any spaces or build will fail.

To compile Libinsane on Windows, you have first to install MSYS2. Libinsane is not packaged in MSYS2. Therefore you must compile and install it yourself.

Note that if you intend to build a 32bits executable for your application, you have to use the shortcut and environment MSYS2 MinGW32. For a 64bits executable you must use MSYS2 MinGW64.

Once MSYS2 is installed and up-to-date (pacman -Syu), you can install the required dependencies with the following commands.

Windows: Build dependencies

If you plan on compiling your program as a 64bits executable:

pacman -S \
        make \
        mingw-w64-ucrt-x86_64-cunit \
        mingw-w64-ucrt-x86_64-doxygen \
        mingw-w64-ucrt-x86_64-gcc \
        mingw-w64-ucrt-x86_64-gobject-introspection \
        mingw-w64-ucrt-x86_64-meson \
        mingw-w64-ucrt-x86_64-python3-gobject \
        mingw-w64-ucrt-x86_64-vala

If you plan on compiling your program as a 32bits executable, you just have to replace all the x86_64 by i686.

Windows: Compilation

2018/10/16: Your user name must not contain any spaces or build will fail.

git clone https://gitlab.gnome.org/World/OpenPaperwork/libinsane.git
cd libinsane
# make will call meson. The first thing meson will do is to generate the ninja
# build files. Those files include the value of 'PREFIX'. So even if you don't
# install Libinsane at this step, you must already specify the PREFIX path.
# Replace '/ucrt64' by '/mingw32' below if you want to build 32 bits binaries.
make PREFIX=/ucrt64
make test PREFIX=/ucrt64 # optional

Installation

Depending whether you intend to build a 32bits executable for your application or a 64bits executable, you will have to install Libinsane in either /ucrt64 or /mingw32:

# Replace '/ucrt64' by '/mingw32' below if you want to build 32 bits binaries
make install PREFIX=/ucrt64

Uninstallation

make uninstall