source: gnome-systemd/applications/highlight.xml@ 7af97ed5

<?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        "085d7639a7e05a0d41923a889dc801c9">
  <!ENTITY highlight-size          "608 KB">
  <!ENTITY highlight-buildsize     "25 MB">
  <!ENTITY highlight-time          "0.8 SBU">
]>

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

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

  <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> converts source code to formatted text with syntax highlighting.
    </para>

    &lfs75_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="lua"/>, and
      <xref linkend="boost"/>
    </para>


    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/>, (to build documentation)
      <xref linkend="qt4"/> (to build gui), or
      <xref linkend="qt5"/>
    </para>

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

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

    <para>First fix an incorrect file name in the makefile
     that causes qmake to not to be found:
    </para>

<screen><userinput>sed -i "s:qmake-qt4:qmake:g" -i makefile src/makefile</userinput></screen>

    <para>
      Install <application>highlight</application> by running the following
      command:
    </para>

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

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

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

<screen role="root"><userinput>make install</userinput></screen>

    <para>
      In order to build both <application>Qt4</application> 
      and <application>Qt5</application>Gui's, you need to 
      run the install commands twice, because although
      both are detected, only wrapper for the first
      <application>Qt</application> version in PATH is built. Either can be
      built first, but to facilitate the explanation, we choose first the
      <application>Qt4</application> library. You can do this using
      <command>source setqt4</command> (script from <xref linkend="qt4"/>).
    </para>

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

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

<screen role="root"><userinput>make install-gui</userinput></screen>

  </sect2>

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

    <para>
      <option>make lib-static</option>: This option will 
      compile only the static library.
    </para>

    <para>
      <option>make lib-shared</option>: This option will 
      compile only the shared library.    
    </para>

    <para>
      <option>make gui</option>: This option will
      compile static library and the Qt 4.x or Qt 5.x
      GUI
    </para>

    <para>
      <option>make apidocs</option>: This option will
      build the documentation if <application>doxygen</application>
      is installed.
    </para>    

  </sect2>

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

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

      <seglistitem>
        <seg>
          highlight, and highlight-gui
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /etc/highlight
          /usr/share/doc/highlight, 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 the highlight program.
          </para>
          <indexterm zone="highlight highlight-prog">
            <primary sortas="b-highlight-prog">highlight</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="highlight-gui">
        <term><command>highlight-gui</command></term>
        <listitem>
          <para>
            is the <application>Quick Time</application> program used to configure
            <command>highlight</command>.
          </para>
          <indexterm zone="highlight highlight-gui">
            <primary sortas="b-highlight-gui">highlight-gui</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>