source: BOOK/final-system/common/ncurses.xml @ 47e0529

clfs-3.0.0-sysvinitsysvinit
Last change on this file since 47e0529 was 47e0529, checked in by Chris Staub <chris@…>, 8 years ago

Added command explanation to ncurses

  • Property mode set to 100644
File size: 10.3 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
8<sect1 id="ch-system-ncurses" role="wrap">
9  <?dbhtml filename="ncurses.html"?>
10
11  <title>Ncurses-&ncurses-version;</title>
12
13  <indexterm zone="ch-system-ncurses">
14    <primary sortas="a-Ncurses">Ncurses</primary>
15  </indexterm>
16
17  <sect2 role="package">
18    <title/>
19
20    <para>The Ncurses package contains libraries for terminal-independent
21    handling of character screens.</para>
22
23  </sect2>
24
25  <sect2 role="installation">
26    <title>Installation of Ncurses</title>
27
28    <para os="p1">The following patch contains updates from the &ncurses-version; branch
29    by the Ncurses developers:</para>
30
31<screen os="p2"><userinput>patch -Np1 -i ../&ncurses-branch_update-patch;</userinput></screen>
32
33    <para os="a">Prepare Ncurses for compilation:</para>
34
35<screen os="b"><userinput>./configure --prefix=/usr --libdir=/lib \
36    --with-shared --without-debug --enable-widec \
37    --with-manpage-format=normal \
38    --with-default-terminfo-dir=/usr/share/terminfo</userinput></screen>
39
40    <variablelist os="b1">
41      <title>The meaning of the new configure option:</title>
42
43      <varlistentry>
44        <term><parameter>--with-manpage-format=normal</parameter></term>
45        <listitem>
46          <para>This tells Ncurses not to compress its installed manpages.</para>
47        </listitem>
48      </varlistentry>
49    </variablelist>
50
51    <para os="c">Compile the package:</para>
52
53<screen os="d"><userinput>make</userinput></screen>
54
55    <para os="e">This package has a test suite, but it can only be run after
56    the package is installed. The tests are in the
57    <filename class="directory">test/</filename> directory. See the
58    <filename>README</filename> file in that directory for details.</para>
59
60    <para os="f">Install the package:</para>
61
62<screen os="g"><userinput>make install</userinput></screen>
63
64    <para os="h">Move the Ncurses static libraries to the proper location:</para>
65
66<screen os="i"><userinput>mv -v /lib/lib{panelw,menuw,formw,ncursesw,ncurses++w}.a /usr/lib</userinput></screen>
67
68    <para os="j">Create symlinks in <filename class="directory">/usr/lib:</filename></para>
69
70<screen os="k"><userinput>ln -svf ../../lib/$(readlink /lib/libncursesw.so) /usr/lib/libncursesw.so
71ln -svf ../../lib/$(readlink /lib/libmenuw.so) /usr/lib/libmenuw.so
72ln -svf ../../lib/$(readlink /lib/libpanelw.so) /usr/lib/libpanelw.so
73ln -svf ../../lib/$(readlink /lib/libformw.so) /usr/lib/libformw.so
74rm -v /lib/lib{ncursesw,menuw,panelw,formw}.so</userinput></screen>
75
76    <para os="l">Many packages that use Ncurses will compile just fine against
77    the widechar libraries, but won't know to look for them. Create linker
78    scripts and symbolic links to allow older and non-widec compatible
79    programs to build properly:</para>
80
81<screen os="m"><userinput>for lib in curses ncurses form panel menu ; do
82        echo "INPUT(-l${lib}w)" &gt; /usr/lib/lib${lib}.so
83        ln -sfv lib${lib}w.a /usr/lib/lib${lib}.a
84done
85ln -sfv libncursesw.so /usr/lib/libcursesw.so
86ln -sfv libncursesw.a /usr/lib/libcursesw.a
87ln -sfv libncurses++w.a /usr/lib/libncurses++.a
88ln -sfv ncursesw5-config /usr/bin/ncurses5-config</userinput></screen>
89
90  </sect2>
91
92  <sect2 id="contents-ncurses" role="content">
93    <title>Contents of Ncurses</title>
94
95    <segmentedlist>
96      <segtitle>Installed programs</segtitle>
97      <segtitle>Installed libraries</segtitle>
98      <segtitle>Installed directories</segtitle>
99
100      <seglistitem>
101        <seg>captoinfo (link to tic), clear, infocmp, infotocap (link to tic),
102        ncursesw5-config, reset (link to tset), tabs, tic, toe, tput, tset</seg>
103        <seg>libcursesw.so (link to libncursesw.so), libformw.[a,so],
104        libmenuw.[a,so], libncurses++w.a, libncursesw.[a,so],
105        libpanelw.[a,so]</seg>
106        <seg>/usr/share/tabset, /usr/share/terminfo</seg>
107      </seglistitem>
108    </segmentedlist>
109
110    <variablelist>
111      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
112      <?dbfo list-presentation="list"?>
113      <?dbhtml list-presentation="table"?>
114
115      <varlistentry id="captoinfo">
116        <term><command>captoinfo</command></term>
117        <listitem>
118          <para>Converts a termcap description into a terminfo description</para>
119          <indexterm zone="ch-system-ncurses captoinfo">
120            <primary sortas="b-captoinfo">captoinfo</primary>
121          </indexterm>
122        </listitem>
123      </varlistentry>
124
125      <varlistentry id="clear">
126        <term><command>clear</command></term>
127        <listitem>
128          <para>Clears the screen, if possible</para>
129          <indexterm zone="ch-system-ncurses clear">
130            <primary sortas="b-clear">clear</primary>
131          </indexterm>
132        </listitem>
133      </varlistentry>
134
135      <varlistentry id="infocmp">
136        <term><command>infocmp</command></term>
137        <listitem>
138          <para>Compares or prints out terminfo descriptions</para>
139          <indexterm zone="ch-system-ncurses infocmp">
140            <primary sortas="b-infocmp">infocmp</primary>
141          </indexterm>
142        </listitem>
143      </varlistentry>
144
145      <varlistentry id="infotocap">
146        <term><command>infotocap</command></term>
147        <listitem>
148          <para>Converts a terminfo description into a termcap description</para>
149          <indexterm zone="ch-system-ncurses infotocap">
150            <primary sortas="b-infotocap">infotocap</primary>
151          </indexterm>
152        </listitem>
153      </varlistentry>
154
155      <varlistentry id="ncursesw5-config">
156        <term><command>ncursesw5-config</command></term>
157        <listitem>
158          <para>Provides configuration information for ncurses</para>
159          <indexterm zone="ch-system-ncurses ncursesw5-config">
160            <primary sortas="b-ncursesw5-config">ncursesw5-config</primary>
161          </indexterm>
162        </listitem>
163      </varlistentry>
164
165      <varlistentry id="reset">
166        <term><command>reset</command></term>
167        <listitem>
168          <para>Reinitializes a terminal to its default values</para>
169          <indexterm zone="ch-system-ncurses reset">
170            <primary sortas="b-reset">reset</primary>
171          </indexterm>
172        </listitem>
173      </varlistentry>
174
175      <varlistentry id="tabs">
176        <term><command>tabs</command></term>
177        <listitem>
178          <para>Sets and clears tab stops on a terminal</para>
179          <indexterm zone="ch-system-ncurses tabs">
180            <primary sortas="b-tabs">tabs</primary>
181          </indexterm>
182        </listitem>
183      </varlistentry>
184
185      <varlistentry id="tic">
186        <term><command>tic</command></term>
187        <listitem>
188          <para>The terminfo entry-description compiler that translates a
189          terminfo file from source format into the binary format needed for the
190          ncurses library routines. A terminfo file contains information on the
191          capabilities of a certain terminal</para>
192          <indexterm zone="ch-system-ncurses tic">
193            <primary sortas="b-tic">tic</primary>
194          </indexterm>
195        </listitem>
196      </varlistentry>
197
198      <varlistentry id="toe">
199        <term><command>toe</command></term>
200        <listitem>
201          <para>Lists all available terminal types, giving the primary name and
202          description for each</para>
203          <indexterm zone="ch-system-ncurses toe">
204            <primary sortas="b-toe">toe</primary>
205          </indexterm>
206        </listitem>
207      </varlistentry>
208
209      <varlistentry id="tput">
210        <term><command>tput</command></term>
211        <listitem>
212          <para>Makes the values of terminal-dependent capabilities available to
213          the shell; it can also be used to reset or initialize a terminal or
214          report its long name</para>
215          <indexterm zone="ch-system-ncurses tput">
216            <primary sortas="b-tput">tput</primary>
217          </indexterm>
218        </listitem>
219      </varlistentry>
220
221      <varlistentry id="tset">
222        <term><command>tset</command></term>
223        <listitem>
224          <para>Can be used to initialize terminals</para>
225          <indexterm zone="ch-system-ncurses tset">
226            <primary sortas="b-tset">tset</primary>
227          </indexterm>
228        </listitem>
229      </varlistentry>
230
231      <varlistentry id="libcursesw">
232        <term><filename class="libraryfile">libcursesw</filename></term>
233        <listitem>
234          <para>A link to <filename>libncursesw</filename></para>
235          <indexterm zone="ch-system-ncurses libcursesw">
236            <primary sortas="c-libcursesw">libcursesw</primary>
237          </indexterm>
238        </listitem>
239      </varlistentry>
240
241      <varlistentry id="libncursesw">
242        <term><filename class="libraryfile">libncursesw</filename></term>
243        <listitem>
244          <para>Contains functions to display text in many complex ways on a
245          terminal screen; a good example of the use of these functions is the
246          menu displayed during the kernel's
247          <command>make menuconfig</command></para>
248          <indexterm zone="ch-system-ncurses libncursesw">
249            <primary sortas="c-libncursesw">libncursesw</primary>
250          </indexterm>
251        </listitem>
252      </varlistentry>
253
254      <varlistentry id="libformw">
255        <term><filename class="libraryfile">libformw</filename></term>
256        <listitem>
257          <para>Contains functions to implement forms</para>
258          <indexterm zone="ch-system-ncurses libformw">
259            <primary sortas="c-libform">libformw</primary>
260          </indexterm>
261        </listitem>
262      </varlistentry>
263
264      <varlistentry id="libmenuw">
265        <term><filename class="libraryfile">libmenuw</filename></term>
266        <listitem>
267          <para>Contains functions to implement menus</para>
268          <indexterm zone="ch-system-ncurses libmenuw">
269            <primary sortas="c-libmenuw">libmenuw</primary>
270          </indexterm>
271        </listitem>
272      </varlistentry>
273
274      <varlistentry id="libpanelw">
275        <term><filename class="libraryfile">libpanelw</filename></term>
276        <listitem>
277          <para>Contains functions to implement panels</para>
278          <indexterm zone="ch-system-ncurses libpanelw">
279            <primary sortas="c-libpanelw">libpanelw</primary>
280          </indexterm>
281        </listitem>
282      </varlistentry>
283
284    </variablelist>
285
286  </sect2>
287
288</sect1>
Note: See TracBrowser for help on using the repository browser.