source: general/genutils/highlight.xml@ 104ff4e

<?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 highlight-download-http "http://www.andre-simon.de/zip/highlight-&highlight-version;.tar.bz2">
  <!ENTITY highlight-download-ftp  " ">
  <!ENTITY highlight-md5sum        "e61056f9cfe5f865ea7f87c74f05d22f">
  <!ENTITY highlight-size          "1.4 MB">
  <!ENTITY highlight-buildsize     "31 MB (with gui)">
  <!ENTITY highlight-time          "0.3 SBU (Using paralllelism=4; with gui)">
]>

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


  <title>Highlight-&highlight-version;</title>

  <indexterm zone="highlight">
    <primary sortas="a-Highlight">Highlight</primary>
  </indexterm>

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

    <para>
      <application>Highlight</application> is an utility that converts
      source code to formatted text with syntax highlighting.
    </para>

    &lfs112_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="boost"/> and
      <xref linkend="lua"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <!-- make apidocs fails because there is no Doxyfile
      <xref linkend="doxygen"/> (to build the API documentation) and -->
      <xref linkend="qt5"/> (to build the GUI front-end)
    </para>

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

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

    <para>
      For consistency, do not compress man pages.
    </para>

<screen><userinput>sed -i '/GZIP/s/^/#/' makefile</userinput></screen>

    <para>
      To build <application>Highlight</application> run the following
      command:
    </para>

<screen><userinput>make</userinput></screen>

    <para>
      To build the <application>Qt5</application> GUI front-end, run the
      following command:
    </para>

<screen><userinput>make doc_dir=/usr/share/doc/highlight-&highlight-version;/ gui</userinput></screen>
<!--
    <para>
      To build the API documentation, run the following command:
    </para>

<screen><userinput>make apidocs</userinput></screen>
-->
    <para>
      This package does not come with a test suite.
    </para>

    <para>
      To install <application>Highlight</application>, run the
      following command as the
      <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make doc_dir=/usr/share/doc/highlight-&highlight-version;/ install</userinput></screen>

    <para>
      To install the GUI program, run the following command as the
      <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install-gui</userinput></screen>
<!--
    <para>
      To install the API documentation, run the following command
      as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>cp -rv apidocs/html /usr/share/doc/highlight/apidocs</userinput></screen>
-->
  </sect2>

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

    <para>
      <parameter>doc_dir=/usr/share/doc/highlight-&highlight-version;/</parameter>:
      installs the highlight documentation into a versioned directory. This
      parameter is also needed for <command>make gui</command>, because
      its value would be hardcoded into the gui executable.  Note that the
      trailing <quote>/</quote> is necessary.
    </para>
  </sect2>

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

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

      <seglistitem>
        <seg>
          highlight and highlight-gui (optional)
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /etc/highlight,
          /usr/share/doc/highlight-&highlight-version;, and
          /usr/share/highlight
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="highlight-prog">
        <term><command>highlight</command></term>
        <listitem>
          <para>
            is a universal source code to formatted text converter
          </para>
          <indexterm zone="highlight highlight-prog">
            <primary sortas="b-highlight">highlight</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="highlight-gui">
        <term><command>highlight-gui</command></term>
        <listitem>
          <para>
            is the <application>Qt5</application> interface to
            <command>highlight</command>.
          </para>
          <indexterm zone="highlight highlight-gui">
            <primary sortas="b-highlight-gui">highlight-gui</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>