source: archive/juffed.xml

trunk
Last change on this file was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 3 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

  • Property mode set to 100644
File size: 7.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 juffed-download-http "&sources-anduin-http;/juffed/juffed-&juffed-version;.tar.xz">
8 <!ENTITY juffed-download-ftp " ">
9 <!ENTITY juffed-md5sum "5d211f5aadcb3d7365b5a6127d3d275f">
10 <!ENTITY juffed-size "1.3 MB">
11 <!ENTITY juffed-buildsize "22 MB">
12 <!ENTITY juffed-time "0.8 SBU">
13]>
14
15<sect1 id="juffed" xreflabel="juffed-&juffed-version;">
16 <?dbhtml filename="juffed.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>juffed-&juffed-version;</title>
23
24 <indexterm zone="juffed">
25 <primary sortas="a-juffed">juffed</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to JuffEd</title>
30
31 <para>
32 The <application>JuffEd</application> package is a Qt based editor with
33 support for multiple tabs. It is simple and clear, but very powerful.
34 It supports language syntax highlighting, auto-indents in accordance with
35 file type, code blocks folding, matching braces highlighting with instant
36 jumps between them, powerful search and replacing text using regular
37 expressions (including multiline ones) with the opportunity to use
38 matches \1, \2, &hellip; in substitutions, a terminal emulator, saving
39 named sessions and many other features.
40 </para>
41
42 &lfs82_checked;
43
44 <bridgehead renderas="sect3">Package Information</bridgehead>
45 <itemizedlist spacing="compact">
46 <listitem>
47 <para>
48 Download (HTTP): <ulink url="&juffed-download-http;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download (FTP): <ulink url="&juffed-download-ftp;"/>
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download MD5 sum: &juffed-md5sum;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Download size: &juffed-size;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated disk space required: &juffed-buildsize;
69 </para>
70 </listitem>
71 <listitem>
72 <para>
73 Estimated build time: &juffed-time;
74 </para>
75 </listitem>
76 </itemizedlist>
77
78 <para>
79 The source tarball shown above was created by the BLFS team by cloning
80 the source code repository, finding the correct version to rename
81 accordingly the source code directory, removing <filename
82 class="directory">.git</filename> directory and <filename
83 class="directory">.gitignore</filename> file, and finally making the
84 compressed tarball. No other modification has been made.
85 </para>
86
87 <bridgehead renderas="sect3">JuffEd Dependencies</bridgehead>
88
89 <bridgehead renderas="sect4">Required</bridgehead>
90 <para role="required">
91 <xref linkend="qscintilla"/>
92 </para>
93
94 <bridgehead renderas="sect4">Recommended</bridgehead>
95 <para role="recommended">
96 <xref linkend="qtermwidget"/> (for the terminal)
97 </para>
98
99 <bridgehead renderas="sect4">Optional</bridgehead>
100 <para role="optional">
101 <xref linkend="desktop-file-utils"/> and
102 <ulink url="http://cihar.com/software/enca/">Enca</ulink>
103 </para>
104
105 <para condition="html" role="usernotes">
106 User Notes: <ulink url="&blfs-wiki;/juffed"/>
107 </para>
108 </sect2>
109
110 <sect2 role="installation">
111 <title>Installation of JuffEd</title>
112
113 <para>
114 For compilation with <application>Qt4</application>, see <quote>Command
115 Explanations</quote> below. Install
116 <application>JuffEd</application> by running the following commands:
117 </para>
118
119<screen><userinput>sed -i 's/"64"/""/' cmake/LibSuffix.cmake &amp;&amp;
120sed -i '/JUFFED_LIBRARY/s/)$/ qtermwidget5)/' plugins/terminal/CMakeLists.txt &amp;&amp;
121
122mkdir -v build &amp;&amp;
123cd build &amp;&amp;
124
125cmake -DCMAKE_INSTALL_PREFIX=$LXQT_PREFIX \
126 -DCMAKE_BUILD_TYPE=Release \
127 -DBUILD_TERMINAL=ON \
128 -DUSE_QT5=true \
129 .. &amp;&amp;
130
131LIBRARY_PATH=$LXQT_PREFIX/lib make</userinput></screen>
132
133 <para>
134 The choice of <filename class="directory">/usr</filename> prefix is due
135 to the general characteristics of this program, which can be used
136 without <application>LXQt</application>.
137 </para>
138
139 <para>
140 This package does not come with a test suite.
141 </para>
142
143 <para>
144 Now, as the <systemitem class="username">root</systemitem> user:
145 </para>
146
147<screen role="root"><userinput>make install</userinput></screen>
148
149 </sect2>
150
151 <sect2 role="commands">
152 <title>Command Explanations</title>
153
154 <para>
155 <command>sed ... LibSuffix.cmake</command>: Removes the 64 from /lib64.
156 </para>
157
158 <para>
159 <command>sed -i '/JUFFED_LIBRARY/s/)$/ qtermwidget5)/'</command>: Allows this
160 package to build against current <xref linkend="qtermwidget"/>.
161 </para>
162
163 <para>
164 <envar>LIBRARY_PATH=$LXQT_PREFIX/lib</envar>: This environment
165 variable is needed for the linker to find a required library.
166 </para>
167
168 <para>
169 <parameter>-DBUILD_TERMINAL=ON</parameter>: This switch is used in order
170 to enable building the terminal. Toggle to <quote>OFF</quote> or remove
171 the switch, if you do not wish it.
172 </para>
173
174 <para>
175 <parameter>-DUSE_QT5=true</parameter>: This switch is used in order to
176 build this application linked to <application>Qt5</application>. Toggle
177 to <quote>false</quote>, if you prefer to use
178 <application>Qt4</application>.
179 </para>
180
181 </sect2>
182
183 <sect2 role="content">
184 <title>Contents</title>
185
186 <segmentedlist>
187 <segtitle>Installed Program</segtitle>
188 <segtitle>Installed Libraries</segtitle>
189 <segtitle>Installed Directory</segtitle>
190
191 <seglistitem>
192 <seg>
193 juffed
194 </seg>
195 <seg>
196 libjuff.so,
197 libjuffed-engine-qsci.so and
198 plugins under /usr/lib/juffed/plugins
199 </seg>
200 <seg>
201 /usr/{include,lib,share}/juffed
202 </seg>
203 </seglistitem>
204 </segmentedlist>
205
206 <variablelist>
207 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
208 <?dbfo list-presentation="list"?>
209 <?dbhtml list-presentation="table"?>
210
211 <varlistentry id="juffed-prog">
212 <term><command>juffed</command></term>
213 <listitem>
214 <para>
215 is a <application>Qt</application> based text editor.
216 </para>
217 <indexterm zone="juffed juffed-prog">
218 <primary sortas="b-juffed">juffed</primary>
219 </indexterm>
220 </listitem>
221 </varlistentry>
222
223 <varlistentry id="libjuff">
224 <term><filename class="libraryfile">libjuff.so</filename></term>
225 <listitem>
226 <para>
227 contains the <application>JuffEd</application> API functions.
228 </para>
229 <indexterm zone="juffed libjuff">
230 <primary sortas="c-libjuff">libjuff.so</primary>
231 </indexterm>
232 </listitem>
233 </varlistentry>
234
235 <varlistentry id="libjuffed-engine-qsci">
236 <term><filename class="libraryfile">libjuffed-engine-qsci.so</filename></term>
237 <listitem>
238 <para>
239 contains the <application>QScintilla</application> bindings.
240 </para>
241 <indexterm zone="juffed libjuffed-engine-qsci">
242 <primary sortas="c-libjuffed-engine-qsci">libjuffed-engine-qsci.so</primary>
243 </indexterm>
244 </listitem>
245 </varlistentry>
246
247 </variablelist>
248
249 </sect2>
250
251</sect1>
Note: See TracBrowser for help on using the repository browser.