source: xsoft/other/fontforge.xml@ b3867c5

<?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 fontforge-download-http "https://github.com/fontforge/fontforge/releases/download/&fontforge-version;/fontforge-dist-&fontforge-version;.tar.xz">
-->
 <!ENTITY fontforge-download-http "https://github.com/fontforge/fontforge/releases/download/&fontforge-version;/fontforge-&fontforge-version;.tar.xz">

  <!ENTITY fontforge-download-ftp  " ">
  <!ENTITY fontforge-md5sum        "7043f25368ed25bcd75d168564919fb7">
  <!ENTITY fontforge-size          "13 MB">
  <!ENTITY fontforge-buildsize     "102 MB (add 52 MB for the tests)">
  <!ENTITY fontforge-time          "0.4 SBU (with parallelism=4, add 0.1 SBU for the tests)">
]>

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


  <title>FontForge-&fontforge-version;</title>

  <indexterm zone="fontforge">
    <primary sortas="a-FontForge">FontForge</primary>
  </indexterm>

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

    <para>
      The <application>FontForge</application> package contains an
      outline font editor that lets you create your own postscript,
      truetype, opentype, cid-keyed, multi-master, cff, svg and
      bitmap (bdf, FON, NFNT) fonts, or edit existing ones.
    </para>

    &lfs113_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libspiro"/> and
      <xref linkend="libxml2"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
    <!-- not mentioned:
      glib is required for gtk3
      pango is required for gtk3
      cairo is recommended for pango
      xorg libs pulled in by gtk3 via libepoxy.
      -->
      <xref linkend="gtk3"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
    <!-- the following references in the source appear not to be used:
      curl is mentioned in appveyor.yml for msys2 (integration tests, I think)
      wget is referenced in Unicode/charset/generate.sh which will fail if
      wget is not on the PATH, and in Unicode/dump.c - with wget moved off the
      PATH, no problems, i.e. they are never run and never built.

      Some of the others are at a minimum pulled in for recommended deps -
       libpng from freetype from fontconfig from xorg libs.
       harfbuzz is the same

      Also, adding or removing optional deps other than Sphinx doesn't seem
      to materially alter the build time or size.
      -->
      <xref linkend="giflib"/>,
      <xref linkend="git"/>,
      <xref linkend="libjpeg"/>,
      <xref linkend="libtiff"/>,
      <xref linkend="sphinx"/> (to build html documentation),
      <xref linkend="woff2"/>, and
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of FontForge</title>
    <para>
      Install <application>FontForge</application> by running the following
      commands:
    </para>

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -Wno-dev .. &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>

    <para>
      If you have installed <command>sphinx-build</command>, HTML documentation
      was built and installed in
      <filename class="directory">/usr/share/doc/fontforge</filename>.
      To be able to access it as a versioned directory, create a
      symlink as the
      <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"
        remap="doc"><userinput>ln -sv fontforge /usr/share/doc/fontforge-&fontforge-version;</userinput></screen>

  </sect2>

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

    <para>
      <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used to
      create an optimized release without debug information.
    </para>

    <para>
      <parameter>-Wno-dev</parameter>: This switch is used to suppress warnings
      intended for the package's developers.
    </para>

    <para>
      <option>-DENABLE_X11=ON</option>: use an X11 backend instead of GDK3
      (gtk+-3) for basic Xorg graphics.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          fontforge, fontimage, fontlint and sfddiff
        </seg>
        <seg>
          libfontforge.so and
          /usr/lib/python&python3-version;/site-packages/{fontforge,psMat}.so
        </seg>
        <seg>
          /usr/share/fontforge and optionally
          /usr/share/doc/fontforge{,-&fontforge-version;}
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="fontforge-prog">
        <term><command>fontforge</command></term>
        <listitem>
          <para>
            is a program that allows you to create and
            modify font files
          </para>
          <indexterm zone="fontforge fontforge-prog">
            <primary sortas="b-fontforge">fontforge</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="fontimage">
        <term><command>fontimage</command></term>
        <listitem>
          <para>
            is a program that produces an image showing
            representative glyphs of the font
          </para>
          <indexterm zone="fontforge fontimage">
            <primary sortas="b-fontimage">fontimage</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="fontlint">
        <term><command>fontlint</command></term>
        <listitem>
          <para>
            is a program that checks the font for certain
            common errors
          </para>
          <indexterm zone="fontforge fontlint">
            <primary sortas="b-fontlint">fontlint</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sfddiff">
        <term><command>sfddiff</command></term>
        <listitem>
          <para>
            is a program that compares two font files
          </para>
          <indexterm zone="fontforge sfddiff">
            <primary sortas="b-sfddiff">sfddiff</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>