source: BOOK/final-system/common/ncurses.xml @ 8c4638c

systemd
Last change on this file since 8c4638c was 8c4638c, checked in by Chris Staub <chris@…>, 4 years ago

Removed libcurses symlinks from Ncurses pages

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