source: general/genutils/highlight.xml@ f75e8af

10.1 11.0 11.1 11.2 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since f75e8af was f75e8af, checked in by Xi Ruoyao <xry111@…>, 22 months ago

highlight: add trailing / in doc_dir explanation

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

  • 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 "0ece0fb9cc7b633d56a58bb72da81fce">
10 <!ENTITY highlight-size "1.3 MB">
11 <!ENTITY highlight-buildsize "30 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 <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 &lfs10_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 For consistency, do not compress man pages.
98 </para>
99
100<screen><userinput>sed -i '/GZIP/s/^/#/' makefile</userinput></screen>
101
102 <para>
103 To build <application>Highlight</application> run the following
104 command:
105 </para>
106
107<screen><userinput>make</userinput></screen>
108
109 <para>
110 To build the <application>Qt5</application> GUI front-end, run the
111 following command:
112 </para>
113
114<screen><userinput>make doc_dir=/usr/share/doc/highlight-&highlight-version;/ gui</userinput></screen>
115<!--
116 <para>
117 To build the API documentation, run the following command:
118 </para>
119
120<screen><userinput>make apidocs</userinput></screen>
121-->
122 <para>
123 This package does not come with a test suite.
124 </para>
125
126 <para>
127 To install <application>Highlight</application>, run the
128 following command as the
129 <systemitem class="username">root</systemitem> user:
130 </para>
131
132<screen role="root"><userinput>make doc_dir=/usr/share/doc/highlight-&highlight-version;/ install</userinput></screen>
133
134 <para>
135 To install the GUI program, run the following command as the
136 <systemitem class="username">root</systemitem> user:
137 </para>
138
139<screen role="root"><userinput>make install-gui</userinput></screen>
140<!--
141 <para>
142 To install the API documentation, run the following command
143 as the <systemitem class="username">root</systemitem> user:
144 </para>
145
146<screen role="root"><userinput>cp -rv apidocs/html /usr/share/doc/highlight/apidocs</userinput></screen>
147-->
148 </sect2>
149
150 <sect2 role="commands">
151 <title>Command Explanations</title>
152
153 <para>
154 <parameter>doc_dir=/usr/share/doc/highlight-&highlight-version;/</parameter>:
155 install highlight documentation into a versioned directory. This
156 parameter is also needed for <command>make gui</command>, because
157 its value would be hardcoded into the gui executable. Note that the
158 trailing <quote>/</quote> is necessary.
159 </para>
160 </sect2>
161
162 <sect2 role="content">
163 <title>Contents</title>
164
165 <segmentedlist>
166 <segtitle>Installed Programs</segtitle>
167 <segtitle>Installed Libraries</segtitle>
168 <segtitle>Installed Directories</segtitle>
169
170 <seglistitem>
171 <seg>
172 highlight
173 </seg>
174 <seg>
175 None
176 </seg>
177 <seg>
178 /etc/highlight,
179 /usr/share/doc/highlight/&highlight-version;, and
180 /usr/share/highlight
181 </seg>
182 </seglistitem>
183 </segmentedlist>
184
185 <variablelist>
186 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
187 <?dbfo list-presentation="list"?>
188 <?dbhtml list-presentation="table"?>
189
190 <varlistentry id="highlight-prog">
191 <term><command>highlight</command></term>
192 <listitem>
193 <para>
194 is a universal source code to formatted text converter.
195 </para>
196 <indexterm zone="highlight highlight-prog">
197 <primary sortas="b-highlight">highlight</primary>
198 </indexterm>
199 </listitem>
200 </varlistentry>
201
202<!--
203 <varlistentry id="highlight-gui">
204 <term><command>highlight-gui</command></term>
205 <listitem>
206 <para>
207 is the <application>Qt4</application> interface to
208 <command>highlight</command>.
209 </para>
210 <indexterm zone="highlight highlight-gui">
211 <primary sortas="b-highlight-gui">highlight-gui</primary>
212 </indexterm>
213 </listitem>
214 </varlistentry>
215-->
216
217 </variablelist>
218
219 </sect2>
220
221</sect1>
Note: See TracBrowser for help on using the repository browser.