source: BOOK/final-system/common/texinfo.xml @ 8c09b88

clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since 8c09b88 was 8c09b88, checked in by Chris Staub <chris@…>, 10 years ago

Updated installed program lists

  • Property mode set to 100644
File size: 5.6 KB
Line 
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
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="a">Prepare Texinfo for compilation:</para>
29
30<screen os="b"><userinput>./configure --prefix=/usr</userinput></screen>
31
32    <para os="c">Compile the package:</para>
33
34<screen os="d"><userinput>make</userinput></screen>
35
36    <para os="e">To test the results, issue:
37    <userinput>make check</userinput>.</para>
38
39    <para os="f">Install the package:</para>
40
41<screen os="g"><userinput>make install</userinput></screen>
42
43    <para os="h">The Info documentation system uses a plain text file to hold
44    its list of menu entries. The file is located at
45    <filename>/usr/share/info/dir</filename>. Unfortunately, due to occasional
46    problems in the Makefiles of various packages, it can sometimes get out of
47    sync with the info pages installed on the system. If the
48    <filename>/usr/share/info/dir</filename> file ever needs to be recreated,
49    the following optional commands will accomplish the task:</para>
50
51<screen os="i" role="nodump"><userinput>pushd /usr/share/info
52rm dir
53for f in *
54do install-info $f dir 2&gt;/dev/null
55done
56popd</userinput></screen>
57
58  </sect2>
59
60  <sect2 id="contents-texinfo" role="content">
61    <title>Contents of Texinfo</title>
62
63    <segmentedlist>
64      <segtitle>Installed programs</segtitle>
65      <segtitle>Installed directory</segtitle>
66
67      <seglistitem>
68        <seg>info, infokey, install-info, makeinfo (link to texi2any),
69        pdftexi2dvi, texi2dvi, texi2pdf, and texindex</seg>
70        <seg>/usr/share/texinfo</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="pdftexi2dvi">
126        <term><command>pdftexi2dvi</command></term>
127        <listitem>
128          <para>Shell script that run <command>texi2dvi --pdf</command></para>
129          <indexterm zone="ch-system-texinfo pdftexi2dvi">
130            <primary sortas="b-pdftexi2dvi">pdftexi2dvi</primary>
131          </indexterm>
132        </listitem>
133      </varlistentry>
134
135      <varlistentry id="texi2dvi">
136        <term><command>texi2dvi</command></term>
137        <listitem>
138          <para>Used to format the given Texinfo document into a
139          device-independent file that can be printed</para>
140          <indexterm zone="ch-system-texinfo texi2dvi">
141            <primary sortas="b-texi2dvi">texi2dvi</primary>
142          </indexterm>
143        </listitem>
144      </varlistentry>
145
146      <varlistentry id="texi2pdf">
147        <term><command>texi2pdf</command></term>
148        <listitem>
149          <para>Used to format the given Texinfo document into a
150          Portable Document Format (PDF) file</para>
151          <indexterm zone="ch-system-texinfo texi2pdf">
152            <primary sortas="b-texi2pdf">texi2pdf</primary>
153          </indexterm>
154        </listitem>
155      </varlistentry>
156
157      <varlistentry id="texindex">
158        <term><command>texindex</command></term>
159        <listitem>
160          <para>Used to sort Texinfo index files</para>
161          <indexterm zone="ch-system-texinfo texindex">
162            <primary sortas="b-texindex">texindex</primary>
163          </indexterm>
164        </listitem>
165      </varlistentry>
166
167    </variablelist>
168
169  </sect2>
170
171</sect1>
Note: See TracBrowser for help on using the repository browser.