Skip to content

Latest commit

 

History

History
170 lines (139 loc) · 6.91 KB

INSTALL.adoc

File metadata and controls

170 lines (139 loc) · 6.91 KB
Raw

Installing the DocBook Authoring and Publishing Suite (DAPS)

1. Distribution compatibility

DAPS has been tested on the following Linux distributions. It should also run on any other distribution, feedback is welcome.

  • openSUSE Leap 15.x and openSUSE Tumbleweed

  • SUSE Linux Enterprise 12 and 15 (including service packs)

  • Debian Jessie (8.5.0)

  • Fedora 23

  • Linux Mint 18.1

  • Ubuntu 16.04

2. Installing DAPS using a system package

Pre-built packages are available for openSUSE from the following repositories:

SUSE

http://download.opensuse.org/repositories/Documentation:Tools/
Browse to this URL and choose you SUSE version to get the complete repository URl and add it with the zypper ar command, for example: zypper ar -f http://download.opensuse.org/repositories/Documentation:Tools/openSUSE_Leap_42.2 Documentation:Tools To be able to use the complete functionality of DAPS, make sure to also install all recommended packages (zypper in --recommends --from Documentation:Tools daps)

Packages for daily builds are available from https://download.opensuse.org/repositories/Documentation:Tools:Auto/ Note that these builds are not thoroughly tested and may contain bugs.

Debian, Fedora, Ubuntu

Not available, yet. Help is appreciated.

The package is named daps. Additional packages needed by DAPS will automatically be installed.

3. Package dependencies and prerequisites

DAPS only runs on Linux and is not compatible with other operating systems. DAPS requires a few programs to be installed on your system. To use the full feature set of DAPS, make sure to also install the optional packages. If unsure, which of DAPS’s features are supported with your current installation, run ./configure --sysconfdir=/etc in the DAPS Git clone directory. This will output detailed information about the support status on your system.

Table 1. Required packages
SUSE Debian/Ubuntu Fedora

automake

autotools-dev

automake

dia

dia

dia

docbook_4

docbook

docbook-dtds

docbook_5

docbook5-xml

docbook5-schemas

 — 

docbook-xml

 — 

docbook-xsl-stylesheets1

docbook-xsl*

docbook-style-xsl1

docbook5-xsl-stylesheets

docbook-xsl-ns

docbook5-style-xsl

ImageMagick

imagemagick

ImageMagick

inkscape

inkscape

inkscape

libxml2-tools

libxml2-utils

libxml2

 — 

libxml-commons-external-java

 — 

 — 

libxmlgraphics-commons-java

 — 

libxslt-tools

 — 

libxslt

jing

jing

jing

make

make

make

poppler-tools

poppler-utils

poppler-utils

python-xml

python3-libxml2

python3-libxml2

python-lxml

python3-lxml

python3-lxml

sgml-skel

sgml-base

sgml-common

svg-dtd

sgml-data

?

w3m

w3m

w3m

xml-commons-jaxp-1.3-apis

 — 

xml-commons-apis

xmlgraphics-fop2

fop2

fop2

xmlstarlet

xmlstarlet

xmlstarlet

 — 

xsltproc

 — 

zip

zip

zip

1: minimum version: 1.7.8 2: minimum version: 0.96, 1.x or better is recommended

Table 2. Required Packages for AsciiDoc Support
SUSE Debian/Ubuntu Fedora

rubygem(asciidoctor)3

asciidoctor

asciidoctor

3: The exact package name depends on the Ruby version installed on your system. Using this capability string with zypper install ensures the correct package is installed.

Table 3. Optional packages
SUSE Debian/Ubuntu Fedora

aspell

aspell

aspell

ditaa

ditaa

ditaa

epubcheck

epubcheck

?

libreoffice-draw

libreoffice-draw

libreoffice-draw

optipng

optipng

optipng

perl-checkbot

checkbot

?

remake

remake

n/a4

saxon6

libsaxon-java

?

saxon6-scripts

 — 

?

xmlformat

xmlformat-perl

?

4 The remake package on Fedora is a different software.

To install optional packages at a later point in time, run daps-check-deps to check for already installed and missing dependencies.

4. Installing DAPS from the source

DAPS can be installed from a downloaded release TAR or from a local Git clone.

  1. Download the latest DAPS version archive and unpack it or, alternatively clone the main branch from GitHub:
    git clone https://github.com/openSUSE/daps.git -b main --single-branch

  2. Change into the daps directory

  3. Run ./configure --sysconfdir=/etc
    Carefully check the configuration summary. Run ./configure --help for more information on how to change installation paths. If you need to change something, re-run the configure command again afterwards.

  4. Run make

  5. Run sudo make install

  6. Run daps --help for a brief introduction to DAPS

5. Running DAPS from a local Git clone

If you do not want to install DAPS or always want to use the latest development version, you can run DAPS directly from a local Git clone.

  1. Make sure the prerequisites listed in [anchor-1] are fulfilled.

  2. Check out DAPS. Either choose the latest stable version (safe) or the development version (may not work)

    Checking out the latest release

    git clone https://github.com/openSUSE/daps.git -b main --single-branch

    Checking out the latest development version

    git clone https://github.com/openSUSE/daps.git

  3. (Skip this step for SUSE). Go to the checkout directory and run the following command according to your distribution:

    Debian/Ubuntu

    ./configure --sysconfdir=/etc
    make debian

    Fedora/Red Hat

    ./configure --sysconfdir=/etc
    make redhat

    SUSE

    Do nothing

  4. Test DAPS by building the DAPS user manual:
    cd <path_to_checkout>/daps/doc
    ../bin/daps --dapsroot .. -d DC-daps-user pdf

To run DAPS from the checkout directory, use the following command:
<path_to_checkout>/bin/daps --dapsroot=<path_to_checkout> [options] <subcommand> [options]