[bb535118] | 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 " ">
|
---|
[3947fa9] | 9 | <!ENTITY highlight-md5sum "e61056f9cfe5f865ea7f87c74f05d22f">
|
---|
[b3148f55] | 10 | <!ENTITY highlight-size "1.4 MB">
|
---|
[766c8d79] | 11 | <!ENTITY highlight-buildsize "31 MB (with gui)">
|
---|
[3947fa9] | 12 | <!ENTITY highlight-time "0.3 SBU (Using paralllelism=4; with gui)">
|
---|
[bb535118] | 13 | ]>
|
---|
| 14 |
|
---|
[da0d3ddb] | 15 | <sect1 id="highlight" xreflabel="Highlight-&highlight-version;">
|
---|
[bb535118] | 16 | <?dbhtml filename="highlight.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>Highlight-&highlight-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="highlight">
|
---|
| 22 | <primary sortas="a-Highlight">Highlight</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to Highlight</title>
|
---|
| 27 |
|
---|
| 28 | <para>
|
---|
| 29 | <application>Highlight</application> is an utility that converts
|
---|
| 30 | source code to formatted text with syntax highlighting.
|
---|
| 31 | </para>
|
---|
| 32 |
|
---|
[15445ab] | 33 | &lfs113_checked;
|
---|
[bb535118] | 34 |
|
---|
| 35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 36 | <itemizedlist spacing="compact">
|
---|
| 37 | <listitem>
|
---|
| 38 | <para>
|
---|
| 39 | Download (HTTP): <ulink url="&highlight-download-http;"/>
|
---|
| 40 | </para>
|
---|
| 41 | </listitem>
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>
|
---|
| 44 | Download (FTP): <ulink url="&highlight-download-ftp;"/>
|
---|
| 45 | </para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>
|
---|
| 49 | Download MD5 sum: &highlight-md5sum;
|
---|
| 50 | </para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>
|
---|
| 54 | Download size: &highlight-size;
|
---|
| 55 | </para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>
|
---|
| 59 | Estimated disk space required: &highlight-buildsize;
|
---|
| 60 | </para>
|
---|
| 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>
|
---|
| 64 | Estimated build time: &highlight-time;
|
---|
| 65 | </para>
|
---|
| 66 | </listitem>
|
---|
| 67 | </itemizedlist>
|
---|
| 68 |
|
---|
| 69 | <bridgehead renderas="sect3">Highlight Dependencies</bridgehead>
|
---|
| 70 |
|
---|
| 71 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 72 | <para role="required">
|
---|
| 73 | <xref linkend="boost"/> and
|
---|
| 74 | <xref linkend="lua"/>
|
---|
| 75 | </para>
|
---|
| 76 |
|
---|
| 77 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 78 | <para role="optional">
|
---|
[0639bb6] | 79 | <!-- make apidocs fails because there is no Doxyfile
|
---|
[7d35a9d2] | 80 | <xref linkend="doxygen"/> (to build the API documentation) and -->
|
---|
| 81 | <xref linkend="qt5"/> (to build the GUI front-end)
|
---|
[bb535118] | 82 | </para>
|
---|
| 83 |
|
---|
| 84 | <para condition="html" role="usernotes">
|
---|
| 85 | User Notes: <ulink url="&blfs-wiki;/highlight"/>
|
---|
| 86 | </para>
|
---|
| 87 | </sect2>
|
---|
| 88 |
|
---|
| 89 | <sect2 role="installation">
|
---|
| 90 | <title>Installation of Highlight</title>
|
---|
| 91 |
|
---|
[ba31c2b] | 92 | <para>
|
---|
| 93 | For consistency, do not compress man pages.
|
---|
| 94 | </para>
|
---|
| 95 |
|
---|
| 96 | <screen><userinput>sed -i '/GZIP/s/^/#/' makefile</userinput></screen>
|
---|
| 97 |
|
---|
[bb535118] | 98 | <para>
|
---|
| 99 | To build <application>Highlight</application> run the following
|
---|
| 100 | command:
|
---|
| 101 | </para>
|
---|
| 102 |
|
---|
| 103 | <screen><userinput>make</userinput></screen>
|
---|
| 104 |
|
---|
| 105 | <para>
|
---|
[7d35a9d2] | 106 | To build the <application>Qt5</application> GUI front-end, run the
|
---|
[bb535118] | 107 | following command:
|
---|
| 108 | </para>
|
---|
| 109 |
|
---|
[2454464] | 110 | <screen><userinput>make doc_dir=/usr/share/doc/highlight-&highlight-version;/ gui</userinput></screen>
|
---|
[7d35a9d2] | 111 | <!--
|
---|
[bb535118] | 112 | <para>
|
---|
| 113 | To build the API documentation, run the following command:
|
---|
| 114 | </para>
|
---|
| 115 |
|
---|
| 116 | <screen><userinput>make apidocs</userinput></screen>
|
---|
[7d35a9d2] | 117 | -->
|
---|
[bb535118] | 118 | <para>
|
---|
| 119 | This package does not come with a test suite.
|
---|
| 120 | </para>
|
---|
| 121 |
|
---|
| 122 | <para>
|
---|
| 123 | To install <application>Highlight</application>, run the
|
---|
| 124 | following command as the
|
---|
| 125 | <systemitem class="username">root</systemitem> user:
|
---|
| 126 | </para>
|
---|
| 127 |
|
---|
[2454464] | 128 | <screen role="root"><userinput>make doc_dir=/usr/share/doc/highlight-&highlight-version;/ install</userinput></screen>
|
---|
[bb535118] | 129 |
|
---|
[7d35a9d2] | 130 | <para>
|
---|
[bb535118] | 131 | To install the GUI program, run the following command as the
|
---|
| 132 | <systemitem class="username">root</systemitem> user:
|
---|
| 133 | </para>
|
---|
| 134 |
|
---|
| 135 | <screen role="root"><userinput>make install-gui</userinput></screen>
|
---|
[7d35a9d2] | 136 | <!--
|
---|
[bb535118] | 137 | <para>
|
---|
| 138 | To install the API documentation, run the following command
|
---|
| 139 | as the <systemitem class="username">root</systemitem> user:
|
---|
| 140 | </para>
|
---|
| 141 |
|
---|
| 142 | <screen role="root"><userinput>cp -rv apidocs/html /usr/share/doc/highlight/apidocs</userinput></screen>
|
---|
[7d35a9d2] | 143 | -->
|
---|
[bb535118] | 144 | </sect2>
|
---|
| 145 |
|
---|
[ec0f2a5] | 146 | <sect2 role="commands">
|
---|
| 147 | <title>Command Explanations</title>
|
---|
| 148 |
|
---|
| 149 | <para>
|
---|
[f75e8af] | 150 | <parameter>doc_dir=/usr/share/doc/highlight-&highlight-version;/</parameter>:
|
---|
[f64720d] | 151 | installs the highlight documentation into a versioned directory. This
|
---|
[ec0f2a5] | 152 | parameter is also needed for <command>make gui</command>, because
|
---|
[f75e8af] | 153 | its value would be hardcoded into the gui executable. Note that the
|
---|
| 154 | trailing <quote>/</quote> is necessary.
|
---|
[4e207bb] | 155 | </para>
|
---|
[ec0f2a5] | 156 | </sect2>
|
---|
| 157 |
|
---|
[bb535118] | 158 | <sect2 role="content">
|
---|
| 159 | <title>Contents</title>
|
---|
| 160 |
|
---|
| 161 | <segmentedlist>
|
---|
| 162 | <segtitle>Installed Programs</segtitle>
|
---|
| 163 | <segtitle>Installed Libraries</segtitle>
|
---|
| 164 | <segtitle>Installed Directories</segtitle>
|
---|
| 165 |
|
---|
| 166 | <seglistitem>
|
---|
| 167 | <seg>
|
---|
[f64720d] | 168 | highlight and highlight-gui (optional)
|
---|
[bb535118] | 169 | </seg>
|
---|
| 170 | <seg>
|
---|
| 171 | None
|
---|
| 172 | </seg>
|
---|
| 173 | <seg>
|
---|
[ac61d9b] | 174 | /etc/highlight,
|
---|
[3947fa9] | 175 | /usr/share/doc/highlight-&highlight-version;, and
|
---|
[bb535118] | 176 | /usr/share/highlight
|
---|
| 177 | </seg>
|
---|
| 178 | </seglistitem>
|
---|
| 179 | </segmentedlist>
|
---|
| 180 |
|
---|
| 181 | <variablelist>
|
---|
| 182 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 183 | <?dbfo list-presentation="list"?>
|
---|
| 184 | <?dbhtml list-presentation="table"?>
|
---|
| 185 |
|
---|
| 186 | <varlistentry id="highlight-prog">
|
---|
| 187 | <term><command>highlight</command></term>
|
---|
| 188 | <listitem>
|
---|
| 189 | <para>
|
---|
[4c24eb0a] | 190 | is a universal source code to formatted text converter
|
---|
[bb535118] | 191 | </para>
|
---|
| 192 | <indexterm zone="highlight highlight-prog">
|
---|
| 193 | <primary sortas="b-highlight">highlight</primary>
|
---|
| 194 | </indexterm>
|
---|
| 195 | </listitem>
|
---|
| 196 | </varlistentry>
|
---|
| 197 |
|
---|
| 198 | <varlistentry id="highlight-gui">
|
---|
| 199 | <term><command>highlight-gui</command></term>
|
---|
| 200 | <listitem>
|
---|
| 201 | <para>
|
---|
[f64720d] | 202 | is the <application>Qt5</application> interface to
|
---|
[bb535118] | 203 | <command>highlight</command>.
|
---|
| 204 | </para>
|
---|
| 205 | <indexterm zone="highlight highlight-gui">
|
---|
| 206 | <primary sortas="b-highlight-gui">highlight-gui</primary>
|
---|
| 207 | </indexterm>
|
---|
| 208 | </listitem>
|
---|
| 209 | </varlistentry>
|
---|
| 210 |
|
---|
| 211 | </variablelist>
|
---|
| 212 |
|
---|
| 213 | </sect2>
|
---|
| 214 |
|
---|
| 215 | </sect1>
|
---|