[09140ef] | 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 " ">
|
---|
[98c91f4c] | 9 | <!ENTITY highlight-md5sum "05f75d4fb18a401181e658dcaf8ff562">
|
---|
| 10 | <!ENTITY highlight-size "608 KB">
|
---|
| 11 | <!ENTITY highlight-buildsize "17 MB (without GUI or API docs)">
|
---|
| 12 | <!ENTITY highlight-time "0.7 SBU (without GUI or API docs)">
|
---|
[09140ef] | 13 | ]>
|
---|
| 14 |
|
---|
[87e832a5] | 15 | <sect1 id="highlight" xreflabel="Highlight-&highlight-version;">
|
---|
[09140ef] | 16 | <?dbhtml filename="highlight.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
[87e832a5] | 23 | <title>Highlight-&highlight-version;</title>
|
---|
[09140ef] | 24 |
|
---|
| 25 | <indexterm zone="highlight">
|
---|
[87e832a5] | 26 | <primary sortas="a-Highlight">Highlight</primary>
|
---|
[09140ef] | 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
[87e832a5] | 30 | <title>Introduction to Highlight</title>
|
---|
[09140ef] | 31 |
|
---|
| 32 | <para>
|
---|
[87e832a5] | 33 | <application>Highlight</application> is an utility that converts
|
---|
| 34 | source code to formatted text with syntax highlighting.
|
---|
[09140ef] | 35 | </para>
|
---|
| 36 |
|
---|
[98c91f4c] | 37 | &lfs79_checked;
|
---|
| 38 | <!-- Queued update. Haven't tested with GCC6 yet. Will be done soon. -->
|
---|
[09140ef] | 39 |
|
---|
| 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>
|
---|
| 44 | Download (HTTP): <ulink url="&highlight-download-http;"/>
|
---|
| 45 | </para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>
|
---|
| 49 | Download (FTP): <ulink url="&highlight-download-ftp;"/>
|
---|
| 50 | </para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>
|
---|
| 54 | Download MD5 sum: &highlight-md5sum;
|
---|
| 55 | </para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>
|
---|
| 59 | Download size: &highlight-size;
|
---|
| 60 | </para>
|
---|
| 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>
|
---|
| 64 | Estimated disk space required: &highlight-buildsize;
|
---|
| 65 | </para>
|
---|
| 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
| 68 | <para>
|
---|
| 69 | Estimated build time: &highlight-time;
|
---|
| 70 | </para>
|
---|
| 71 | </listitem>
|
---|
| 72 | </itemizedlist>
|
---|
| 73 |
|
---|
[87e832a5] | 74 | <bridgehead renderas="sect3">Highlight Dependencies</bridgehead>
|
---|
[09140ef] | 75 |
|
---|
| 76 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 77 | <para role="required">
|
---|
[87e832a5] | 78 | <xref linkend="boost"/> and
|
---|
| 79 | <xref linkend="lua"/>
|
---|
[09140ef] | 80 | </para>
|
---|
| 81 |
|
---|
| 82 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 83 | <para role="optional">
|
---|
[ac38e9dc] | 84 | <xref linkend="doxygen"/> (to build the API documentation) and
|
---|
| 85 | <xref linkend="qt4"/> (to build the GUI front-en)
|
---|
[09140ef] | 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">
|
---|
[87e832a5] | 94 | <title>Installation of Highlight</title>
|
---|
[8ed8f6e] | 95 |
|
---|
[09140ef] | 96 | <para>
|
---|
[87e832a5] | 97 | To build <application>Highlight</application> run the following
|
---|
[09140ef] | 98 | command:
|
---|
| 99 | </para>
|
---|
| 100 |
|
---|
[8ed8f6e] | 101 | <screen><userinput>make</userinput></screen>
|
---|
[09140ef] | 102 |
|
---|
| 103 | <para>
|
---|
[ac38e9dc] | 104 | To build the <application>Qt4</application> GUI front-end, run the
|
---|
| 105 | following command:
|
---|
[09140ef] | 106 | </para>
|
---|
| 107 |
|
---|
[87e832a5] | 108 | <screen><userinput>make gui</userinput></screen>
|
---|
| 109 |
|
---|
[09140ef] | 110 | <para>
|
---|
[87e832a5] | 111 | To build the API documentation, run the following command:
|
---|
[09140ef] | 112 | </para>
|
---|
| 113 |
|
---|
[87e832a5] | 114 | <screen><userinput>make apidocs</userinput></screen>
|
---|
[09140ef] | 115 |
|
---|
| 116 | <para>
|
---|
[87e832a5] | 117 | This package does not come with a test suite.
|
---|
[8ed8f6e] | 118 | </para>
|
---|
| 119 |
|
---|
| 120 | <para>
|
---|
[87e832a5] | 121 | To install <application>Highlight</application>, run the
|
---|
| 122 | following command as the
|
---|
| 123 | <systemitem class="username">root</systemitem> user:
|
---|
[09140ef] | 124 | </para>
|
---|
| 125 |
|
---|
[87e832a5] | 126 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[09140ef] | 127 |
|
---|
| 128 | <para>
|
---|
[87e832a5] | 129 | To install the GUI program, run the following command as the
|
---|
| 130 | <systemitem class="username">root</systemitem> user:
|
---|
[09140ef] | 131 | </para>
|
---|
| 132 |
|
---|
[87e832a5] | 133 | <screen role="root"><userinput>make install-gui</userinput></screen>
|
---|
[09140ef] | 134 |
|
---|
| 135 | <para>
|
---|
[87e832a5] | 136 | To install the API documentation, run the following command
|
---|
| 137 | as the <systemitem class="username">root</systemitem> user:
|
---|
[09140ef] | 138 | </para>
|
---|
| 139 |
|
---|
[87e832a5] | 140 | <screen role="root"><userinput>cp -rv apidocs/html /usr/share/doc/highlight/apidocs</userinput></screen>
|
---|
[09140ef] | 141 |
|
---|
| 142 | </sect2>
|
---|
| 143 |
|
---|
| 144 | <sect2 role="content">
|
---|
| 145 | <title>Contents</title>
|
---|
| 146 |
|
---|
| 147 | <segmentedlist>
|
---|
| 148 | <segtitle>Installed Programs</segtitle>
|
---|
[87e832a5] | 149 | <segtitle>Installed Libraries</segtitle>
|
---|
[09140ef] | 150 | <segtitle>Installed Directories</segtitle>
|
---|
| 151 |
|
---|
| 152 | <seglistitem>
|
---|
| 153 | <seg>
|
---|
[87e832a5] | 154 | highlight and highlight-gui
|
---|
[09140ef] | 155 | </seg>
|
---|
| 156 | <seg>
|
---|
[8ed8f6e] | 157 | None
|
---|
[09140ef] | 158 | </seg>
|
---|
| 159 | <seg>
|
---|
[8ed8f6e] | 160 | /etc/highlight
|
---|
| 161 | /usr/share/doc/highlight, and
|
---|
[09140ef] | 162 | /usr/share/highlight
|
---|
| 163 | </seg>
|
---|
| 164 | </seglistitem>
|
---|
| 165 | </segmentedlist>
|
---|
| 166 |
|
---|
| 167 | <variablelist>
|
---|
| 168 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 169 | <?dbfo list-presentation="list"?>
|
---|
| 170 | <?dbhtml list-presentation="table"?>
|
---|
| 171 |
|
---|
[8ed8f6e] | 172 | <varlistentry id="highlight-prog">
|
---|
| 173 | <term><command>highlight</command></term>
|
---|
[09140ef] | 174 | <listitem>
|
---|
| 175 | <para>
|
---|
[87e832a5] | 176 | is a universal source code to formatted text converter.
|
---|
[09140ef] | 177 | </para>
|
---|
[8ed8f6e] | 178 | <indexterm zone="highlight highlight-prog">
|
---|
[87e832a5] | 179 | <primary sortas="b-highlight">highlight</primary>
|
---|
[09140ef] | 180 | </indexterm>
|
---|
| 181 | </listitem>
|
---|
| 182 | </varlistentry>
|
---|
| 183 |
|
---|
[8ed8f6e] | 184 | <varlistentry id="highlight-gui">
|
---|
| 185 | <term><command>highlight-gui</command></term>
|
---|
[09140ef] | 186 | <listitem>
|
---|
| 187 | <para>
|
---|
[87e832a5] | 188 | is the <application>Qt4</application> interface to
|
---|
[8ed8f6e] | 189 | <command>highlight</command>.
|
---|
[09140ef] | 190 | </para>
|
---|
[8ed8f6e] | 191 | <indexterm zone="highlight highlight-gui">
|
---|
| 192 | <primary sortas="b-highlight-gui">highlight-gui</primary>
|
---|
[09140ef] | 193 | </indexterm>
|
---|
| 194 | </listitem>
|
---|
| 195 | </varlistentry>
|
---|
| 196 |
|
---|
| 197 | </variablelist>
|
---|
| 198 |
|
---|
| 199 | </sect2>
|
---|
| 200 |
|
---|
| 201 | </sect1>
|
---|