ncurses.xml 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380
  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. <sect1 id="ch-system-ncurses" role="wrap">
  8. <?dbhtml filename="ncurses.html"?>
  9. <sect1info condition="script">
  10. <productname>ncurses</productname>
  11. <productnumber>&ncurses-version;</productnumber>
  12. <address>&ncurses-url;</address>
  13. </sect1info>
  14. <title>Ncurses-&ncurses-version;</title>
  15. <indexterm zone="ch-system-ncurses">
  16. <primary sortas="a-Ncurses">Ncurses</primary>
  17. </indexterm>
  18. <sect2 role="package">
  19. <title/>
  20. <para>The Ncurses package contains libraries for terminal-independent
  21. handling of character screens.</para>
  22. <segmentedlist>
  23. <segtitle>&buildtime;</segtitle>
  24. <segtitle>&diskspace;</segtitle>
  25. <seglistitem>
  26. <seg>&ncurses-fin-sbu;</seg>
  27. <seg>&ncurses-fin-du;</seg>
  28. </seglistitem>
  29. </segmentedlist>
  30. </sect2>
  31. <sect2 role="installation">
  32. <title>Installation of Ncurses</title>
  33. <para>Don't install a static library that is not handled by configure:</para>
  34. <screen><userinput remap="pre">sed -i '/LIBTOOL_INSTALL/d' c++/Makefile.in</userinput></screen>
  35. <para>Prepare Ncurses for compilation:</para>
  36. <screen><userinput remap="configure">./configure --prefix=/usr \
  37. --mandir=/usr/share/man \
  38. --with-shared \
  39. --without-debug \
  40. --without-normal \
  41. --enable-pc-files \
  42. --enable-widec</userinput></screen>
  43. <variablelist>
  44. <title>The meaning of the new configure options:</title>
  45. <varlistentry>
  46. <term><parameter>--enable-widec</parameter></term>
  47. <listitem>
  48. <para>This switch causes wide-character libraries (e.g., <filename
  49. class="libraryfile">libncursesw.so.&ncurses-version;</filename>)
  50. to be built instead of normal ones (e.g., <filename
  51. class="libraryfile">libncurses.so.&ncurses-version;</filename>).
  52. These wide-character libraries are usable in both multibyte and
  53. traditional 8-bit locales, while normal libraries work properly
  54. only in 8-bit locales. Wide-character and normal libraries are
  55. source-compatible, but not binary-compatible.</para>
  56. </listitem>
  57. </varlistentry>
  58. <varlistentry>
  59. <term><parameter>--enable-pc-files</parameter></term>
  60. <listitem>
  61. <para>This switch generates and installs .pc files for pkg-config.
  62. </para>
  63. </listitem>
  64. </varlistentry>
  65. <varlistentry>
  66. <term><parameter>--without-normal</parameter></term>
  67. <listitem>
  68. <para>This switch disables building and installing most static libraries.
  69. </para>
  70. </listitem>
  71. </varlistentry>
  72. </variablelist>
  73. <para>Compile the package:</para>
  74. <screen><userinput remap="make">make</userinput></screen>
  75. <para>This package has a test suite, but it can only be run after the
  76. package has been installed. The tests reside in the
  77. <filename class="directory">test/</filename> directory. See the
  78. <filename>README</filename> file in that directory for further details.
  79. </para>
  80. <para>Install the package:</para>
  81. <screen><userinput remap="install">make install</userinput></screen>
  82. <para>Move the shared libraries to the
  83. <filename class="directory">/lib</filename> directory, where they are
  84. expected to reside:</para>
  85. <screen><userinput remap="install">mv -v /usr/lib/libncursesw.so.6* /lib</userinput></screen>
  86. <para>Because the libraries have been moved, one symlink points to
  87. a non-existent file. Recreate it:</para>
  88. <screen><userinput remap="install">ln -sfv ../../lib/$(readlink /usr/lib/libncursesw.so) /usr/lib/libncursesw.so</userinput></screen>
  89. <para>Many applications still expect the linker to be able to find
  90. non-wide-character Ncurses libraries. Trick such applications into linking with
  91. wide-character libraries by means of symlinks and linker scripts:</para>
  92. <screen><userinput remap="install">for lib in ncurses form panel menu ; do
  93. rm -vf /usr/lib/lib${lib}.so
  94. echo "INPUT(-l${lib}w)" &gt; /usr/lib/lib${lib}.so
  95. ln -sfv ${lib}w.pc /usr/lib/pkgconfig/${lib}.pc
  96. done</userinput></screen>
  97. <para>Finally, make sure that old applications that look for
  98. <filename class="libraryfile">-lcurses</filename> at build time are still
  99. buildable:</para>
  100. <screen><userinput remap="install">rm -vf /usr/lib/libcursesw.so
  101. echo "INPUT(-lncursesw)" &gt; /usr/lib/libcursesw.so
  102. ln -sfv libncurses.so /usr/lib/libcurses.so</userinput></screen>
  103. <para>If desired, install the Ncurses documentation:</para>
  104. <screen><userinput remap="install">mkdir -v /usr/share/doc/ncurses-&ncurses-version;
  105. cp -v -R doc/* /usr/share/doc/ncurses-&ncurses-version;</userinput></screen>
  106. <note>
  107. <para>The instructions above don't create non-wide-character Ncurses
  108. libraries since no package installed by compiling from sources would link
  109. against them at runtime. However, the only known binary-only
  110. applications that link against non-wide-character Ncurses libraries
  111. require version 5. If you must have such libraries because of some binary-only
  112. application or to be compliant with LSB, build the package again with the
  113. following commands:</para>
  114. <screen role="nodump"><userinput>make distclean
  115. ./configure --prefix=/usr \
  116. --with-shared \
  117. --without-normal \
  118. --without-debug \
  119. --without-cxx-binding \
  120. --with-abi-version=5
  121. make sources libs
  122. cp -av lib/lib*.so.5* /usr/lib</userinput></screen>
  123. </note>
  124. </sect2>
  125. <sect2 id="contents-ncurses" role="content">
  126. <title>Contents of Ncurses</title>
  127. <segmentedlist>
  128. <segtitle>Installed programs</segtitle>
  129. <segtitle>Installed libraries</segtitle>
  130. <segtitle>Installed directories</segtitle>
  131. <seglistitem>
  132. <seg>
  133. captoinfo (link to tic),
  134. clear,
  135. infocmp,
  136. infotocap (link to tic),
  137. ncursesw6-config,
  138. reset (link to tset),
  139. tabs,
  140. tic,
  141. toe,
  142. tput, and
  143. tset
  144. </seg>
  145. <seg>
  146. libcursesw.so (symlink and linker script to libncursesw.so),
  147. libformw.so,
  148. libmenuw.so,
  149. libncursesw.so,
  150. libncurses++w.a,
  151. libpanelw.so, and their non-wide-character counterparts without "w"
  152. in the library names.</seg>
  153. <seg>
  154. /usr/share/tabset,
  155. /usr/share/terminfo, and
  156. /usr/share/doc/ncurses-&ncurses-version;
  157. </seg>
  158. </seglistitem>
  159. </segmentedlist>
  160. <variablelist>
  161. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  162. <?dbfo list-presentation="list"?>
  163. <?dbhtml list-presentation="table"?>
  164. <varlistentry id="captoinfo">
  165. <term><command>captoinfo</command></term>
  166. <listitem>
  167. <para>Converts a termcap description into a terminfo description</para>
  168. <indexterm zone="ch-system-ncurses captoinfo">
  169. <primary sortas="b-captoinfo">captoinfo</primary>
  170. </indexterm>
  171. </listitem>
  172. </varlistentry>
  173. <varlistentry id="clear">
  174. <term><command>clear</command></term>
  175. <listitem>
  176. <para>Clears the screen, if possible</para>
  177. <indexterm zone="ch-system-ncurses clear">
  178. <primary sortas="b-clear">clear</primary>
  179. </indexterm>
  180. </listitem>
  181. </varlistentry>
  182. <varlistentry id="infocmp">
  183. <term><command>infocmp</command></term>
  184. <listitem>
  185. <para>Compares or prints out terminfo descriptions</para>
  186. <indexterm zone="ch-system-ncurses infocmp">
  187. <primary sortas="b-infocmp">infocmp</primary>
  188. </indexterm>
  189. </listitem>
  190. </varlistentry>
  191. <varlistentry id="infotocap">
  192. <term><command>infotocap</command></term>
  193. <listitem>
  194. <para>Converts a terminfo description into a termcap description</para>
  195. <indexterm zone="ch-system-ncurses infotocap">
  196. <primary sortas="b-infotocap">infotocap</primary>
  197. </indexterm>
  198. </listitem>
  199. </varlistentry>
  200. <varlistentry id="ncursesw6-config">
  201. <term><command>ncursesw6-config</command></term>
  202. <listitem>
  203. <para>Provides configuration information for ncurses</para>
  204. <indexterm zone="ch-system-ncurses ncursesw6-config">
  205. <primary sortas="b-ncursesw6-config">ncursesw6-config</primary>
  206. </indexterm>
  207. </listitem>
  208. </varlistentry>
  209. <varlistentry id="reset">
  210. <term><command>reset</command></term>
  211. <listitem>
  212. <para>Reinitializes a terminal to its default values</para>
  213. <indexterm zone="ch-system-ncurses reset">
  214. <primary sortas="b-reset">reset</primary>
  215. </indexterm>
  216. </listitem>
  217. </varlistentry>
  218. <varlistentry id="tabs">
  219. <term><command>tabs</command></term>
  220. <listitem>
  221. <para>Clears and sets tab stops on a terminal</para>
  222. <indexterm zone="ch-system-ncurses tabs">
  223. <primary sortas="b-tabs">tabs</primary>
  224. </indexterm>
  225. </listitem>
  226. </varlistentry>
  227. <varlistentry id="tic">
  228. <term><command>tic</command></term>
  229. <listitem>
  230. <para>The terminfo entry-description compiler that translates a
  231. terminfo file from source format into the binary format needed for the
  232. ncurses library routines [A terminfo file contains information on the
  233. capabilities of a certain terminal.]</para>
  234. <indexterm zone="ch-system-ncurses tic">
  235. <primary sortas="b-tic">tic</primary>
  236. </indexterm>
  237. </listitem>
  238. </varlistentry>
  239. <varlistentry id="toe">
  240. <term><command>toe</command></term>
  241. <listitem>
  242. <para>Lists all available terminal types, giving the primary name and
  243. description for each</para>
  244. <indexterm zone="ch-system-ncurses toe">
  245. <primary sortas="b-toe">toe</primary>
  246. </indexterm>
  247. </listitem>
  248. </varlistentry>
  249. <varlistentry id="tput">
  250. <term><command>tput</command></term>
  251. <listitem>
  252. <para>Makes the values of terminal-dependent capabilities available to
  253. the shell; it can also be used to reset or initialize a terminal or
  254. report its long name</para>
  255. <indexterm zone="ch-system-ncurses tput">
  256. <primary sortas="b-tput">tput</primary>
  257. </indexterm>
  258. </listitem>
  259. </varlistentry>
  260. <varlistentry id="tset">
  261. <term><command>tset</command></term>
  262. <listitem>
  263. <para>Can be used to initialize terminals</para>
  264. <indexterm zone="ch-system-ncurses tset">
  265. <primary sortas="b-tset">tset</primary>
  266. </indexterm>
  267. </listitem>
  268. </varlistentry>
  269. <varlistentry id="libcursesw">
  270. <term><filename class="libraryfile">libcursesw</filename></term>
  271. <listitem>
  272. <para>A link to <filename>libncursesw</filename></para>
  273. <indexterm zone="ch-system-ncurses libcursesw">
  274. <primary sortas="c-libcursesw">libcursesw</primary>
  275. </indexterm>
  276. </listitem>
  277. </varlistentry>
  278. <varlistentry id="libncursesw">
  279. <term><filename class="libraryfile">libncursesw</filename></term>
  280. <listitem>
  281. <para>Contains functions to display text in many complex ways on a
  282. terminal screen; a good example of the use of these functions is the
  283. menu displayed during the kernel's <command>make
  284. menuconfig</command></para>
  285. <indexterm zone="ch-system-ncurses libncursesw">
  286. <primary sortas="c-libncursesw">libncursesw</primary>
  287. </indexterm>
  288. </listitem>
  289. </varlistentry>
  290. <varlistentry id="libformw">
  291. <term><filename class="libraryfile">libformw</filename></term>
  292. <listitem>
  293. <para>Contains functions to implement forms</para>
  294. <indexterm zone="ch-system-ncurses libformw">
  295. <primary sortas="c-libformw">libformw</primary>
  296. </indexterm>
  297. </listitem>
  298. </varlistentry>
  299. <varlistentry id="libmenuw">
  300. <term><filename class="libraryfile">libmenuw</filename></term>
  301. <listitem>
  302. <para>Contains functions to implement menus</para>
  303. <indexterm zone="ch-system-ncurses libmenuw">
  304. <primary sortas="c-libmenuw">libmenuw</primary>
  305. </indexterm>
  306. </listitem>
  307. </varlistentry>
  308. <varlistentry id="libpanelw">
  309. <term><filename class="libraryfile">libpanelw</filename></term>
  310. <listitem>
  311. <para>Contains functions to implement panels</para>
  312. <indexterm zone="ch-system-ncurses libpanelw">
  313. <primary sortas="c-libpanelw">libpanelw</primary>
  314. </indexterm>
  315. </listitem>
  316. </varlistentry>
  317. </variablelist>
  318. </sect2>
  319. </sect1>