source: lxqt/apps/obconf-qt.xml@ 737f339

<?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;

<!-- As of August 2017, downloads.lxqt.org is down. Use github archives
     instead, but keep the old link in case the host become available again.
     According to lxqt devs, they are working on it...
  <!ENTITY obconf-qt-download-http "https://downloads.lxqt.org/obconf-qt/&obconf-qt-version;/obconf-qt-&obconf-qt-version;.tar.xz">-->
  <!ENTITY obconf-qt-download-http "https://github.com/lxde/obconf-qt/releases/download/&obconf-qt-version;/obconf-qt-&obconf-qt-version;.tar.xz">
  <!ENTITY obconf-qt-download-ftp  " ">
  <!ENTITY obconf-qt-md5sum        "91e6e57e80380437b9db2622745dfd4e">
  <!ENTITY obconf-qt-size          "33 KB">
  <!ENTITY obconf-qt-buildsize     "3.0 MB">
  <!ENTITY obconf-qt-time          "0.2 SBU">
]>

<sect1 id="obconf-qt" xreflabel="obconf-qt-&obconf-qt-version;">
  <?dbhtml filename="obconf-qt.html"?>

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

  <title>obconf-qt-&obconf-qt-version;</title>

  <indexterm zone="obconf-qt">
    <primary sortas="a-obconf-qt">obconf-qt</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to obconf-qt</title>

    <para>
      The <application>obconf-qt</application> package is an
      <application>OpenBox</application> Qt based configuration tool.</para>

    &lfs81_checked;

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

    <bridgehead renderas="sect3">obconf-qt Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gtk2"/> (for <command>gtk-update-icon-cache</command>),
      <xref linkend="hicolor-icon-theme"/>,
      <xref linkend="liblxqt"/>, and
      <xref linkend="openbox"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="git"/> (to download translation files) or
      <xref linkend="lxqt-l10n"/> (to add localization files)
    </para>

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

  <sect2 role="installation">
    <title>Installation of obconf-qt</title>

    <para>
       Install <application>obconf-qt</application> by running the following
       commands:
    </para>

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

cmake -DCMAKE_BUILD_TYPE=Release          \
      -DCMAKE_INSTALL_PREFIX=$LXQT_PREFIX \
      -DPULL_TRANSLATIONS=no              \
      ..       &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>

    <para>
      If you installed in /opt, again as the
      <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>if [ "$LXQT_PREFIX" != /usr ]; then
  ln -svf $LXQT_PREFIX/share/applications/obconf-qt.desktop \
          /usr/share/applications
fi</userinput></screen>

  </sect2>

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

    <para>
      <parameter>-DPULL_TRANSLATIONS=no</parameter>: Removes the need for
      <xref linkend="git"/>, which would otherwise be requested to download
      the translation files.
    </para>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          obconf-qt
        </seg>
        <seg>
          None
        </seg>
        <seg>
          None
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="obconf-qt-prog">
        <term><command>obconf-qt</command></term>
        <listitem>
          <para>
            is a Qt based GUI configuration tool for
            <application>OpenBox</application>.
          </para>
          <indexterm zone="obconf-qt obconf-qt-prog">
            <primary sortas="b-obconf-qt">obconf-qt</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>