[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[bb535118] | 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 " ">
|
---|
[d32ae7d] | 9 | <!ENTITY highlight-md5sum "25e6aef8901eb5cf555f36be63ce502e">
|
---|
[b3148f55] | 10 | <!ENTITY highlight-size "1.4 MB">
|
---|
[eb2a639] | 11 | <!ENTITY highlight-buildsize "24 MB (with gui)">
|
---|
[f1948e1] | 12 | <!ENTITY highlight-time "0.3 SBU (Using parallelism=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 |
|
---|
[aa996df1] | 33 | &lfs122_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 -->
|
---|
[d32ae7d] | 81 | <xref linkend="qt6"/> (to build the GUI front-end)
|
---|
[bb535118] | 82 | </para>
|
---|
| 83 |
|
---|
| 84 | </sect2>
|
---|
| 85 |
|
---|
| 86 | <sect2 role="installation">
|
---|
| 87 | <title>Installation of Highlight</title>
|
---|
| 88 |
|
---|
[ba31c2b] | 89 | <para>
|
---|
| 90 | For consistency, do not compress man pages.
|
---|
| 91 | </para>
|
---|
| 92 |
|
---|
| 93 | <screen><userinput>sed -i '/GZIP/s/^/#/' makefile</userinput></screen>
|
---|
| 94 |
|
---|
[bb535118] | 95 | <para>
|
---|
| 96 | To build <application>Highlight</application> run the following
|
---|
| 97 | command:
|
---|
| 98 | </para>
|
---|
| 99 |
|
---|
| 100 | <screen><userinput>make</userinput></screen>
|
---|
| 101 |
|
---|
| 102 | <para>
|
---|
[d32ae7d] | 103 | To build the <application>qt6</application> GUI front-end, run the
|
---|
[bb535118] | 104 | following command:
|
---|
| 105 | </para>
|
---|
| 106 |
|
---|
[875b3b57] | 107 | <screen role="nodump"><userinput>make doc_dir=/usr/share/doc/highlight-&highlight-version;/ gui</userinput></screen>
|
---|
[7d35a9d2] | 108 | <!--
|
---|
[bb535118] | 109 | <para>
|
---|
| 110 | To build the API documentation, run the following command:
|
---|
| 111 | </para>
|
---|
| 112 |
|
---|
| 113 | <screen><userinput>make apidocs</userinput></screen>
|
---|
[7d35a9d2] | 114 | -->
|
---|
[bb535118] | 115 | <para>
|
---|
| 116 | This package does not come with a test suite.
|
---|
| 117 | </para>
|
---|
| 118 |
|
---|
| 119 | <para>
|
---|
| 120 | To install <application>Highlight</application>, run the
|
---|
| 121 | following command as the
|
---|
| 122 | <systemitem class="username">root</systemitem> user:
|
---|
| 123 | </para>
|
---|
| 124 |
|
---|
[2454464] | 125 | <screen role="root"><userinput>make doc_dir=/usr/share/doc/highlight-&highlight-version;/ install</userinput></screen>
|
---|
[bb535118] | 126 |
|
---|
[7d35a9d2] | 127 | <para>
|
---|
[bb535118] | 128 | To install the GUI program, run the following command as the
|
---|
| 129 | <systemitem class="username">root</systemitem> user:
|
---|
| 130 | </para>
|
---|
| 131 |
|
---|
[875b3b57] | 132 | <screen role="nodump"><userinput>make install-gui</userinput></screen>
|
---|
[7d35a9d2] | 133 | <!--
|
---|
[bb535118] | 134 | <para>
|
---|
| 135 | To install the API documentation, run the following command
|
---|
| 136 | as the <systemitem class="username">root</systemitem> user:
|
---|
| 137 | </para>
|
---|
| 138 |
|
---|
| 139 | <screen role="root"><userinput>cp -rv apidocs/html /usr/share/doc/highlight/apidocs</userinput></screen>
|
---|
[7d35a9d2] | 140 | -->
|
---|
[bb535118] | 141 | </sect2>
|
---|
| 142 |
|
---|
[ec0f2a5] | 143 | <sect2 role="commands">
|
---|
| 144 | <title>Command Explanations</title>
|
---|
| 145 |
|
---|
| 146 | <para>
|
---|
[f75e8af] | 147 | <parameter>doc_dir=/usr/share/doc/highlight-&highlight-version;/</parameter>:
|
---|
[f64720d] | 148 | installs the highlight documentation into a versioned directory. This
|
---|
[ec0f2a5] | 149 | parameter is also needed for <command>make gui</command>, because
|
---|
[f75e8af] | 150 | its value would be hardcoded into the gui executable. Note that the
|
---|
| 151 | trailing <quote>/</quote> is necessary.
|
---|
[4e207bb] | 152 | </para>
|
---|
[ec0f2a5] | 153 | </sect2>
|
---|
| 154 |
|
---|
[bb535118] | 155 | <sect2 role="content">
|
---|
| 156 | <title>Contents</title>
|
---|
| 157 |
|
---|
| 158 | <segmentedlist>
|
---|
| 159 | <segtitle>Installed Programs</segtitle>
|
---|
| 160 | <segtitle>Installed Libraries</segtitle>
|
---|
| 161 | <segtitle>Installed Directories</segtitle>
|
---|
| 162 |
|
---|
| 163 | <seglistitem>
|
---|
| 164 | <seg>
|
---|
[f64720d] | 165 | highlight and highlight-gui (optional)
|
---|
[bb535118] | 166 | </seg>
|
---|
| 167 | <seg>
|
---|
| 168 | None
|
---|
| 169 | </seg>
|
---|
| 170 | <seg>
|
---|
[ac61d9b] | 171 | /etc/highlight,
|
---|
[3947fa9] | 172 | /usr/share/doc/highlight-&highlight-version;, and
|
---|
[bb535118] | 173 | /usr/share/highlight
|
---|
| 174 | </seg>
|
---|
| 175 | </seglistitem>
|
---|
| 176 | </segmentedlist>
|
---|
| 177 |
|
---|
| 178 | <variablelist>
|
---|
| 179 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 180 | <?dbfo list-presentation="list"?>
|
---|
| 181 | <?dbhtml list-presentation="table"?>
|
---|
| 182 |
|
---|
| 183 | <varlistentry id="highlight-prog">
|
---|
| 184 | <term><command>highlight</command></term>
|
---|
| 185 | <listitem>
|
---|
| 186 | <para>
|
---|
[4c24eb0a] | 187 | is a universal source code to formatted text converter
|
---|
[bb535118] | 188 | </para>
|
---|
| 189 | <indexterm zone="highlight highlight-prog">
|
---|
| 190 | <primary sortas="b-highlight">highlight</primary>
|
---|
| 191 | </indexterm>
|
---|
| 192 | </listitem>
|
---|
| 193 | </varlistentry>
|
---|
| 194 |
|
---|
| 195 | <varlistentry id="highlight-gui">
|
---|
| 196 | <term><command>highlight-gui</command></term>
|
---|
| 197 | <listitem>
|
---|
| 198 | <para>
|
---|
[d32ae7d] | 199 | is the <application>qt6</application> interface to
|
---|
[bb535118] | 200 | <command>highlight</command>.
|
---|
| 201 | </para>
|
---|
| 202 | <indexterm zone="highlight highlight-gui">
|
---|
| 203 | <primary sortas="b-highlight-gui">highlight-gui</primary>
|
---|
| 204 | </indexterm>
|
---|
| 205 | </listitem>
|
---|
| 206 | </varlistentry>
|
---|
| 207 |
|
---|
| 208 | </variablelist>
|
---|
| 209 |
|
---|
| 210 | </sect2>
|
---|
| 211 |
|
---|
| 212 | </sect1>
|
---|