source: gnome/add/gucharmap.xml@ 30e6dde

<?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 gucharmap-download-http "&gnome-download-http;/gucharmap/&gnome-version;/gucharmap-&gucharmap-version;.tar.bz2">
  <!ENTITY gucharmap-download-ftp  "&gnome-download-ftp;/gucharmap/&gnome-version;/gucharmap-&gucharmap-version;.tar.bz2">
  <!ENTITY gucharmap-md5sum        "d4ff2195141ca71aebfeb766e18d9607">
  <!ENTITY gucharmap-size          "2.9 MB">
  <!ENTITY gucharmap-buildsize     "26 MB">
  <!ENTITY gucharmap-time          "0.2 SBU">
]>

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

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

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

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

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

    <para><application>gucharmap</application> is a Unicode character map and
    font viewer. It allows you to browse through all the available Unicode
    characters and categories for the installed fonts, and to examine their
    detailed properties. It is an easy way to find the character you might
    only know by its Unicode name or code point.</para>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="gtk2"/> and
    <xref linkend="perl-xml-parser"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="GConf"/>,
    <xref linkend="gir-repository"/>,
    <xref linkend="gnome-doc-utils"/>,
    <xref linkend="gtk-doc"/>,
    <xref linkend="pygtk"/>, and
    <xref linkend="rarian"/></para>

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

  </sect2>

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

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

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

<screen><userinput>./configure --prefix=$(pkg-config --variable=prefix ORBit-2.0) \
            --sysconfdir=&gnome-etc-dir; \
            --localstatedir=/var/lib &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>

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

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

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

    <para><option>--disable-gconf</option>: Use this parameter if you do not
    have <application>GConf</application> installed.</para>

    <para><option>--enable-python-bindings</option>: Use this parameter if you
    wish to enable python bindings.</para>

    <para><option>--enable-introspection</option>: Use this parameter if you
    wish to enable <application>GObject introspection</application>.</para>

    <para><option>--disable-scrollkeeper</option>: Use this parameter if you
    wish to disable the updates to the scrollkeeper database.</para>

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

  </sect2>

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

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

      <seglistitem>
        <seg>gucharmap</seg>
        <seg>libgucharmap.so</seg>
        <seg><envar>$GNOME_PREFIX</envar>/{include/gucharmap-2/gucharmap,
        share/{gnome/help/gucharmap/*,gtk-doc/html/gucharmap,
        omf/gucharmap}}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gucharmap-prog">
        <term><command>gucharmap</command></term>
        <listitem>
          <para>is a Unicode character map and font viewer.</para>
          <indexterm zone="gucharmap gucharmap-prog">
            <primary sortas="b-gucharmap">gucharmap</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgucharmap">
        <term><filename class='libraryfile'>libgucharmap.so</filename></term>
        <listitem>
          <para>contains the <application>gucharmap</application> API
          functions.</para>
          <indexterm zone="gucharmap libgucharmap">
            <primary sortas="c-libgucharmap">libgucharmap.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>