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