source: general/genutils/highlight.xml@ 38489aa0

10.0 10.1 11.0 11.1 8.4 9.0 9.1 lazarus qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since 38489aa0 was 38489aa0, checked in by Pierre Labastie <pieere@…>, 3 years ago

Tags

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

  • Property mode set to 100644
File size: 5.5 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 "ea39fb9f562156efa35e4de586909d6a">
10 <!ENTITY highlight-size "1.3 MB">
11 <!ENTITY highlight-buildsize "27 MB">
12 <!ENTITY highlight-time "0.3 SBU (Using paralllelism=4)">
13]>
14
15<sect1 id="highlight" xreflabel="Highlight-&highlight-version;">
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 &lfs84_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 <!-- make apidocs fails because there is no Doxyfile
84 <xref linkend="doxygen"/> (to build the API documentation) and -->
85 <xref linkend="qt5"/> (to build the GUI front-end)
86 </para>
87
88 <para condition="html" role="usernotes">
89 User Notes: <ulink url="&blfs-wiki;/highlight"/>
90 </para>
91 </sect2>
92
93 <sect2 role="installation">
94 <title>Installation of Highlight</title>
95
96 <para>
97 To build <application>Highlight</application> run the following
98 command:
99 </para>
100
101<screen><userinput>make</userinput></screen>
102
103 <para>
104 To build the <application>Qt5</application> GUI front-end, run the
105 following command:
106 </para>
107
108<screen><userinput>make gui</userinput></screen>
109<!--
110 <para>
111 To build the API documentation, run the following command:
112 </para>
113
114<screen><userinput>make apidocs</userinput></screen>
115-->
116 <para>
117 This package does not come with a test suite.
118 </para>
119
120 <para>
121 To install <application>Highlight</application>, run the
122 following command as the
123 <systemitem class="username">root</systemitem> user:
124 </para>
125
126<screen role="root"><userinput>make install</userinput></screen>
127
128 <para>
129 To install the GUI program, run the following command as the
130 <systemitem class="username">root</systemitem> user:
131 </para>
132
133<screen role="root"><userinput>make install-gui</userinput></screen>
134<!--
135 <para>
136 To install the API documentation, run the following command
137 as the <systemitem class="username">root</systemitem> user:
138 </para>
139
140<screen role="root"><userinput>cp -rv apidocs/html /usr/share/doc/highlight/apidocs</userinput></screen>
141-->
142 </sect2>
143
144 <sect2 role="content">
145 <title>Contents</title>
146
147 <segmentedlist>
148 <segtitle>Installed Programs</segtitle>
149 <segtitle>Installed Libraries</segtitle>
150 <segtitle>Installed Directories</segtitle>
151
152 <seglistitem>
153 <seg>
154 highlight
155 </seg>
156 <seg>
157 None
158 </seg>
159 <seg>
160 /etc/highlight,
161 /usr/share/doc/highlight, and
162 /usr/share/highlight
163 </seg>
164 </seglistitem>
165 </segmentedlist>
166
167 <variablelist>
168 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
169 <?dbfo list-presentation="list"?>
170 <?dbhtml list-presentation="table"?>
171
172 <varlistentry id="highlight-prog">
173 <term><command>highlight</command></term>
174 <listitem>
175 <para>
176 is a universal source code to formatted text converter.
177 </para>
178 <indexterm zone="highlight highlight-prog">
179 <primary sortas="b-highlight">highlight</primary>
180 </indexterm>
181 </listitem>
182 </varlistentry>
183
184<!--
185 <varlistentry id="highlight-gui">
186 <term><command>highlight-gui</command></term>
187 <listitem>
188 <para>
189 is the <application>Qt4</application> interface to
190 <command>highlight</command>.
191 </para>
192 <indexterm zone="highlight highlight-gui">
193 <primary sortas="b-highlight-gui">highlight-gui</primary>
194 </indexterm>
195 </listitem>
196 </varlistentry>
197-->
198
199 </variablelist>
200
201 </sect2>
202
203</sect1>
Note: See TracBrowser for help on using the repository browser.