source: final-system/common/texinfo.xml@ ee3f926

Last change on this file since ee3f926 was 60fe836, checked in by Chris Staub <chris@…>, 18 years ago

Removed references to TeX

  • Property mode set to 100644
File size: 5.4 KB
RevLine 
[bf8c11f]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
[e6423a01]35<screen os="b"><userinput>./configure --prefix=/usr</userinput></screen>
[bf8c11f]36
[e6423a01]37 <para os="c">Compile the package:</para>
[bf8c11f]38
[e6423a01]39<screen os="d"><userinput>make</userinput></screen>
[bf8c11f]40
[e6423a01]41 <para os="e">To test the results, issue:
[bf8c11f]42 <userinput>make check</userinput>.</para>
43
[e6423a01]44 <para os="f">Install the package:</para>
[bf8c11f]45
[e6423a01]46<screen os="g"><userinput>make install</userinput></screen>
[bf8c11f]47
[60fe836]48 <para os="h">The Info documentation system uses a plain text file to hold
[bf8c11f]49 its list of menu entries. The file is located at
50 <filename>/usr/share/info/dir</filename>. Unfortunately, due to occasional
51 problems in the Makefiles of various packages, it can sometimes get out of
52 sync with the info pages installed on the system. If the
53 <filename>/usr/share/info/dir</filename> file ever needs to be recreated,
54 the following optional commands will accomplish the task:</para>
55
[60fe836]56<screen os="i" role="nodump"><userinput>cd /usr/share/info
[bf8c11f]57rm dir
58for f in *
59do install-info $f dir 2&gt;/dev/null
60done</userinput></screen>
61
62 </sect2>
63
64 <sect2 id="contents-texinfo" role="content">
65 <title>Contents of Texinfo</title>
66
67 <segmentedlist>
68 <segtitle>Installed programs</segtitle>
69
70 <seglistitem>
71 <seg>info, infokey, install-info, makeinfo, texi2dvi, texi2pdf,
72 and texindex</seg>
73 </seglistitem>
74 </segmentedlist>
75
76 <variablelist>
77 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
78 <?dbfo list-presentation="list"?>
79 <?dbhtml list-presentation="table"?>
80
81 <varlistentry id="info">
82 <term><command>info</command></term>
83 <listitem>
84 <para>Used to read info pages which are similar to man
85 pages, but often go much deeper than just explaining all the command
86 line options. For example, compare <command>man bison</command> and
87 <command>info bison</command>.</para>
88 <indexterm zone="ch-system-texinfo info">
89 <primary sortas="b-info">info</primary>
90 </indexterm>
91 </listitem>
92 </varlistentry>
93
94 <varlistentry id="infokey">
95 <term><command>infokey</command></term>
96 <listitem>
97 <para>Compiles a source file containing Info customizations into a
98 binary format</para>
99 <indexterm zone="ch-system-texinfo infokey">
100 <primary sortas="b-infokey">infokey</primary>
101 </indexterm>
102 </listitem>
103 </varlistentry>
104
105 <varlistentry id="install-info">
106 <term><command>install-info</command></term>
107 <listitem>
108 <para>Used to install info pages; it updates entries in the
109 <command>info</command> index file</para>
110 <indexterm zone="ch-system-texinfo install-info">
111 <primary sortas="b-install-info">install-info</primary>
112 </indexterm>
113 </listitem>
114 </varlistentry>
115
116 <varlistentry id="makeinfo">
117 <term><command>makeinfo</command></term>
118 <listitem>
119 <para>Translates the given Texinfo source documents into
120 info pages, plain text, or HTML</para>
121 <indexterm zone="ch-system-texinfo makeinfo">
122 <primary sortas="b-makeinfo">makeinfo</primary>
123 </indexterm>
124 </listitem>
125 </varlistentry>
126
127 <varlistentry id="texi2dvi">
128 <term><command>texi2dvi</command></term>
129 <listitem>
130 <para>Used to format the given Texinfo document into a
131 device-independent file that can be printed</para>
132 <indexterm zone="ch-system-texinfo texi2dvi">
133 <primary sortas="b-texi2dvi">texi2dvi</primary>
134 </indexterm>
135 </listitem>
136 </varlistentry>
137
138 <varlistentry id="texi2pdf">
139 <term><command>texi2pdf</command></term>
140 <listitem>
141 <para>Used to format the given Texinfo document into a
142 Portable Document Format (PDF) file</para>
143 <indexterm zone="ch-system-texinfo texi2pdf">
144 <primary sortas="b-texi2pdf">texi2pdf</primary>
145 </indexterm>
146 </listitem>
147 </varlistentry>
148
149 <varlistentry id="texindex">
150 <term><command>texindex</command></term>
151 <listitem>
152 <para>Used to sort Texinfo index files</para>
153 <indexterm zone="ch-system-texinfo texindex">
154 <primary sortas="b-texindex">texindex</primary>
155 </indexterm>
156 </listitem>
157 </varlistentry>
158
159 </variablelist>
160
161 </sect2>
162
163</sect1>
Note: See TracBrowser for help on using the repository browser.