source: general/graphlib/librsvg.xml@ 34165e6b

<?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 librsvg-download-http "&gnome-download-http;/librsvg/&librsvg-minor;/librsvg-&librsvg-version;.tar.xz">
  <!ENTITY librsvg-download-ftp  " ">
  <!ENTITY librsvg-md5sum        "8b700dd04c10bf65dbc6824d2780561d">
  <!ENTITY librsvg-size          "5.4 MB">
  <!ENTITY librsvg-buildsize     "1.1 GB (16 MB installed), add 673 MB for tests">
  <!ENTITY librsvg-time          "1.6 SBU (add 1.3 SBU for tests; both using parallelism=4)">
]>

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


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

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

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

    <para>
      The <application>librsvg</application> package contains
      a library and tools used to manipulate, convert and view
      Scalable Vector Graphic (SVG) images.
    </para>

    &lfs120_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cairo"/>,
      <xref linkend="gdk-pixbuf"/>,
      <xref linkend="pango"/>, and
      <xref linkend="rust"/>
    </para>

    &build-use-internet;

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/> and
      <xref linkend="vala"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="docutils"/> (for man pages),
      <xref linkend="gi-docgen"/> (for documentation), and
      <xref linkend="xorg7-font"/> (for tests)
    </para>

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr    \
            --enable-vala    \
            --disable-static \
            --docdir=/usr/share/doc/librsvg-&librsvg-version; &amp;&amp;
make</userinput></screen>

    <!-- With some locales (zh_CN.UTF-8) 31 tests fail.  With LC_ALL=C only
         one failure.
         https://gitlab.gnome.org/GNOME/librsvg/-/issues/1021 -->
    <para>
      To test the results, issue: <command>LC_ALL=C make -k check</command>.
      One test, <filename>tests::bugs_bug668_small_caps_svg</filename>, is
      known to fail.
    </para>

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

<screen role="root"><userinput>make DOC_INSTALL_DIR='$(docdir)' install</userinput></screen>

    <note>
      <para>
        If you installed the package on to your system using a
        <quote>DESTDIR</quote> method, an important file was not installed and
        should be copied and/or generated. Generate it using the following
        command as the <systemitem class="username">root</systemitem> user:
      </para>

<screen role="root"><userinput>gdk-pixbuf-query-loaders --update-cache</userinput></screen>
    </note>


  </sect2>

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

    <para>
      <parameter>--enable-vala</parameter>: This switch enables
      building of the Vala bindings. Remove this switch if you don't have
      <xref linkend="vala"/> installed.
    </para>

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

    <para>
      <parameter>DOC_INSTALL_DIR='$(docdir)'</parameter>: This override
      ensures installing the API documentation into the expected location
      if <xref linkend='gi-docgen'/> is installed.
    </para>

    <para>
      <option>--disable-introspection</option>: Use this switch if you have
      not installed <application>Gobject Introspection</application>.
    </para>

    <para>
      <option>--disable-gtk-doc</option>: This switch prevents building
      the API documentation, even if <xref linkend="gi-docgen"/> (despite
      the name of the option) is available.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          rsvg-convert
        </seg>
        <seg>
          librsvg-2.so and
          libpixbufloader-svg.so (installed in /usr/lib/gdk-pixbuf-2.0/2.10.0/loaders)
        </seg>
        <seg>
          /usr/include/librsvg-2.0 and
          /usr/share/doc/librsvg-&librsvg-version;
<!--      /usr/share/gtk-doc/html/rsvg-2.0 not built with
               current instructions (needs gi-docgen)-->
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="rsvg-convert">
        <term><command>rsvg-convert</command></term>
        <listitem>
          <para>
            is used to convert images into PNG, PDF, PS, SVG and other formats
          </para>
          <indexterm zone="librsvg rsvg-convert">
            <primary sortas="b-rsvg-convert">rsvg-convert</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="librsvg-2">
        <term><filename class="libraryfile">librsvg-2.so</filename></term>
        <listitem>
          <para>
            provides the functions to render Scalable Vector Graphics
          </para>
          <indexterm zone="librsvg librsvg-2">
            <primary sortas="c-librsvg-2">librsvg-2.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libpixbufloader-svg">
        <term><filename class="libraryfile">libpixbufloader-svg.so</filename></term>
        <listitem>
          <para>
            is the <application>Gdk Pixbuf</application> plugin that allows
            <application>GTK+</application> applications to render Scalable
            Vector Graphics images
          </para>
          <indexterm zone="librsvg libpixbufloader-svg">
            <primary sortas="c-libpixbufloader-svg">libpixbufloader-svg.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>