source: kde5/frameworks/kdoctools.xml@ 3899973

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY kdoctools-download-http "&kf5-download-http;/kdoctools-&kf5-version;.tar.xz">
  <!ENTITY kdoctools-download-ftp  "&kf5-download-ftp;/kdoctools-&kf5-version;.tar.xz">
  <!ENTITY kdoctools-md5sum        "7048b70497c07e65c5f36842fd074850">
  <!ENTITY kdoctools-size          "356 KB">
  <!ENTITY kdoctools-buildsize     "14 MB">
  <!ENTITY kdoctools-time          "0.2 SBU">
]>

<sect1 id="kdoctools" xreflabel="KDocTools-&kf5-version;">
  <?dbhtml filename="kdoctools.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>KDocTools-&kf5-version;</title>

  <indexterm zone="kdoctools">
    <primary sortas="a-KDocTools">KDocTools</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to KDocTools</title>

    <para>
      The <application>KDocTools</application> package contains tools to
      generate documentation in various format from DocBook files.
    </para>

    &lfs75_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&kdoctools-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&kdoctools-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &kdoctools-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &kdoctools-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &kdoctools-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &kdoctools-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">KDocTools Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="DocBook"/>,
      <xref linkend="docbook-xsl"/>,
      <xref linkend="karchive"/> and
      <xref linkend="libxslt"/>
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/kdoctools"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of KDocTools</title>

    <para>
      Install <application>KDocTools</application> by running the following
      commands:
    </para>

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DLIB_INSTALL_DIR=lib              \
      -DBUILD_TESTING=OFF                \
      .. &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/cmake-release.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/kf5-libdir.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/kf5-tests.xml"/>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          checkXML5 and meinproc5
        </seg>
        <seg>
          libKF5XsltKde.a
        </seg>
        <seg>
          $KF5_PREFIX/include/KF5/XsltKde,
          $KF5_PREFIX/lib/cmake/KF5DocTools,
          $KF5_PREFIX/share/doc/HTML/*/kdoctools5-common and
          $KF5_PREFIX/share/kf5/kdoctools
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>