source: gnome-systemd/applications/highlight.xml@ 09140ef

<?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     "40 MB">
  <!ENTITY highlight-time          "0.5 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>
      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>
      If you have QT4 or QT5 installed and want 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, highlight-daemon, and highlight-setup
        </seg>
        <seg>
          libhighlight-1.0.so and im-highlight.so
          (<application>GTK+ Immodule</application>)
        </seg>
        <seg>
          /etc/dconf/db/highlight.d,
          /usr/include/highlight-1.0,
          /usr/lib/highlight,
          /usr/share/gtk-doc/html/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-daemon">
        <term><command>highlight-daemon</command></term>
        <listitem>
          <para>
            is the Intelligent Input Bus Daemon.
          </para>
          <indexterm zone="highlight highlight-daemon">
            <primary sortas="b-highlight-daemon">highlight-daemon</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="highlight-setup">
        <term><command>highlight-setup</command></term>
        <listitem>
          <para>
            is the <application>GTK+</application> program used to configure
            the <command>highlight-daemon</command>.
          </para>
          <indexterm zone="highlight highlight-setup">
            <primary sortas="b-highlight-setup">highlight-setup</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libhighlight-1.0">
        <term><filename class="libraryfile">libhighlight-1.0.so</filename></term>
        <listitem>
          <para>
            contains <application>highlight</application> API functions.
          </para>
          <indexterm zone="highlight libhighlight-1.0">
            <primary sortas="c-libhighlight-1.0">libhighlight-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>