source: chapter08/ncurses.xml@ 9113316

multilib xry111/multilib
Last change on this file since 9113316 was b64efb72, checked in by Thomas Trepl <thomas@…>, 4 months ago

Adopt instruction change

  • Property mode set to 100644
File size: 17.4 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 --with-pkg-config-libdir=/usr/lib32/pkgconfig</userinput></screen>
215
216 <para>Compile the package:</para>
217
218<screen><userinput remap="make">make</userinput></screen>
219
220 <para>Install the package:</para>
221
222<screen><userinput remap="install">make DESTDIR=$PWD/DESTDIR install
223mkdir -p DESTDIR/usr/lib32/pkgconfig
224for lib in ncurses form panel menu ; do
225 rm -vf DESTDIR/usr/lib32/lib${lib}.so
226 echo "INPUT(-l${lib}w)" > DESTDIR/usr/lib32/lib${lib}.so
227 ln -svf ${lib}w.pc DESTDIR/usr/lib32/pkgconfig/$lib.pc
228done
229rm -vf DESTDIR/usr/lib32/libcursesw.so
230echo "INPUT(-lncursesw)" > DESTDIR/usr/lib32/libcursesw.so
231ln -sfv libncurses.so DESTDIR/usr/lib32/libcurses.so
232cp -Rv DESTDIR/usr/lib32/* /usr/lib32
233rm -rf DESTDIR</userinput></screen>
234
235 </sect2><!-- m32 -->
236
237 <!-- - - - - - - - - - -->
238 <!-- Multilib - x32bit -->
239 <!-- - - - - - - - - - -->
240 <sect2 arch="ml_x32,ml_all">
241 <title>Building Ncurses - x32bit</title>
242
243 <para>Clean previous build:</para>
244
245<screen><userinput remap="pre">make distclean</userinput></screen>
246
247 <para>Prepare Ncurses for compilation:</para>
248
249<screen><userinput remap="configure">CC="gcc -mx32" CXX="g++ -mx32" \
250./configure --prefix=/usr \
251 --host=x86_64-pc-linux-gnux32 \
252 --libdir=/usr/libx32 \
253 --mandir=/usr/share/man \
254 --with-shared \
255 --without-debug \
256 --without-normal \
257 --enable-pc-files \
258 --with-pkg-config-libdir=/usr/libx32/pkgconfig</userinput></screen>
259
260 <para>Compile the package:</para>
261
262<screen><userinput remap="make">make</userinput></screen>
263
264 <para>Install the package:</para>
265
266<screen><userinput remap="install">make DESTDIR=$PWD/DESTDIR install
267mkdir -p DESTDIR/usr/libx32/pkgconfig
268for lib in ncurses form panel menu ; do
269 rm -vf DESTDIR/usr/libx32/lib${lib}.so
270 echo "INPUT(-l${lib}w)" > DESTDIR/usr/libx32/lib${lib}.so
271 ln -svf ${lib}w.pc DESTDIR/usr/libx32/pkgconfig/$lib.pc
272done
273rm -vf DESTDIR/usr/libx32/libcursesw.so
274echo "INPUT(-lncursesw)" > DESTDIR/usr/libx32/libcursesw.so
275ln -sfv libncurses.so DESTDIR/usr/libx32/libcurses.so
276cp -Rv DESTDIR/usr/libx32/* /usr/libx32
277rm -rf DESTDIR</userinput></screen>
278
279 </sect2><!-- mx32 -->
280
281 <sect2 id="contents-ncurses" role="content">
282 <title>Contents of Ncurses</title>
283
284 <segmentedlist>
285 <segtitle>Installed programs</segtitle>
286 <segtitle>Installed libraries</segtitle>
287 <segtitle>Installed directories</segtitle>
288
289 <seglistitem>
290 <seg>
291 captoinfo (link to tic),
292 clear,
293 infocmp,
294 infotocap (link to tic),
295 ncursesw6-config,
296 reset (link to tset),
297 tabs,
298 tic,
299 toe,
300 tput, and
301 tset
302 </seg>
303 <seg>
304 libcurses.so (symlink),
305 libform.so (symlink),
306 libformw.so,
307 libmenu.so (symlink),
308 libmenuw.so,
309 libncurses.so (symlink),
310 libncursesw.so,
311 libncurses++w.so,
312 libpanel.so (symlink),
313 and libpanelw.so,
314 </seg>
315 <seg>
316 /usr/share/tabset,
317 /usr/share/terminfo, and
318 /usr/share/doc/ncurses-&ncurses-version;
319 </seg>
320 </seglistitem>
321 </segmentedlist>
322
323 <variablelist>
324 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
325 <?dbfo list-presentation="list"?>
326 <?dbhtml list-presentation="table"?>
327
328 <varlistentry id="captoinfo">
329 <term><command>captoinfo</command></term>
330 <listitem>
331 <para>Converts a termcap description into a terminfo description</para>
332 <indexterm zone="ch-system-ncurses captoinfo">
333 <primary sortas="b-captoinfo">captoinfo</primary>
334 </indexterm>
335 </listitem>
336 </varlistentry>
337
338 <varlistentry id="clear">
339 <term><command>clear</command></term>
340 <listitem>
341 <para>Clears the screen, if possible</para>
342 <indexterm zone="ch-system-ncurses clear">
343 <primary sortas="b-clear">clear</primary>
344 </indexterm>
345 </listitem>
346 </varlistentry>
347
348 <varlistentry id="infocmp">
349 <term><command>infocmp</command></term>
350 <listitem>
351 <para>Compares or prints out terminfo descriptions</para>
352 <indexterm zone="ch-system-ncurses infocmp">
353 <primary sortas="b-infocmp">infocmp</primary>
354 </indexterm>
355 </listitem>
356 </varlistentry>
357
358 <varlistentry id="infotocap">
359 <term><command>infotocap</command></term>
360 <listitem>
361 <para>Converts a terminfo description into a termcap description</para>
362 <indexterm zone="ch-system-ncurses infotocap">
363 <primary sortas="b-infotocap">infotocap</primary>
364 </indexterm>
365 </listitem>
366 </varlistentry>
367
368 <varlistentry id="ncursesw6-config">
369 <term><command>ncursesw6-config</command></term>
370 <listitem>
371 <para>Provides configuration information for ncurses</para>
372 <indexterm zone="ch-system-ncurses ncursesw6-config">
373 <primary sortas="b-ncursesw6-config">ncursesw6-config</primary>
374 </indexterm>
375 </listitem>
376 </varlistentry>
377
378 <varlistentry id="reset">
379 <term><command>reset</command></term>
380 <listitem>
381 <para>Reinitializes a terminal to its default values</para>
382 <indexterm zone="ch-system-ncurses reset">
383 <primary sortas="b-reset">reset</primary>
384 </indexterm>
385 </listitem>
386 </varlistentry>
387
388 <varlistentry id="tabs">
389 <term><command>tabs</command></term>
390 <listitem>
391 <para>Clears and sets tab stops on a terminal</para>
392 <indexterm zone="ch-system-ncurses tabs">
393 <primary sortas="b-tabs">tabs</primary>
394 </indexterm>
395 </listitem>
396 </varlistentry>
397
398 <varlistentry id="tic">
399 <term><command>tic</command></term>
400 <listitem>
401 <para>The terminfo entry-description compiler that translates a
402 terminfo file from source format into the binary format needed for the
403 ncurses library routines [A terminfo file contains information on the
404 capabilities of a certain terminal.]</para>
405 <indexterm zone="ch-system-ncurses tic">
406 <primary sortas="b-tic">tic</primary>
407 </indexterm>
408 </listitem>
409 </varlistentry>
410
411 <varlistentry id="toe">
412 <term><command>toe</command></term>
413 <listitem>
414 <para>Lists all available terminal types, giving the primary name and
415 description for each</para>
416 <indexterm zone="ch-system-ncurses toe">
417 <primary sortas="b-toe">toe</primary>
418 </indexterm>
419 </listitem>
420 </varlistentry>
421
422 <varlistentry id="tput">
423 <term><command>tput</command></term>
424 <listitem>
425 <para>Makes the values of terminal-dependent capabilities available to
426 the shell; it can also be used to reset or initialize a terminal or
427 report its long name</para>
428 <indexterm zone="ch-system-ncurses tput">
429 <primary sortas="b-tput">tput</primary>
430 </indexterm>
431 </listitem>
432 </varlistentry>
433
434 <varlistentry id="tset">
435 <term><command>tset</command></term>
436 <listitem>
437 <para>Can be used to initialize terminals</para>
438 <indexterm zone="ch-system-ncurses tset">
439 <primary sortas="b-tset">tset</primary>
440 </indexterm>
441 </listitem>
442 </varlistentry>
443
444 <varlistentry id="libncursesw">
445 <term><filename class="libraryfile">libncursesw</filename></term>
446 <listitem>
447 <para>Contains functions to display text in many complex ways on a
448 terminal screen; a good example of the use of these functions is the
449 menu displayed during the kernel's <command>make
450 menuconfig</command></para>
451 <indexterm zone="ch-system-ncurses libncursesw">
452 <primary sortas="c-libncursesw">libncursesw</primary>
453 </indexterm>
454 </listitem>
455 </varlistentry>
456
457 <varlistentry id="libncurses__w">
458 <term><filename class="libraryfile">libncurses++w</filename></term>
459 <listitem>
460 <para>Contains C++ binding for other libraries in this package</para>
461 <indexterm zone="ch-system-ncurses libncurses__w">
462 <primary sortas="c-libncurses++w">libncurses++w</primary>
463 </indexterm>
464 </listitem>
465 </varlistentry>
466
467 <varlistentry id="libformw">
468 <term><filename class="libraryfile">libformw</filename></term>
469 <listitem>
470 <para>Contains functions to implement forms</para>
471 <indexterm zone="ch-system-ncurses libformw">
472 <primary sortas="c-libformw">libformw</primary>
473 </indexterm>
474 </listitem>
475 </varlistentry>
476
477 <varlistentry id="libmenuw">
478 <term><filename class="libraryfile">libmenuw</filename></term>
479 <listitem>
480 <para>Contains functions to implement menus</para>
481 <indexterm zone="ch-system-ncurses libmenuw">
482 <primary sortas="c-libmenuw">libmenuw</primary>
483 </indexterm>
484 </listitem>
485 </varlistentry>
486
487 <varlistentry id="libpanelw">
488 <term><filename class="libraryfile">libpanelw</filename></term>
489 <listitem>
490 <para>Contains functions to implement panels</para>
491 <indexterm zone="ch-system-ncurses libpanelw">
492 <primary sortas="c-libpanelw">libpanelw</primary>
493 </indexterm>
494 </listitem>
495 </varlistentry>
496
497 </variablelist>
498
499 </sect2>
500
501</sect1>
Note: See TracBrowser for help on using the repository browser.