source: x/lib/fltk.xml@ 06908bf6

10.0 10.1 11.0 9.0 9.1 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 06908bf6 was 06908bf6, checked in by Pierre Labastie <pieere@…>, 2 years ago

Add remap="doc", remap="test", or just realign them

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

  • Property mode set to 100644
File size: 7.9 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 <!-- Watch directory when updating -->
8 <!ENTITY fltk-download-http "http://fltk.org/pub/fltk/1.3.5/fltk-&fltk-version;-source.tar.gz">
9 <!ENTITY fltk-download-ftp " ">
10 <!ENTITY fltk-md5sum "e85017defd5a03ae82e634311db87bbf">
11 <!ENTITY fltk-size "5.1 MB">
12 <!ENTITY fltk-buildsize "117 MB (with documentation)">
13 <!ENTITY fltk-time "0.2 SBU (Using parallelism=4)">
14]>
15
16<sect1 id="fltk" xreflabel="FLTK-&fltk-version;">
17 <?dbhtml filename="fltk.html"?>
18
19 <sect1info>
20 <othername>$LastChangedBy$</othername>
21 <date>$Date$</date>
22 </sect1info>
23
24 <title>FLTK-&fltk-version;</title>
25
26 <indexterm zone="fltk">
27 <primary sortas="a-FLTK">FLTK</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to FLTK</title>
32
33 <para>
34 FLTK (pronounced "fulltick") is a cross-platform C++ GUI toolkit.
35 FLTK provides modern GUI functionality and supports 3D graphics via
36 OpenGL and its built-in GLUT emulation libraries used for creating
37 graphical user interfaces for applications.
38 </para>
39
40 &lfs84_checked;
41
42 <bridgehead renderas="sect3">Package Information</bridgehead>
43 <itemizedlist spacing="compact">
44 <listitem>
45 <para>
46 Download (HTTP): <ulink url="&fltk-download-http;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download (FTP): <ulink url="&fltk-download-ftp;"/>
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download MD5 sum: &fltk-md5sum;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Download size: &fltk-size;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated disk space required: &fltk-buildsize;
67 </para>
68 </listitem>
69 <listitem>
70 <para>
71 Estimated build time: &fltk-time;
72 </para>
73 </listitem>
74 </itemizedlist>
75
76 <bridgehead renderas="sect3">FLTK Dependencies</bridgehead>
77
78 <bridgehead renderas="sect4">Required</bridgehead>
79 <para role="required">
80 <xref linkend="xorg7-lib"/>
81 </para>
82
83 <bridgehead renderas="sect4">Recommended</bridgehead>
84 <para role="recommended">
85 <xref linkend="hicolor-icon-theme"/>,
86 <xref linkend="libjpeg"/>, and
87 <xref linkend="libpng"/>
88 </para>
89
90 <bridgehead renderas="sect4">Optional</bridgehead>
91 <para role="optional">
92 <xref linkend="alsa-lib"/>,
93 <xref linkend="desktop-file-utils"/>,
94 <xref linkend="doxygen"/>,
95 <xref linkend="glu"/>,
96 <xref linkend="mesa"/>, and
97 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>)
98 </para>
99
100 <para condition="html" role="usernotes">
101 User Notes: <ulink url="&blfs-wiki;/fltk"/>
102 </para>
103 </sect2>
104
105 <sect2 role="installation">
106 <title>Installation of FLTK</title>
107
108 <note>
109 <para>The tar extraction directory is fltk-&fltk-version; and not
110 fltk-&fltk-version;-source as indicated by the tarball name.</para>
111 </note>
112
113 <para>
114 Install <application>FLTK</application> by running the following
115 commands:
116 </para>
117
118<screen><userinput>sed -i -e '/cat./d' documentation/Makefile &amp;&amp;
119
120./configure --prefix=/usr \
121 --enable-shared &amp;&amp;
122make</userinput></screen>
123
124 <para>If you wish to create the API documentation, issue:</para>
125
126<screen remap="doc"><userinput>make -C documentation html</userinput></screen>
127
128 <para>The tests for the package are interactive. To execute the tests, run
129 <command>test/unittests</command>. In addition, there are 70 other
130 executable test programs in the <filename class='directory'>test</filename>
131 directory that can be run individually.</para>
132
133 <para>
134 Now, as the <systemitem class="username">root</systemitem> user:
135 </para>
136
137<screen role="root"><userinput>make docdir=/usr/share/doc/fltk-&fltk-version; install</userinput></screen>
138
139 <para>If desired, install some example games built as a part of the tests,
140 extra documentation and example programs. As the <systemitem
141 class="username">root</systemitem> user:</para>
142
143<screen role="root"
144 remap="doc"><userinput>make -C test docdir=/usr/share/doc/fltk-&fltk-version; install-linux &amp;&amp;
145make -C documentation docdir=/usr/share/doc/fltk-&fltk-version; install-linux</userinput></screen>
146
147 </sect2>
148
149 <sect2 role="commands">
150 <title>Command Explanations</title>
151
152 <para>
153 <command>sed ... documentation/Makefile</command>: Avoid installing
154 pages in <filename class='directory'>/usr/share/man/cat*</filename>.
155 </para>
156
157 </sect2>
158
159 <sect2 role="content">
160 <title>Contents</title>
161
162 <segmentedlist>
163 <segtitle>Installed Programs</segtitle>
164 <segtitle>Installed Libraries</segtitle>
165 <segtitle>Installed Directories</segtitle>
166
167 <seglistitem>
168 <seg>
169 blocks,
170 checkers,
171 fltk-config,
172 fluid, and
173 sudoku
174 </seg>
175 <seg>
176 libfltk.{a,so},
177 libfltk_forms.{a,so},
178 libfltk_gl.{a,so}, and
179 libfltk_images.{a,so}
180 </seg>
181 <seg>
182 /usr/include/FL and
183 /usr/share/doc/fltk-&fltk-version;
184 </seg>
185 </seglistitem>
186 </segmentedlist>
187
188 <variablelist>
189 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
190 <?dbfo list-presentation="list"?>
191 <?dbhtml list-presentation="table"?>
192
193 <varlistentry id="blocks">
194 <term><command>blocks</command></term>
195 <listitem>
196 <para>
197 is a FLTK-based block elimination game.
198 </para>
199 <indexterm zone="fltk blocks">
200 <primary sortas="b-blocks">blocks</primary>
201 </indexterm>
202 </listitem>
203 </varlistentry>
204
205 <varlistentry id="checkers">
206 <term><command>checkers</command></term>
207 <listitem>
208 <para>
209 is a FLTK-based version of the game of checkers.
210 </para>
211 <indexterm zone="fltk checkers">
212 <primary sortas="b-checkers">checkers</primary>
213 </indexterm>
214 </listitem>
215 </varlistentry>
216
217 <varlistentry id="fltk-config">
218 <term><command>fltk-config</command></term>
219 <listitem>
220 <para>
221 is a utility script that can be used to get information about the
222 current version of FLTK that is installed on the system.
223 </para>
224 <indexterm zone="fltk fltk-config">
225 <primary sortas="b-fltk-config">fltk-config</primary>
226 </indexterm>
227 </listitem>
228 </varlistentry>
229
230 <varlistentry id="fluid">
231 <term><command>fluid</command></term>
232 <listitem>
233 <para>
234 is an interactive GUI designer for FLTK.
235 </para>
236 <indexterm zone="fltk fluid">
237 <primary sortas="b-fluid">fluid</primary>
238 </indexterm>
239 </listitem>
240 </varlistentry>
241
242 <varlistentry id="sudoku">
243 <term><command>sudoku</command></term>
244 <listitem>
245 <para>
246 is an implementation of the popular Sudoku game.
247 </para>
248 <indexterm zone="fltk sudoku">
249 <primary sortas="b-sudoku">sudoku</primary>
250 </indexterm>
251 </listitem>
252 </varlistentry>
253
254 <varlistentry id="libfltk">
255 <term><filename class="libraryfile">libfltk.so</filename></term>
256 <listitem>
257 <para>
258 contains functions that provide an API to implement graphical user
259 interfaces.
260 </para>
261 <indexterm zone="fltk libfltk">
262 <primary sortas="c-libfltk">libfltk.so</primary>
263 </indexterm>
264 </listitem>
265 </varlistentry>
266
267 </variablelist>
268
269 </sect2>
270
271</sect1>
Note: See TracBrowser for help on using the repository browser.