source: lxqt/desktop/lxqt-admin.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 lxqt-admin-download-http "&lxqt-http-repo;/&lxqt-version;/lxqt-admin-&lxqt-admin-version;.tar.xz">-->
  <!ENTITY lxqt-admin-download-http "https://github.com/lxde/lxqt-admin/releases/download/&lxqt-admin-version;/lxqt-admin-&lxqt-admin-version;.tar.xz">
  <!ENTITY lxqt-admin-download-ftp  " ">
  <!ENTITY lxqt-admin-md5sum        "66792de0ff5b7eb41b7f382a46a772a6">
  <!ENTITY lxqt-admin-size          "113 KB">
  <!ENTITY lxqt-admin-buildsize     "3.5 MB">
  <!ENTITY lxqt-admin-time          "0.2 SBU">
]>

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

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

  <title>lxqt-admin-&lxqt-admin-version;</title>

  <indexterm zone="lxqt-admin">
    <primary sortas="a-lxqt-admin">lxqt-admin</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to lxqt-admin</title>

    <para>
      The <application>lxqt-admin</application> package provides two GUI tools
      to adjust setiings of the operating system
      <application>LXQt</application> is running on.
    </para>

    &lfs81_checked;

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

    <bridgehead renderas="sect3">lxqt-admin Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="liblxqt"/> and
      <xref linkend="polkit"/>
    </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;/lxqt-admin"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of lxqt-admin</title>

    <para>
      Install <application>lxqt-admin</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>

  </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>
          lxqt-admin-time, lxqt-admin-user, and lxqt-admin-user-helper
        </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="lxqt-admin-time">
        <term><command>lxqt-admin-time</command></term>
        <listitem>
          <para>
            is a GUI to adjust time and date.
          </para>
          <indexterm zone="lxqt-admin lxqt-admin-time">
            <primary sortas="b-lxqt-admin-time">lxqt-admin-time</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lxqt-admin-user">
        <term><command>lxqt-admin-user</command></term>
        <listitem>
          <para>
            is a GUI to manage users and groups.
          </para>
          <indexterm zone="lxqt-admin lxqt-admin-user">
            <primary sortas="b-lxqt-admin-user">lxqt-admin-user</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>