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