/ .. / / -> download
s1kd-tools - Building, installing and uninstalling
khzae.net
2020-09-08

General
=======

There are multiple ways to install the s1kd-tools:

-   using a package manager and the pre-compiled Debian (.deb) or Red
    Hat (.rpm) packages

-   building from source

Using a package manager
=======================

Debian (.deb) and Red Hat (.rpm) packages are provided to easily
install, upgrade or uninstall the s1kd-tools on Linux systems using a
package manager. The examples below focus on the standard dpkg (for
Debian-based distributions) and rpm (for Red Hat-based distributions).

Installing
----------

You can download the latest release of the s1kd-tools from
http://khzae.net/1/s1000d/s1kd-tools/releases/latest. Then use one of
the following commands to install it:

Debian:

    # dpkg -i s1kd-tools_[version]_[arch].deb

Red Hat:

    # rpm -i s1kd-tools.[version].[arch].rpm

Uninstalling
------------

To uninstall using the package manager, use one of the following
commands:

Debian:

    # dpkg -r s1kd-tools

Red Hat:

    # rpm -e s1kd-tools

Building from source
====================

Requirements
------------

To build the executables:

-   coreutils and binutils

-   xxd

-   pkg-config

-   libxml2, libxslt, libexslt

-   If using the SAXON XPath engine: Saxon/C

-   If using the XQILLA XPath engine: Xerces-C, XQilla

To build the documentation from source:

-   s1kd2db

-   pandoc

Windows build environment
-------------------------

To build the executables on Windows, an environment such as MinGW or
Cygwin is recommended. These provide POSIX-compatible tools, such as
make, that allow the s1kd-tools to be built and installed on a Windows
system in the same way as on a Linux system.

Building and installing
-----------------------

Run the following commands to build the executables, and install both
the executables and documentation:

    $ make
    # make install

Uninstalling
------------

To uninstall the executables and documentation:

    # make uninstall

Additional Makefile parameters
------------------------------

The following parameters can be given to make to control certain options
when building and installing.

PREFIX

The PREFIX variable determines where the s1kd-tools are installed when
running make install, and where they are uninstalled from when running
make uninstall. The default value is /usr/local.

Example:

    # make PREFIX=/usr install

    # make PREFIX=/usr uninstall

XPATH2_ENGINE

The XPATH2_ENGINE variable determines which XPath 2.0 implementation the
s1kd-brexcheck tool will use to evaluate the object paths of BREX rules.

The s1kd-tools are built on libxml, so by default s1kd-brexcheck uses
libxml's XPath implementation. However, libxml only supports XPath 1.0.
While as of Issue 5.0, the S1000D default BREX rules are all compatible
with XPath 1.0, Issue 4.0 and up do reference the XPath 2.0
specification. Therefore, if your project needs XPath 2.0 support for
BREX rules, you should select one of these implementations:

SAXON
    Experimental implementation using the Saxon/C library. Slower, and
    Saxon/C itself is a very large dependency. Not recommended at this
    time due to memory leak issues.

XQILLA
    Experimental implementation using the Xerces-C and XQilla libraries.
    A little slower than libxml, but faster than Saxon/C, and the
    dependencies are much smaller than the latter. This is currently the
    recommended implementation if you need XPath 2.0 support.

Example:

    $ make XPATH2_ENGINE=XQILLA


/ gopher://khzae.net/0/s1000d/s1kd-tools/docs/general/install.txt
Styles: Light Dark Classic