1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
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 "25e6aef8901eb5cf555f36be63ce502e">
|
---|
10 | <!ENTITY highlight-size "1.4 MB">
|
---|
11 | <!ENTITY highlight-buildsize "24 MB (with gui)">
|
---|
12 | <!ENTITY highlight-time "0.3 SBU (Using parallelism=4; with gui)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="highlight" xreflabel="Highlight-&highlight-version;">
|
---|
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 |
|
---|
33 | &lfs122_checked;
|
---|
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">
|
---|
79 | <!-- make apidocs fails because there is no Doxyfile
|
---|
80 | <xref linkend="doxygen"/> (to build the API documentation) and -->
|
---|
81 | <xref linkend="qt6"/> (to build the GUI front-end)
|
---|
82 | </para>
|
---|
83 |
|
---|
84 | </sect2>
|
---|
85 |
|
---|
86 | <sect2 role="installation">
|
---|
87 | <title>Installation of Highlight</title>
|
---|
88 |
|
---|
89 | <para>
|
---|
90 | For consistency, do not compress man pages.
|
---|
91 | </para>
|
---|
92 |
|
---|
93 | <screen><userinput>sed -i '/GZIP/s/^/#/' makefile</userinput></screen>
|
---|
94 |
|
---|
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>
|
---|
103 | To build the <application>qt6</application> GUI front-end, run the
|
---|
104 | following command:
|
---|
105 | </para>
|
---|
106 |
|
---|
107 | <screen role="nodump"><userinput>make doc_dir=/usr/share/doc/highlight-&highlight-version;/ gui</userinput></screen>
|
---|
108 | <!--
|
---|
109 | <para>
|
---|
110 | To build the API documentation, run the following command:
|
---|
111 | </para>
|
---|
112 |
|
---|
113 | <screen><userinput>make apidocs</userinput></screen>
|
---|
114 | -->
|
---|
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 |
|
---|
125 | <screen role="root"><userinput>make doc_dir=/usr/share/doc/highlight-&highlight-version;/ install</userinput></screen>
|
---|
126 |
|
---|
127 | <para>
|
---|
128 | To install the GUI program, run the following command as the
|
---|
129 | <systemitem class="username">root</systemitem> user:
|
---|
130 | </para>
|
---|
131 |
|
---|
132 | <screen role="nodump"><userinput>make install-gui</userinput></screen>
|
---|
133 | <!--
|
---|
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>
|
---|
140 | -->
|
---|
141 | </sect2>
|
---|
142 |
|
---|
143 | <sect2 role="commands">
|
---|
144 | <title>Command Explanations</title>
|
---|
145 |
|
---|
146 | <para>
|
---|
147 | <parameter>doc_dir=/usr/share/doc/highlight-&highlight-version;/</parameter>:
|
---|
148 | installs the highlight documentation into a versioned directory. This
|
---|
149 | parameter is also needed for <command>make gui</command>, because
|
---|
150 | its value would be hardcoded into the gui executable. Note that the
|
---|
151 | trailing <quote>/</quote> is necessary.
|
---|
152 | </para>
|
---|
153 | </sect2>
|
---|
154 |
|
---|
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>
|
---|
165 | highlight and highlight-gui (optional)
|
---|
166 | </seg>
|
---|
167 | <seg>
|
---|
168 | None
|
---|
169 | </seg>
|
---|
170 | <seg>
|
---|
171 | /etc/highlight,
|
---|
172 | /usr/share/doc/highlight-&highlight-version;, and
|
---|
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>
|
---|
187 | is a universal source code to formatted text converter
|
---|
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>
|
---|
199 | is the <application>qt6</application> interface to
|
---|
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>
|
---|