source: general/graphlib/librsvg.xml@ f210178

<?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/2.34/librsvg-&librsvg-version;.tar.xz">
  <!ENTITY librsvg-download-ftp  "&gnome-download-ftp;/librsvg/2.34/librsvg-&librsvg-version;.tar.xz">
  <!ENTITY librsvg-md5sum        "5287d0066eb9e3ac55d4e3597694232b">
  <!ENTITY librsvg-size          "488 KB">
  <!ENTITY librsvg-buildsize     "20 MB">
  <!ENTITY librsvg-time          "0.5 SBU">
]>

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

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

  <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
    <filename class="libraryfile">librsvg</filename> libraries and tools used to
    manipulate, convert and view Scalable Vector Graphic (SVG) images.</para>

    &lfs70_built;

    <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="gtk2"/> and
    <xref linkend="libxml2"/></para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended"><xref linkend="libcroco"/> and
    <xref linkend="libgsf"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="gtk-doc"/>,
    <xref linkend="docbook-utils"/>, and
    <xref linkend="python"/>, providing a legacy wrapper interface
    <command>rsvg</command> for the newer
    <command>rsvg-convert</command>.</para>


    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/librsvg"/></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 \
            --sysconfdir=/etc &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <command>make check</command>.</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><option>--enable-static=no</option>: This switch prevents the static
    libraries being installed.</para>

    <para><option>--disable-gtk-doc</option>: This parameter prevents
    the rebuilding of documentation during the <command>make</command>
    command. It will also prevent the existing documentation in the source
    tree from being installed.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>rsvg, rsvg-convert, and rsvg-view</seg>
        <seg>libsvg.{so,a}, svg_loader.{so,a}, and librsvg-2.{so,a}</seg>
        <seg>/usr/{include/librsvg-2/librsvg,share/gtk-doc/html/rsvg}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="rsvg">
        <term><command>rsvg</command></term>
        <listitem>
          <para>is a legacy wrapper interface to rsvg-convert.</para>
          <indexterm zone="librsvg rsvg">
            <primary sortas="b-rsvg">rsvg</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rsvg-convert">
        <term><command>rsvg-convert</command></term>
        <listitem>
          <para>is used to covert SVG images into PNG, JPEG and
          ICO raster images.</para>
          <indexterm zone="librsvg rsvg-convert">
            <primary sortas="b-rsvg-convert">rsvg-convert</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rsvg-view">
        <term><command>rsvg-view</command></term>
        <listitem>
          <para>is used to view an SVG file in an <application>X</application>
          window.</para>
          <indexterm zone="librsvg rsvg-view">
            <primary sortas="b-rsvg-view">rsvg-view</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

      <varlistentry id="libsvg">
        <term><filename class='libraryfile'>libsvg.{so,a}</filename></term>
        <listitem>
          <para>is a <application>GTK</application> engines module.</para>
          <indexterm zone="librsvg libsvg">
            <primary sortas="c-librsvg">librsvg.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="svg_loader">
        <term><filename class='libraryfile'>svg_loader.{so,a}</filename></term>
        <listitem>
          <para>is a <application>GTK</application> loaders module.</para>
          <indexterm zone="librsvg svg_loader">
            <primary sortas="c-svg_loader">svg_loader.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>