source: chapter08/ncurses.xml@ 17695e52

multilib xry111/multilib
Last change on this file since 17695e52 was 1dd25fd, checked in by Thomas Trepl <thomas@…>, 5 months ago

Automatic merge of trunk into multilib

  • Property mode set to 100644
File size: 17.5 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
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
8<sect1 id="ch-system-ncurses" role="wrap">
9 <?dbhtml filename="ncurses.html"?>
10
11 <sect1info condition="script">
12 <productname>ncurses</productname>
13 <productnumber>&ncurses-version;</productnumber>
14 <address>&ncurses-url;</address>
15 </sect1info>
16
17 <title>Ncurses-&ncurses-version;</title>
18
19 <indexterm zone="ch-system-ncurses">
20 <primary sortas="a-Ncurses">Ncurses</primary>
21 </indexterm>
22
23 <sect2 role="package">
24 <title/>
25
26 <para>The Ncurses package contains libraries for terminal-independent
27 handling of character screens.</para>
28
29 <segmentedlist>
30 <segtitle>&buildtime;</segtitle>
31 <segtitle>&diskspace;</segtitle>
32
33 <seglistitem>
34 <seg>&ncurses-fin-sbu;</seg>
35 <seg>&ncurses-fin-du;</seg>
36 </seglistitem>
37 </segmentedlist>
38
39 </sect2>
40
41 <sect2 role="installation">
42 <title>Installation of Ncurses</title>
43
44 <para>Prepare Ncurses for compilation:</para>
45
46<screen><userinput remap="configure">./configure --prefix=/usr \
47 --mandir=/usr/share/man \
48 --with-shared \
49 --without-debug \
50 --without-normal \
51 --with-cxx-shared \
52 --enable-pc-files \
53 --with-pkg-config-libdir=/usr/lib/pkgconfig</userinput></screen>
54
55 <!-- - -enable-widec this is now the default -->
56 <variablelist>
57 <title>The meaning of the new configure options:</title>
58
59 <varlistentry>
60 <term><parameter>--with-shared</parameter></term>
61 <listitem>
62 <para>This makes Ncurses build and install shared C libraries.</para>
63 </listitem>
64 </varlistentry>
65
66 <varlistentry>
67 <term><parameter>--without-normal</parameter></term>
68 <listitem>
69 <para>This prevents Ncurses building and installing static C
70 libraries.</para>
71 </listitem>
72 </varlistentry>
73
74 <varlistentry>
75 <term><parameter>--without-debug</parameter></term>
76 <listitem>
77 <para>This prevents Ncurses building and installing debug
78 libraries.</para>
79 </listitem>
80 </varlistentry>
81
82 <varlistentry>
83 <term><parameter>--with-cxx-shared</parameter></term>
84 <listitem>
85 <para>This makes Ncurses build and install shared C++ bindings. It
86 also prevents it building and installing static C++ bindings.</para>
87 </listitem>
88 </varlistentry>
89
90 <varlistentry>
91 <term><parameter>--enable-pc-files</parameter></term>
92 <listitem>
93 <para>This switch generates and installs .pc files for pkg-config.
94 </para>
95 </listitem>
96 </varlistentry>
97<!--
98 <varlistentry>
99 <term><parameter>- -enable-widec</parameter></term>
100 <listitem>
101 <para>This switch causes wide-character libraries (e.g., <filename
102 class="libraryfile">libncursesw.so.&ncurses-release;</filename>)
103 to be built instead of normal ones (e.g., <filename
104 class="libraryfile">libncurses.so.&ncurses-release;</filename>).
105 These wide-character libraries are usable in both multibyte and
106 traditional 8-bit locales, while normal libraries work properly
107 only in 8-bit locales. Wide-character and normal libraries are
108 source-compatible, but not binary-compatible.</para>
109 </listitem>
110 </varlistentry>
111-->
112 </variablelist>
113
114 <para>Compile the package:</para>
115
116<screen><userinput remap="make">make</userinput></screen>
117
118 <para>This package has a test suite, but it can only be run after the
119 package has been installed. The tests reside in the
120 <filename class="directory">test/</filename> directory. See the
121 <filename>README</filename> file in that directory for further details.
122 </para>
123
124 <!-- To editors: crash of shell process was very rare but really
125 observed. We can't simply remove /usr/lib/libncursesw.so.6.x like
126 how we handle libmozjs-xx.so in BLFS because bash needs it, and
127 make will spawn new shell processes during "make install". -->
128
129 <para>The installation of this package will overwrite
130 <filename class="libraryfile">libncursesw.so.&ncurses-version;</filename>
131 in-place. It may crash the shell process which is using code and data
132 from the library file. Install the package with
133 <literal>DESTDIR</literal>, and replace the library file correctly using
134 <command>install</command> command (the header
135 <filename>curses.h</filename> is also edited to ensure the
136 wide-character ABI to be used as what we've done in
137 <xref linkend='ch-tools-ncurses'/>):</para>
138
139<screen><userinput remap="install">make DESTDIR=$PWD/dest install
140install -vm755 dest/usr/lib/libncursesw.so.&ncurses-version; /usr/lib
141rm -v dest/usr/lib/libncursesw.so.&ncurses-version;
142sed -e 's/^#if.*XOPEN.*$/#if 1/' \
143 -i dest/usr/include/curses.h
144cp -av dest/* /</userinput></screen>
145
146 <para>Many applications still expect the linker to be able to find
147 non-wide-character Ncurses libraries. Trick such applications into
148 linking with wide-character libraries by means of symlinks
149 (note that the <filename class='extension'>.so</filename> links are
150 only safe with <filename>curses.h</filename> edited to always use the
151 wide-character ABI):</para>
152
153<screen><userinput remap="install">for lib in ncurses form panel menu ; do
154 ln -sfv lib${lib}w.so /usr/lib/lib${lib}.so
155 ln -sfv ${lib}w.pc /usr/lib/pkgconfig/${lib}.pc
156done</userinput></screen>
157
158 <para>Finally, make sure that old applications that look for
159 <filename class="libraryfile">-lcurses</filename> at build time are still
160 buildable:</para>
161
162<screen><userinput remap="install">ln -sfv libncursesw.so /usr/lib/libcurses.so</userinput></screen>
163
164 <para>If desired, install the Ncurses documentation:</para>
165
166<screen><userinput remap="install">cp -v -R doc -T /usr/share/doc/ncurses-&ncurses-version;</userinput></screen>
167
168 <note>
169
170 <para>The instructions above don't create non-wide-character Ncurses
171 libraries since no package installed by compiling from sources would link
172 against them at runtime. However, the only known binary-only
173 applications that link against non-wide-character Ncurses libraries
174 require version 5. If you must have such libraries because of some binary-only
175 application or to be compliant with LSB, build the package again with the
176 following commands:</para>
177
178<screen role="nodump"><userinput>make distclean
179./configure --prefix=/usr \
180 --with-shared \
181 --without-normal \
182 --with-cxx-shared \
183 --without-debug \
184 --without-cxx-binding \
185 --with-abi-version=5
186make sources libs
187cp -av lib/lib*.so.5* /usr/lib</userinput></screen>
188 </note>
189
190 </sect2>
191
192 <!-- - - - - - - - - - -->
193 <!-- Multilib - 32bit -->
194 <!-- - - - - - - - - - -->
195 <sect2 arch="ml_32,ml_all">
196 <title>Building Ncurses - 32bit</title>
197
198 <para>Clean previous build:</para>
199
200<screen><userinput remap="pre">make distclean</userinput></screen>
201
202 <para>Prepare Ncurses for compilation:</para>
203
204<screen><userinput remap="configure">CC="gcc -m32" CXX="g++ -m32" \
205./configure --prefix=/usr \
206 --host=i686-pc-linux-gnu \
207 --libdir=/usr/lib32 \
208 --mandir=/usr/share/man \
209 --with-shared \
210 --without-debug \
211 --without-normal \
212 --with-cxx-shared \
213 --enable-pc-files \
214 --enable-widec \
215 --with-pkg-config-libdir=/usr/lib32/pkgconfig</userinput></screen>
216
217 <para>Compile the package:</para>
218
219<screen><userinput remap="make">make</userinput></screen>
220
221 <para>Install the package:</para>
222
223<screen><userinput remap="install">make DESTDIR=$PWD/DESTDIR install
224mkdir -p DESTDIR/usr/lib32/pkgconfig
225for lib in ncurses form panel menu ; do
226 rm -vf DESTDIR/usr/lib32/lib${lib}.so
227 echo "INPUT(-l${lib}w)" > DESTDIR/usr/lib32/lib${lib}.so
228 ln -svf ${lib}w.pc DESTDIR/usr/lib32/pkgconfig/$lib.pc
229done
230rm -vf DESTDIR/usr/lib32/libcursesw.so
231echo "INPUT(-lncursesw)" > DESTDIR/usr/lib32/libcursesw.so
232ln -sfv libncurses.so DESTDIR/usr/lib32/libcurses.so
233cp -Rv DESTDIR/usr/lib32/* /usr/lib32
234rm -rf DESTDIR</userinput></screen>
235
236 </sect2><!-- m32 -->
237
238 <!-- - - - - - - - - - -->
239 <!-- Multilib - x32bit -->
240 <!-- - - - - - - - - - -->
241 <sect2 arch="ml_x32,ml_all">
242 <title>Building Ncurses - x32bit</title>
243
244 <para>Clean previous build:</para>
245
246<screen><userinput remap="pre">make distclean</userinput></screen>
247
248 <para>Prepare Ncurses for compilation:</para>
249
250<screen><userinput remap="configure">CC="gcc -mx32" CXX="g++ -mx32" \
251./configure --prefix=/usr \
252 --host=x86_64-pc-linux-gnux32 \
253 --libdir=/usr/libx32 \
254 --mandir=/usr/share/man \
255 --with-shared \
256 --without-debug \
257 --without-normal \
258 --enable-pc-files \
259 --enable-widec \
260 --with-pkg-config-libdir=/usr/libx32/pkgconfig</userinput></screen>
261
262 <para>Compile the package:</para>
263
264<screen><userinput remap="make">make</userinput></screen>
265
266 <para>Install the package:</para>
267
268<screen><userinput remap="install">make DESTDIR=$PWD/DESTDIR install
269mkdir -p DESTDIR/usr/libx32/pkgconfig
270for lib in ncurses form panel menu ; do
271 rm -vf DESTDIR/usr/libx32/lib${lib}.so
272 echo "INPUT(-l${lib}w)" > DESTDIR/usr/libx32/lib${lib}.so
273 ln -svf ${lib}w.pc DESTDIR/usr/libx32/pkgconfig/$lib.pc
274done
275rm -vf DESTDIR/usr/libx32/libcursesw.so
276echo "INPUT(-lncursesw)" > DESTDIR/usr/libx32/libcursesw.so
277ln -sfv libncurses.so DESTDIR/usr/libx32/libcurses.so
278cp -Rv DESTDIR/usr/libx32/* /usr/libx32
279rm -rf DESTDIR</userinput></screen>
280
281 </sect2><!-- mx32 -->
282
283 <sect2 id="contents-ncurses" role="content">
284 <title>Contents of Ncurses</title>
285
286 <segmentedlist>
287 <segtitle>Installed programs</segtitle>
288 <segtitle>Installed libraries</segtitle>
289 <segtitle>Installed directories</segtitle>
290
291 <seglistitem>
292 <seg>
293 captoinfo (link to tic),
294 clear,
295 infocmp,
296 infotocap (link to tic),
297 ncursesw6-config,
298 reset (link to tset),
299 tabs,
300 tic,
301 toe,
302 tput, and
303 tset
304 </seg>
305 <seg>
306 libcurses.so (symlink),
307 libform.so (symlink),
308 libformw.so,
309 libmenu.so (symlink),
310 libmenuw.so,
311 libncurses.so (symlink),
312 libncursesw.so,
313 libncurses++w.so,
314 libpanel.so (symlink),
315 and libpanelw.so,
316 </seg>
317 <seg>
318 /usr/share/tabset,
319 /usr/share/terminfo, and
320 /usr/share/doc/ncurses-&ncurses-version;
321 </seg>
322 </seglistitem>
323 </segmentedlist>
324
325 <variablelist>
326 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
327 <?dbfo list-presentation="list"?>
328 <?dbhtml list-presentation="table"?>
329
330 <varlistentry id="captoinfo">
331 <term><command>captoinfo</command></term>
332 <listitem>
333 <para>Converts a termcap description into a terminfo description</para>
334 <indexterm zone="ch-system-ncurses captoinfo">
335 <primary sortas="b-captoinfo">captoinfo</primary>
336 </indexterm>
337 </listitem>
338 </varlistentry>
339
340 <varlistentry id="clear">
341 <term><command>clear</command></term>
342 <listitem>
343 <para>Clears the screen, if possible</para>
344 <indexterm zone="ch-system-ncurses clear">
345 <primary sortas="b-clear">clear</primary>
346 </indexterm>
347 </listitem>
348 </varlistentry>
349
350 <varlistentry id="infocmp">
351 <term><command>infocmp</command></term>
352 <listitem>
353 <para>Compares or prints out terminfo descriptions</para>
354 <indexterm zone="ch-system-ncurses infocmp">
355 <primary sortas="b-infocmp">infocmp</primary>
356 </indexterm>
357 </listitem>
358 </varlistentry>
359
360 <varlistentry id="infotocap">
361 <term><command>infotocap</command></term>
362 <listitem>
363 <para>Converts a terminfo description into a termcap description</para>
364 <indexterm zone="ch-system-ncurses infotocap">
365 <primary sortas="b-infotocap">infotocap</primary>
366 </indexterm>
367 </listitem>
368 </varlistentry>
369
370 <varlistentry id="ncursesw6-config">
371 <term><command>ncursesw6-config</command></term>
372 <listitem>
373 <para>Provides configuration information for ncurses</para>
374 <indexterm zone="ch-system-ncurses ncursesw6-config">
375 <primary sortas="b-ncursesw6-config">ncursesw6-config</primary>
376 </indexterm>
377 </listitem>
378 </varlistentry>
379
380 <varlistentry id="reset">
381 <term><command>reset</command></term>
382 <listitem>
383 <para>Reinitializes a terminal to its default values</para>
384 <indexterm zone="ch-system-ncurses reset">
385 <primary sortas="b-reset">reset</primary>
386 </indexterm>
387 </listitem>
388 </varlistentry>
389
390 <varlistentry id="tabs">
391 <term><command>tabs</command></term>
392 <listitem>
393 <para>Clears and sets tab stops on a terminal</para>
394 <indexterm zone="ch-system-ncurses tabs">
395 <primary sortas="b-tabs">tabs</primary>
396 </indexterm>
397 </listitem>
398 </varlistentry>
399
400 <varlistentry id="tic">
401 <term><command>tic</command></term>
402 <listitem>
403 <para>The terminfo entry-description compiler that translates a
404 terminfo file from source format into the binary format needed for the
405 ncurses library routines [A terminfo file contains information on the
406 capabilities of a certain terminal.]</para>
407 <indexterm zone="ch-system-ncurses tic">
408 <primary sortas="b-tic">tic</primary>
409 </indexterm>
410 </listitem>
411 </varlistentry>
412
413 <varlistentry id="toe">
414 <term><command>toe</command></term>
415 <listitem>
416 <para>Lists all available terminal types, giving the primary name and
417 description for each</para>
418 <indexterm zone="ch-system-ncurses toe">
419 <primary sortas="b-toe">toe</primary>
420 </indexterm>
421 </listitem>
422 </varlistentry>
423
424 <varlistentry id="tput">
425 <term><command>tput</command></term>
426 <listitem>
427 <para>Makes the values of terminal-dependent capabilities available to
428 the shell; it can also be used to reset or initialize a terminal or
429 report its long name</para>
430 <indexterm zone="ch-system-ncurses tput">
431 <primary sortas="b-tput">tput</primary>
432 </indexterm>
433 </listitem>
434 </varlistentry>
435
436 <varlistentry id="tset">
437 <term><command>tset</command></term>
438 <listitem>
439 <para>Can be used to initialize terminals</para>
440 <indexterm zone="ch-system-ncurses tset">
441 <primary sortas="b-tset">tset</primary>
442 </indexterm>
443 </listitem>
444 </varlistentry>
445
446 <varlistentry id="libncursesw">
447 <term><filename class="libraryfile">libncursesw</filename></term>
448 <listitem>
449 <para>Contains functions to display text in many complex ways on a
450 terminal screen; a good example of the use of these functions is the
451 menu displayed during the kernel's <command>make
452 menuconfig</command></para>
453 <indexterm zone="ch-system-ncurses libncursesw">
454 <primary sortas="c-libncursesw">libncursesw</primary>
455 </indexterm>
456 </listitem>
457 </varlistentry>
458
459 <varlistentry id="libncurses__w">
460 <term><filename class="libraryfile">libncurses++w</filename></term>
461 <listitem>
462 <para>Contains C++ binding for other libraries in this package</para>
463 <indexterm zone="ch-system-ncurses libncurses__w">
464 <primary sortas="c-libncurses++w">libncurses++w</primary>
465 </indexterm>
466 </listitem>
467 </varlistentry>
468
469 <varlistentry id="libformw">
470 <term><filename class="libraryfile">libformw</filename></term>
471 <listitem>
472 <para>Contains functions to implement forms</para>
473 <indexterm zone="ch-system-ncurses libformw">
474 <primary sortas="c-libformw">libformw</primary>
475 </indexterm>
476 </listitem>
477 </varlistentry>
478
479 <varlistentry id="libmenuw">
480 <term><filename class="libraryfile">libmenuw</filename></term>
481 <listitem>
482 <para>Contains functions to implement menus</para>
483 <indexterm zone="ch-system-ncurses libmenuw">
484 <primary sortas="c-libmenuw">libmenuw</primary>
485 </indexterm>
486 </listitem>
487 </varlistentry>
488
489 <varlistentry id="libpanelw">
490 <term><filename class="libraryfile">libpanelw</filename></term>
491 <listitem>
492 <para>Contains functions to implement panels</para>
493 <indexterm zone="ch-system-ncurses libpanelw">
494 <primary sortas="c-libpanelw">libpanelw</primary>
495 </indexterm>
496 </listitem>
497 </varlistentry>
498
499 </variablelist>
500
501 </sect2>
502
503</sect1>
Note: See TracBrowser for help on using the repository browser.