source: general/genutils/highlight.xml@ 08f422e

10.0 10.1 11.0 7.10 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus nosym perl-modules qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 08f422e was 08f422e, checked in by Bruce Dubbs <bdubbs@…>, 5 years ago

Archive qt4.
Make referenced to Qt4 in highlight and cairo external.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@17460 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 5.6 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 "05f75d4fb18a401181e658dcaf8ff562">
10 <!ENTITY highlight-size "608 KB">
11 <!ENTITY highlight-buildsize "17 MB (without GUI or API docs)">
12 <!ENTITY highlight-time "0.7 SBU (without GUI or API docs)">
13]>
14
15<sect1 id="highlight" xreflabel="Highlight-&highlight-version;" revision="systemd">
16 <?dbhtml filename="highlight.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>Highlight-&highlight-version;</title>
24
25 <indexterm zone="highlight">
26 <primary sortas="a-Highlight">Highlight</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Highlight</title>
31
32 <para>
33 <application>Highlight</application> is an utility that converts
34 source code to formatted text with syntax highlighting.
35 </para>
36
37 &lfs79_checked;&gcc6_checked;
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
73 <bridgehead renderas="sect3">Highlight Dependencies</bridgehead>
74
75 <bridgehead renderas="sect4">Required</bridgehead>
76 <para role="required">
77 <xref linkend="boost"/> and
78 <xref linkend="lua"/>
79 </para>
80
81 <bridgehead renderas="sect4">Optional</bridgehead>
82 <para role="optional">
83 <xref linkend="doxygen"/> (to build the API documentation) and
84 <ulink url=" http://download.qt-project.org/official_releases/qt/4.8">Qt4</ulink> (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 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>Qt4</application> GUI front-end, run the
104 following command:
105 </para>
106
107<screen><userinput>make 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 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="root"><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="content">
144 <title>Contents</title>
145
146 <segmentedlist>
147 <segtitle>Installed Programs</segtitle>
148 <segtitle>Installed Libraries</segtitle>
149 <segtitle>Installed Directories</segtitle>
150
151 <seglistitem>
152 <seg>
153 highlight and highlight-gui
154 </seg>
155 <seg>
156 None
157 </seg>
158 <seg>
159 /etc/highlight
160 /usr/share/doc/highlight, and
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
171 <varlistentry id="highlight-prog">
172 <term><command>highlight</command></term>
173 <listitem>
174 <para>
175 is a universal source code to formatted text converter.
176 </para>
177 <indexterm zone="highlight highlight-prog">
178 <primary sortas="b-highlight">highlight</primary>
179 </indexterm>
180 </listitem>
181 </varlistentry>
182
183 <varlistentry id="highlight-gui">
184 <term><command>highlight-gui</command></term>
185 <listitem>
186 <para>
187 is the <application>Qt4</application> interface to
188 <command>highlight</command>.
189 </para>
190 <indexterm zone="highlight highlight-gui">
191 <primary sortas="b-highlight-gui">highlight-gui</primary>
192 </indexterm>
193 </listitem>
194 </varlistentry>
195
196 </variablelist>
197
198 </sect2>
199
200</sect1>
Note: See TracBrowser for help on using the repository browser.