aboutsummaryrefslogtreecommitdiffstats
path: root/appendixa/ncurses-desc.xml
diff options
context:
space:
mode:
authorMark Hymers <markh@linuxfromscratch.org>2002-02-06 23:15:46 +0000
committerMark Hymers <markh@linuxfromscratch.org>2002-02-06 23:15:46 +0000
commitbdc08c1c6419be50edb433c4425481bdabf8a5ea (patch)
treeb93620a39c60088e399ecfd4cfb667a62ea0ec21 /appendixa/ncurses-desc.xml
parent76c0b783eeb766c0dec8e66dab2e6c275ba0786d (diff)
[Bug 190] reorganise and sync descriptions
git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@1549 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689
Diffstat (limited to 'appendixa/ncurses-desc.xml')
-rw-r--r--appendixa/ncurses-desc.xml100
1 files changed, 66 insertions, 34 deletions
diff --git a/appendixa/ncurses-desc.xml b/appendixa/ncurses-desc.xml
index 51a498a60..d91d57b65 100644
--- a/appendixa/ncurses-desc.xml
+++ b/appendixa/ncurses-desc.xml
@@ -1,52 +1,84 @@
-<sect2>
-<title>Contents</title>
+<sect2><title>Contents</title>
-<para>The Ncurses package contains the ncurses, panel, menu and form
-libraries. It also contains the clear, infocmp, tic, toe, tput and tset
-programs.</para>
+<sect3><title>Program Files</title>
+<para>captoinfo (link to tic), clear, infocmp, infotocap (link to tic),
+reset (link to tset), tack, tic, toe, tput and tset.</para></sect3>
-</sect2>
-
-<sect2><title>Description</title>
+<sect3><title>Descriptions</title>
-<sect3><title>The libraries</title>
-<para>The libraries that make up the Ncurses library are used to display text
-(often in a fancy way) on the screen. An example where ncurses is used
-is in the kernel's <quote>make menuconfig</quote> process. The libraries
-contain routines to create panels, menu's, form and general text display
-routines.</para></sect3>
+<sect4><title>captoinfo</title>
+<para>captoinfo converts a termcap description into a terminfo
+description.</para></sect4>
-<sect3><title>clear</title>
-<para>The clear program clears the screen if this is possible. It looks in
+<sect4><title>clear</title>
+<para>clear clears the screen if this is possible. It looks in
the environment for the terminal type and then in the terminfo database
-to figure out how to clear the screen.</para></sect3>
+to figure out how to clear the screen.</para></sect4>
-<sect3><title>infocmp</title>
-<para>The infocmp program can be used to compare a binary terminfo entry with
+<sect4><title>infocmp</title>
+<para>infocmp can be used to compare a binary terminfo entry with
other terminfo entries, rewrite a terminfo description to
take advantage of the use= terminfo field, or print out a
terminfo description from the binary file (term) in a variety of
-formats (the opposite of what tic does).</para></sect3>
+formats (the opposite of what tic does).</para></sect4>
+
+<sect4><title>infotocap</title>
+<para>info to cap converts a terminfo description into a termcap
+description.</para></sect4>
+
+<sect4><title>reset</title>
+<para>reset sets cooked and echo modes, turns off cbreak and raw modes,
+turns on new-line translation and resets any unset special characters to
+their default values before doing terminal initialization the same way
+as tset.</para></sect4>
-<sect3><title>tic</title>
-<para>Tic is the terminfo entry-description compiler. The program translates a
+<sect4><title>tack</title>
+<para>tack is the terminfo action checker.</para></sect4>
+
+<sect4><title>tic</title>
+<para>tic is the terminfo entry-description compiler. The program translates a
terminfo file from source format into the binary format for use with the
ncurses library routines. Terminfo files contain information about the
-capabilities of a terminal.</para></sect3>
+capabilities of a terminal.</para></sect4>
-<sect3><title>toe</title>
-<para>The toe program lists all available terminal types by primary name with
-descriptions.</para></sect3>
+<sect4><title>toe</title>
+<para>toe lists all available terminal types by primary name with
+descriptions.</para></sect4>
-<sect3><title>tput</title>
-<para>The tput program uses the terminfo database to make the values of
-terminal-dependent capabilities and information available to the shell,
+<sect4><title>tput</title>
+<para>tput uses the terminfo database to make the values of
+terminal-dependent capabilities and information available to the shell,
to initialize or reset the terminal, or return the long name of the
-requested terminal type.</para></sect3>
+requested terminal type.</para></sect4>
-<sect3><title>tset</title>
-<para>The Tset program initializes terminals so they can be used, but it's not
-widely used anymore. It's provided for 4.4BSD compatibility.</para></sect3>
+<sect4><title>tset</title>
+<para>tset initializes terminals so they can be used, but it's not
+widely used anymore. It's provided for 4.4BSD compatibility.</para></sect4>
-</sect2>
+</sect3>
+
+<sect3><title>Library Files</title>
+<para>libcurses.[a,so] (link to libncurses.[a,so]), libform.[a,so],
+libform_g.a, libmenu.[a,so], libmenu_g.a, libncurses++.a,
+libncurses.[a,so], libncurses_g.a, libpanel.[a,so] and
+libpanel_g.a</para>
+<sect4><title>libcurses.[a,so], libncurses++.a, libncurses.[a,so],
+libncurses_g.a</title>
+<para>The libraries that make up the Ncurses library are used to display
+text (often in a fancy way) on the screen. An example where ncurses is used
+is in the kernel's <quote>make menuconfig</quote> process. The
+libncurses libraries are the base of the system.</para></sect4>
+
+<sect4><title>libform.[a,so], libform_g.a</title>
+<para>libform is used to implement forms in ncurses.</para></sect4>
+
+<sect4><title>libmenu.[a,so], libmenu_g.a</title>
+<para>libmenu is used to implement menus in ncurses.</para></sect4>
+
+<sect4><title>libpanel.[a,so], libpanel_g.a</title>
+<para>libpanel is used to implement panels in ncurses.</para></sect4>
+
+</sect3>
+
+</sect2>