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