source: general/genutils/highlight.xml@ f64720d

11.0 qt5new trunk
Last change on this file since f64720d was f64720d, checked in by Douglas R. Reno <renodr@…>, 5 months ago

Update to highlight-4.0

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