source: gnome/applications/gucharmap.xml@ 92f5d53

<?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/12.0/gucharmap-&gucharmap-version;.tar.xz">
  <!ENTITY gucharmap-download-ftp
       "&gnome-download-ftp;/gucharmap/12.0/gucharmap-&gucharmap-version;.tar.xz">
  <!ENTITY gucharmap-md5sum        "0c34aa29657a41712d011d939c5bc85e">
  <!ENTITY gucharmap-size          "1.6 MB">
  <!ENTITY gucharmap-buildsize     "56 MB">
  <!ENTITY gucharmap-time          "0.4 SBU (with a fast internet connection)">
]>

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

  <sect1info>
    <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>

    &lfs101_checked;

    <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="desktop-file-utils"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="itstool"/>,
      <xref linkend="unzip"/>, and
      <xref linkend="wget"/> (used to download data from unicode.org)
    </para>

    <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">
<!--      <phrase revision="systemd"><xref linkend="appstream-glib"/> and </phrase> -->
      <ulink url="&appstream-glib-url;">appstream-glib</ulink> and
      <xref linkend="gtk-doc"/>
    </para>

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

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

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

<screen><userinput>LIBS="-ldl"               \
./configure --prefix=/usr \
            --enable-vala \
            --with-unicode-data=download &amp;&amp;
make</userinput></screen>

    <para>
      This package&apos;s testsuite is only intended to be used by the
      maintainer to check the i18n help files.
    </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>

<!-- Needed in Gucharmap 10.0.4: should be fixed in subsequent versions -->
    <para>
      <command>LIBS="-ldl" ...</command>: Allows linking some system libraries.
      This is currently broken in version 10.0.4.
    </para>

    <para>
      <parameter>--with-unicode-data=download</parameter>: This switch forces
      the build process to download the <application>Unicode</application> data
      instead of trying to look for it locally.
    </para>

    <para>
      <parameter>--enable-vala</parameter>: This switch enables building of the
      <application>Vala</application> bindings (auto-detection of
      <command>vapigen</command> is currently broken). Remove if you don't
      have <xref linkend="vala"/> installed.
    </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>
          charmap, gnome-character-map (both symlinks), and gucharmap
        </seg>
        <seg>
          libgucharmap_2_90.so
        </seg>
        <seg>
          /usr/include/gucharmap-2.90 and
          /usr/share/help/*/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_2_90">
        <term><filename class="libraryfile">libgucharmap_2_90.so</filename></term>
        <listitem>
          <para>
            contains the <application>Gucharmap</application> API functions
          </para>
          <indexterm zone="gucharmap libgucharmap_2_90">
            <primary sortas="c-libgucharmap_2_90">libgucharmap_2_90.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>