[0d21fc34] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY highlight-download-http "http://www.andre-simon.de/zip/highlight-&highlight-version;.tar.bz2">
|
---|
| 8 | <!ENTITY highlight-download-ftp " ">
|
---|
| 9 | <!ENTITY highlight-md5sum "085d7639a7e05a0d41923a889dc801c9">
|
---|
| 10 | <!ENTITY highlight-size "608 KB">
|
---|
| 11 | <!ENTITY highlight-buildsize "40 MB">
|
---|
| 12 | <!ENTITY highlight-time "0.5 SBU">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="highlight" xreflabel="highlight-&highlight-version;">
|
---|
| 16 | <?dbhtml filename="highlight.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>highlight-&highlight-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="highlight">
|
---|
| 26 | <primary sortas="a-highlight">highlight</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to highlight</title>
|
---|
| 31 |
|
---|
| 32 | <para>
|
---|
| 33 | <application>highlight</application> converts source code to formatted text with syntax highlighting.
|
---|
| 34 | </para>
|
---|
| 35 |
|
---|
| 36 | &lfs75_checked;
|
---|
| 37 |
|
---|
| 38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 39 | <itemizedlist spacing="compact">
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>
|
---|
| 42 | Download (HTTP): <ulink url="&highlight-download-http;"/>
|
---|
| 43 | </para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>
|
---|
| 47 | Download (FTP): <ulink url="&highlight-download-ftp;"/>
|
---|
| 48 | </para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>
|
---|
| 52 | Download MD5 sum: &highlight-md5sum;
|
---|
| 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
| 57 | Download size: &highlight-size;
|
---|
| 58 | </para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>
|
---|
| 62 | Estimated disk space required: &highlight-buildsize;
|
---|
| 63 | </para>
|
---|
| 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
| 66 | <para>
|
---|
| 67 | Estimated build time: &highlight-time;
|
---|
| 68 | </para>
|
---|
| 69 | </listitem>
|
---|
| 70 | </itemizedlist>
|
---|
| 71 |
|
---|
| 72 | <bridgehead renderas="sect3">highlight Dependencies</bridgehead>
|
---|
| 73 |
|
---|
[b82117b8] | 74 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 75 | <para role="required">
|
---|
| 76 | <xref linkend="lua"/>, and
|
---|
| 77 | <xref linkend="boost"/>
|
---|
| 78 | </para>
|
---|
| 79 |
|
---|
| 80 |
|
---|
[0d21fc34] | 81 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 82 | <para role="optional">
|
---|
[b82117b8] | 83 | <xref linkend="doxygen"/>, (to build documentation)
|
---|
| 84 | <xref linkend="qt4"/> (to build gui), or
|
---|
| 85 | <xref linkend="qt5"/>
|
---|
[0d21fc34] | 86 | </para>
|
---|
| 87 |
|
---|
| 88 | <para condition="html" role="usernotes">
|
---|
| 89 | User Notes: <ulink url="&blfs-wiki;/highlight"/>
|
---|
| 90 | </para>
|
---|
| 91 | </sect2>
|
---|
| 92 |
|
---|
| 93 | <sect2 role="installation">
|
---|
| 94 | <title>Installation of highlight</title>
|
---|
| 95 |
|
---|
| 96 | <para>
|
---|
| 97 | Install <application>highlight</application> by running the following
|
---|
[b82117b8] | 98 | command:
|
---|
[0d21fc34] | 99 | </para>
|
---|
| 100 |
|
---|
[b82117b8] | 101 | <screen><userinput>
|
---|
| 102 |
|
---|
| 103 | make
|
---|
| 104 | </userinput></screen>
|
---|
[0d21fc34] | 105 |
|
---|
| 106 | <para>
|
---|
[b82117b8] | 107 | This application does not have a test suite.
|
---|
[0d21fc34] | 108 | </para>
|
---|
| 109 |
|
---|
| 110 | <para>
|
---|
| 111 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 112 | </para>
|
---|
| 113 |
|
---|
| 114 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[b82117b8] | 115 |
|
---|
| 116 | <para>
|
---|
| 117 | If you have QT4 or QT5 installed and want to install the gui as the
|
---|
| 118 | <systemitem class="username">root</systemitem> user issue the following
|
---|
| 119 | command:
|
---|
| 120 | </para>
|
---|
| 121 |
|
---|
| 122 | <screen role="root"><userinput>make install-gui</userinput></screen>
|
---|
| 123 |
|
---|
[0d21fc34] | 124 | </sect2>
|
---|
| 125 |
|
---|
| 126 | <sect2 role="commands">
|
---|
| 127 | <title>Command Explanations</title>
|
---|
| 128 |
|
---|
| 129 | <para>
|
---|
[b82117b8] | 130 | <option>make lib-static</option>: This option will
|
---|
| 131 | compile only the static library.
|
---|
| 132 | </para>
|
---|
| 133 |
|
---|
| 134 | <para>
|
---|
| 135 | <option>make lib-shared</option>: This option will
|
---|
| 136 | compile only the shared library.
|
---|
[0d21fc34] | 137 | </para>
|
---|
| 138 |
|
---|
[b82117b8] | 139 | <para>
|
---|
| 140 | <option>make gui</option>: This option will
|
---|
| 141 | compile static library and the Qt 4.x or Qt 5.x
|
---|
| 142 | GUI
|
---|
| 143 | </para>
|
---|
| 144 |
|
---|
| 145 | <para>
|
---|
| 146 | <option>make apidocs</option>: This option will
|
---|
| 147 | build the documentation if <application>doxygen</application>
|
---|
| 148 | is installed.
|
---|
| 149 | </para>
|
---|
[0d21fc34] | 150 |
|
---|
| 151 | </sect2>
|
---|
| 152 |
|
---|
| 153 | <sect2 role="content">
|
---|
| 154 | <title>Contents</title>
|
---|
| 155 |
|
---|
| 156 | <segmentedlist>
|
---|
| 157 | <segtitle>Installed Programs</segtitle>
|
---|
| 158 | <segtitle>Installed Library</segtitle>
|
---|
| 159 | <segtitle>Installed Directories</segtitle>
|
---|
| 160 |
|
---|
| 161 | <seglistitem>
|
---|
| 162 | <seg>
|
---|
| 163 | highlight, highlight-daemon, and highlight-setup
|
---|
| 164 | </seg>
|
---|
| 165 | <seg>
|
---|
| 166 | libhighlight-1.0.so and im-highlight.so
|
---|
| 167 | (<application>GTK+ Immodule</application>)
|
---|
| 168 | </seg>
|
---|
| 169 | <seg>
|
---|
| 170 | /etc/dconf/db/highlight.d,
|
---|
| 171 | /usr/include/highlight-1.0,
|
---|
| 172 | /usr/lib/highlight,
|
---|
| 173 | /usr/share/gtk-doc/html/highlight, and
|
---|
| 174 | /usr/share/highlight
|
---|
| 175 | </seg>
|
---|
| 176 | </seglistitem>
|
---|
| 177 | </segmentedlist>
|
---|
| 178 |
|
---|
| 179 | <variablelist>
|
---|
| 180 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 181 | <?dbfo list-presentation="list"?>
|
---|
| 182 | <?dbhtml list-presentation="table"?>
|
---|
| 183 |
|
---|
| 184 | <varlistentry id="highlight-daemon">
|
---|
| 185 | <term><command>highlight-daemon</command></term>
|
---|
| 186 | <listitem>
|
---|
| 187 | <para>
|
---|
| 188 | is the Intelligent Input Bus Daemon.
|
---|
| 189 | </para>
|
---|
| 190 | <indexterm zone="highlight highlight-daemon">
|
---|
| 191 | <primary sortas="b-highlight-daemon">highlight-daemon</primary>
|
---|
| 192 | </indexterm>
|
---|
| 193 | </listitem>
|
---|
| 194 | </varlistentry>
|
---|
| 195 |
|
---|
| 196 | <varlistentry id="highlight-setup">
|
---|
| 197 | <term><command>highlight-setup</command></term>
|
---|
| 198 | <listitem>
|
---|
| 199 | <para>
|
---|
| 200 | is the <application>GTK+</application> program used to configure
|
---|
| 201 | the <command>highlight-daemon</command>.
|
---|
| 202 | </para>
|
---|
| 203 | <indexterm zone="highlight highlight-setup">
|
---|
| 204 | <primary sortas="b-highlight-setup">highlight-setup</primary>
|
---|
| 205 | </indexterm>
|
---|
| 206 | </listitem>
|
---|
| 207 | </varlistentry>
|
---|
| 208 |
|
---|
| 209 | <varlistentry id="libhighlight-1.0">
|
---|
| 210 | <term><filename class="libraryfile">libhighlight-1.0.so</filename></term>
|
---|
| 211 | <listitem>
|
---|
| 212 | <para>
|
---|
| 213 | contains <application>highlight</application> API functions.
|
---|
| 214 | </para>
|
---|
| 215 | <indexterm zone="highlight libhighlight-1.0">
|
---|
| 216 | <primary sortas="c-libhighlight-1.0">libhighlight-1.0.so</primary>
|
---|
| 217 | </indexterm>
|
---|
| 218 | </listitem>
|
---|
| 219 | </varlistentry>
|
---|
| 220 |
|
---|
| 221 | </variablelist>
|
---|
| 222 |
|
---|
| 223 | </sect2>
|
---|
| 224 |
|
---|
| 225 | </sect1>
|
---|