source: gnome/applications/gucharmap.xml@ 4bd5e598

<?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;

  <!-- found by looking at souce of https://gitlab.gnome.org/GNOME/gucharmap/-/tags
   in seamonkey, finding the .tar.bz2 and putting the gitlab.gnome.org prefix
   onto it -->
  <!ENTITY gucharmap-download-http "https://gitlab.gnome.org/GNOME/gucharmap/-/archive/&gucharmap-version;/gucharmap-&gucharmap-version;.tar.bz2">
  <!ENTITY gucharmap-download-ftp  " ">
  <!ENTITY gucharmap-md5sum        "3c4b1937241aa6a70931ecfa24ab2021">
  <!ENTITY gucharmap-size          "1.4 MB">
  <!ENTITY gucharmap-buildsize     "80 MB">
  <!ENTITY gucharmap-time          "0.1 SBU">
]>

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


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

    &lfs113_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">Additional Downloads</bridgehead>

    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Unicode Character Database:
          <ulink url="https://www.unicode.org/Public/zipped/&gucharmap-major-version;.0/UCD.zip"> https://www.unicode.org/Public/zipped/&gucharmap-major-version;.0/UCD.zip</ulink>
        </para>
      </listitem>
      <listitem>
        <para>
          CJK Unified Ideographs:
          <ulink url="https://www.unicode.org/Public/zipped/&gucharmap-major-version;.0/Unihan.zip"> https://www.unicode.org/Public/zipped/&gucharmap-major-version;.0/Unihan.zip</ulink>
        </para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="desktop-file-utils"/>,
      <xref linkend="gsettings-desktop-schemas"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="itstool"/>,
      <xref linkend="pcre2"/>, and
      <xref linkend="unzip"/>
    </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">
      <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>

    <note>
      <para>
        This package uses two unversioned downloads. You may want to rename
        these to a versioned name, e.g. <filename>UCD-15.zip</filename> to
        make upgrades easier.
      </para>
    </note>

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

<screen><userinput>mkdir build                   &amp;&amp;
cd    build                   &amp;&amp;
mkdir ucd                     &amp;&amp;
pushd ucd                     &amp;&amp;
  unzip ../../../UCD.zip      &amp;&amp;
  cp -v ../../../Unihan.zip . &amp;&amp;
popd                          &amp;&amp;

meson --prefix=/usr         \
      --strip               \
      --buildtype=release   \
      -Ducd_path=./ucd      \
      -Ddocs=false ..       &amp;&amp;
ninja</userinput></screen>

    <para>
      This package does not have a test suite.
    </para>

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

<screen role="root"><userinput>rm  -fv /usr/share/glib-2.0/schemas/org.gnome.Charmap.enums.xml &amp;&amp;
ninja install</userinput></screen>

  </sect2>

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

    <para>
      <parameter>--strip</parameter>: Although the package defaults to a release
      build without debug information, without this switch there will be some
      debug information in the binaries.
    </para>

    <para>
      <parameter>-Ducd_path=./ucd</parameter>: This points to where the extracted
      main Unicode data files, and the zipped Unihan archive can be found.
    </para>

    <para>
      <command>rm  -fv /usr/share/glib-2.0/schemas/org.gnome.Charmap.enums.xml</command>:
      Old versions of this package installed an obsolete file that prevents the
      program from running, as if the main schema has not been installed.
      Forcibly removing works even if the old file is not present.
    </para>

    <para>
      <parameter>-Ddocs=false</parameter>: This allows the package to build even
      if <application>gtk-doc</application> has not been installed. Remove this
      if you have installed that and wish to build the documentation.
    </para>

    <para>
      <option>-Dgir=false</option>: Use this if you have not installed
      <xref linkend="gobject-introspection"/>.
    </para>

    <para>
      <option>-Dvapi=false</option>: Use this if you have not installed
      <xref linkend="vala"/>.
    </para>

  </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_2_90.so
        </seg>
        <seg>
          /usr/include/gucharmap-2.90
        </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>