source: general/graphlib/libgxps.xml@ aeb0a9c

<?xml version="1.0" encoding="UTF-8"?>
<!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 libgxps-download-http "&gnome-download-http;/libgxps/0.3/libgxps-&libgxps-version;.tar.xz">
  <!ENTITY libgxps-download-ftp  " ">
  <!ENTITY libgxps-md5sum        "0527ac7c8c405445e96a5baa6019a0c3">
  <!ENTITY libgxps-size          "80 KB">
  <!ENTITY libgxps-buildsize     "5.4 MB">
  <!ENTITY libgxps-time          "0.1 SBU">
]>

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

  <title>libgxps-&libgxps-version;</title>

  <indexterm zone="libgxps">
    <primary sortas="a-libgxps">libgxps</primary>
  </indexterm>

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

    <para>
      The <application>libgxps</application> package provides an interface
      to manipulate XPS documents.
    </para>

    &lfs122_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gtk3"/>,
      <xref linkend="lcms2"/>,
      <xref linkend="libarchive"/>,
      <xref linkend="libjpeg"/>,
      <xref linkend="libtiff"/>, and
      <xref linkend="libxslt"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="git"/> and
      <xref linkend="gtk-doc"/>
    </para>

  </sect2>

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

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

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

meson setup --prefix=/usr --buildtype=release .. &amp;&amp;
ninja</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>ninja install</userinput></screen>
  </sect2>

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

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

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

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

      <seglistitem>
        <seg>
          xpstojpeg, xpstopdf, xpstopng, xpstops, and xpstosvg
        </seg>
        <seg>
          libgxps.so
        </seg>
        <seg>
          /usr/include/libgxps
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="xpstojpeg">
        <term><command>xpstojpeg</command></term>
        <listitem>
          <para>
            converts XPS documents to a JPEG image
          </para>
          <indexterm zone="libgxps xpstojpeg">
            <primary sortas="b-xpstojpeg">xpstojpeg</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xpstopdf">
        <term><command>xpstopdf</command></term>
        <listitem>
          <para>
            converts XPS documents to PDF format
          </para>
          <indexterm zone="libgxps xpstopdf">
            <primary sortas="b-xpstopdf">xpstopdf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xpstopng">
        <term><command>xpstopng</command></term>
        <listitem>
          <para>
            converts XPS documents to a PNG image
          </para>
          <indexterm zone="libgxps xpstopng">
            <primary sortas="b-xpstopng">xpstopng</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xpstops">
        <term><command>xpstops</command></term>
        <listitem>
          <para>
            converts XPS documents to PostScript
          </para>
          <indexterm zone="libgxps xpstops">
            <primary sortas="b-xpstops">xpstops</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xpstosvg">
        <term><command>xpstosvg</command></term>
        <listitem>
          <para>
            converts XPS documents to SVG images
          </para>
          <indexterm zone="libgxps xpstosvg">
            <primary sortas="b-xpstosvg">xpstosvg</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgxps-lib">
        <term><filename class="libraryfile">libgxps.so</filename></term>
        <listitem>
          <para>
            contains API functions for manipulating XPS documents
          </para>
          <indexterm zone="libgxps libgxps-lib">
            <primary sortas="c-libgxps">libgxps.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>

</sect1>