source: clfs-sysroot/BOOK/final-system/common/texinfo.xml@ cc400ad

Last change on this file since cc400ad was 51cbbb6, checked in by Joe Ciccone <jciccone@…>, 18 years ago

Removed references to TeX.

  • Property mode set to 100644
File size: 5.3 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6]>
7
8<sect1 id="ch-system-texinfo" role="wrap">
9 <?dbhtml filename="texinfo.html"?>
10
11 <title>Texinfo-&texinfo-version;</title>
12
13 <indexterm zone="ch-system-texinfo">
14 <primary sortas="a-Texinfo">Texinfo</primary>
15 </indexterm>
16
17 <sect2 role="package">
18 <title/>
19
20 <para>The Texinfo package contains programs for reading, writing, and
21 converting info pages.</para>
22
23 </sect2>
24
25 <sect2 role="installation">
26 <title>Installation of Texinfo</title>
27
28 <para os="p1">Texinfo allows local users to overwrite arbitrary files via a symlink
29 attack on temporary files. Apply the following patch to fix this:</para>
30
31<screen os="p2"><userinput>patch -Np1 -i ../&texinfo-tempfile_fix-patch;</userinput></screen>
32
33 <para os="a">Prepare Texinfo for compilation:</para>
34
35<screen os="b"><userinput>./configure --build=${CLFS_HOST} --host=${CLFS_TARGET} \
36 --prefix=/usr</userinput></screen>
37
38 <para os="c">Compile the package:</para>
39
40<screen os="d"><userinput>make</userinput></screen>
41
42 <para os="e">Install the package:</para>
43
44<screen os="f"><userinput>make DESTDIR=${CLFS} install</userinput></screen>
45
46 <para os="g">The Info documentation system uses a plain text file to hold
47 its list of menu entries. The file is located at
48 <filename>/usr/share/info/dir</filename>. Unfortunately, due to occasional
49 problems in the Makefiles of various packages, it can sometimes get out of
50 sync with the info pages installed on the system. If the
51 <filename>/usr/share/info/dir</filename> file ever needs to be recreated,
52 the following optional commands will accomplish the task:</para>
53
54<screen os="h" role="nodump"><userinput>cd ${CLFS}/usr/share/info
55rm dir
56for f in *
57do install-info ${f} dir 2&gt;/dev/null
58done</userinput></screen>
59
60 </sect2>
61
62 <sect2 id="contents-texinfo" role="content">
63 <title>Contents of Texinfo</title>
64
65 <segmentedlist>
66 <segtitle>Installed programs</segtitle>
67
68 <seglistitem>
69 <seg>info, infokey, install-info, makeinfo, texi2dvi, texi2pdf,
70 and texindex</seg>
71 </seglistitem>
72 </segmentedlist>
73
74 <variablelist>
75 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
76 <?dbfo list-presentation="list"?>
77 <?dbhtml list-presentation="table"?>
78
79 <varlistentry id="info">
80 <term><command>info</command></term>
81 <listitem>
82 <para>Used to read info pages which are similar to man
83 pages, but often go much deeper than just explaining all the command
84 line options. For example, compare <command>man bison</command> and
85 <command>info bison</command>.</para>
86 <indexterm zone="ch-system-texinfo info">
87 <primary sortas="b-info">info</primary>
88 </indexterm>
89 </listitem>
90 </varlistentry>
91
92 <varlistentry id="infokey">
93 <term><command>infokey</command></term>
94 <listitem>
95 <para>Compiles a source file containing Info customizations into a
96 binary format</para>
97 <indexterm zone="ch-system-texinfo infokey">
98 <primary sortas="b-infokey">infokey</primary>
99 </indexterm>
100 </listitem>
101 </varlistentry>
102
103 <varlistentry id="install-info">
104 <term><command>install-info</command></term>
105 <listitem>
106 <para>Used to install info pages; it updates entries in the
107 <command>info</command> index file</para>
108 <indexterm zone="ch-system-texinfo install-info">
109 <primary sortas="b-install-info">install-info</primary>
110 </indexterm>
111 </listitem>
112 </varlistentry>
113
114 <varlistentry id="makeinfo">
115 <term><command>makeinfo</command></term>
116 <listitem>
117 <para>Translates the given Texinfo source documents into
118 info pages, plain text, or HTML</para>
119 <indexterm zone="ch-system-texinfo makeinfo">
120 <primary sortas="b-makeinfo">makeinfo</primary>
121 </indexterm>
122 </listitem>
123 </varlistentry>
124
125 <varlistentry id="texi2dvi">
126 <term><command>texi2dvi</command></term>
127 <listitem>
128 <para>Used to format the given Texinfo document into a
129 device-independent file that can be printed</para>
130 <indexterm zone="ch-system-texinfo texi2dvi">
131 <primary sortas="b-texi2dvi">texi2dvi</primary>
132 </indexterm>
133 </listitem>
134 </varlistentry>
135
136 <varlistentry id="texi2pdf">
137 <term><command>texi2pdf</command></term>
138 <listitem>
139 <para>Used to format the given Texinfo document into a
140 Portable Document Format (PDF) file</para>
141 <indexterm zone="ch-system-texinfo texi2pdf">
142 <primary sortas="b-texi2pdf">texi2pdf</primary>
143 </indexterm>
144 </listitem>
145 </varlistentry>
146
147 <varlistentry id="texindex">
148 <term><command>texindex</command></term>
149 <listitem>
150 <para>Used to sort Texinfo index files</para>
151 <indexterm zone="ch-system-texinfo texindex">
152 <primary sortas="b-texindex">texindex</primary>
153 </indexterm>
154 </listitem>
155 </varlistentry>
156
157 </variablelist>
158
159 </sect2>
160
161</sect1>
Note: See TracBrowser for help on using the repository browser.