[673b0d8] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[1fe35e1] | 2 | <!DOCTYPE section [
|
---|
[673b0d8] | 3 | <!ENTITY % general-entities SYSTEM "../general.ent">
|
---|
| 4 | %general-entities;
|
---|
| 5 | ]>
|
---|
[1fe35e1] | 6 | <section xmlns="http://docbook.org/docbook-ng"
|
---|
| 7 | xml:id="ch-system-texinfo" xreflabel="Texinfo" role="wrap">
|
---|
[6a0e6f3] | 8 | <title>Texinfo-&texinfo-version;</title>
|
---|
[673b0d8] | 9 | <?dbhtml filename="texinfo.html"?>
|
---|
| 10 |
|
---|
| 11 | <indexterm zone="ch-system-texinfo"><primary sortas="a-Texinfo">Texinfo</primary></indexterm>
|
---|
[6370fa6] | 12 |
|
---|
[6a0e6f3] | 13 | <section role="package"><title/>
|
---|
[5888299] | 14 | <para>The Texinfo package contains programs for reading, writing, and
|
---|
| 15 | converting Info documents.</para>
|
---|
| 16 |
|
---|
[a001133] | 17 | <segmentedlist>
|
---|
| 18 | <segtitle>&buildtime;</segtitle>
|
---|
| 19 | <segtitle>&diskspace;</segtitle>
|
---|
| 20 | <seglistitem><seg>0.2 SBU</seg><seg>17 MB</seg></seglistitem>
|
---|
| 21 | </segmentedlist>
|
---|
[673b0d8] | 22 |
|
---|
[a001133] | 23 | <segmentedlist>
|
---|
| 24 | <segtitle>Texinfo installation depends on</segtitle>
|
---|
| 25 | <seglistitem><seg>Bash, Binutils, Coreutils,
|
---|
| 26 | Diffutils, GCC, Gettext, Glibc, Grep, Make, Ncurses, Sed</seg></seglistitem>
|
---|
| 27 | </segmentedlist>
|
---|
[1fe35e1] | 28 | </section>
|
---|
[3554fa3a] | 29 |
|
---|
[1fe35e1] | 30 | <section role="installation">
|
---|
[6a0e6f3] | 31 | <title>Installation of Texinfo</title>
|
---|
[73aedd1d] | 32 |
|
---|
| 33 | <para>Prepare Texinfo for compilation:</para>
|
---|
| 34 |
|
---|
[2ca7e114] | 35 | <para>The patch listed below fixes a known segfault in texinfo:</para>
|
---|
| 36 |
|
---|
| 37 | <screen><userinput>patch -Np1 -i ../texinfo-&texinfo-version;-segfault-1.patch</userinput></screen>
|
---|
| 38 |
|
---|
| 39 | <para>Prepare Texinfo for compilation:</para>
|
---|
| 40 |
|
---|
[73aedd1d] | 41 | <screen><userinput>./configure --prefix=/usr</userinput></screen>
|
---|
| 42 |
|
---|
| 43 | <para>Compile the package:</para>
|
---|
| 44 |
|
---|
| 45 | <screen><userinput>make</userinput></screen>
|
---|
| 46 |
|
---|
[673b0d8] | 47 | <para>To test the results, issue:
|
---|
[8a5f906] | 48 | <userinput>make check</userinput>.</para>
|
---|
[73aedd1d] | 49 |
|
---|
| 50 | <para>Install the package:</para>
|
---|
| 51 |
|
---|
| 52 | <screen><userinput>make install</userinput></screen>
|
---|
| 53 |
|
---|
[673b0d8] | 54 | <para>Optionally install the components belonging in a TeX installation:</para>
|
---|
[73aedd1d] | 55 |
|
---|
| 56 | <screen><userinput>make TEXMF=/usr/share/texmf install-tex</userinput></screen>
|
---|
| 57 |
|
---|
[5763f675] | 58 | <para>The meaning of the make parameter:</para>
|
---|
[73aedd1d] | 59 |
|
---|
[df8334f] | 60 | <variablelist>
|
---|
| 61 | <varlistentry>
|
---|
[8ad7980] | 62 | <term><parameter>TEXMF=/usr/share/texmf</parameter></term>
|
---|
[df8334f] | 63 | <listitem><para>The TEXMF
|
---|
[73aedd1d] | 64 | makefile variable holds the location of the root of your TeX tree if, for
|
---|
| 65 | example, you plan to install a TeX package later on.</para></listitem>
|
---|
[df8334f] | 66 | </varlistentry>
|
---|
| 67 | </variablelist>
|
---|
[73aedd1d] | 68 |
|
---|
[554b366] | 69 | <para>The Info documentation system uses a plain text file to hold its list of
|
---|
| 70 | menu entries. The file is located at <filename>/usr/share/info/dir</filename>.
|
---|
| 71 | Unfortunately, due to occasional problems in the Makefiles of various packages,
|
---|
| 72 | it can sometimes get out of step with the Info manuals actually installed on the
|
---|
| 73 | system. If ever you need to recreate the
|
---|
| 74 | <filename>/usr/share/info/dir</filename> file, the following optional commands
|
---|
| 75 | will accomplish the task:</para>
|
---|
| 76 |
|
---|
| 77 | <screen><userinput>cd /usr/share/info
|
---|
| 78 | rm dir
|
---|
| 79 | for f in *
|
---|
[673b0d8] | 80 | do install-info $f dir 2>/dev/null
|
---|
[554b366] | 81 | done</userinput></screen>
|
---|
| 82 |
|
---|
[1fe35e1] | 83 | </section>
|
---|
[6370fa6] | 84 |
|
---|
[5888299] | 85 |
|
---|
[6a0e6f3] | 86 | <section xml:id="contents-texinfo" role="content"><title>Contents of Texinfo</title>
|
---|
[673b0d8] | 87 |
|
---|
[c6cb3aa] | 88 | <segmentedlist>
|
---|
| 89 | <segtitle>Installed programs</segtitle>
|
---|
| 90 | <seglistitem><seg>info, infokey, install-info,
|
---|
| 91 | makeinfo, texi2dvi and texindex</seg></seglistitem>
|
---|
| 92 | </segmentedlist>
|
---|
[673b0d8] | 93 |
|
---|
[c6cb3aa] | 94 | <variablelist><title>Short descriptions</title>
|
---|
[673b0d8] | 95 |
|
---|
[1fe35e1] | 96 | <varlistentry xml:id="info">
|
---|
[b8a819f] | 97 | <term><command>info</command></term>
|
---|
[c6cb3aa] | 98 | <listitem>
|
---|
[673b0d8] | 99 | <indexterm zone="ch-system-texinfo info"><primary sortas="b-info">info</primary></indexterm>
|
---|
[c6cb3aa] | 100 | <para>is used to read Info documents. Info
|
---|
[673b0d8] | 101 | documents are a bit like man pages, but often go much deeper than just
|
---|
[8ad7980] | 102 | explaining all the flags. Compare for example <command>man tar</command>
|
---|
| 103 | and <command>info tar</command>.</para>
|
---|
[c6cb3aa] | 104 | </listitem>
|
---|
| 105 | </varlistentry>
|
---|
[673b0d8] | 106 |
|
---|
[1fe35e1] | 107 | <varlistentry xml:id="infokey">
|
---|
[b8a819f] | 108 | <term><command>infokey</command></term>
|
---|
[c6cb3aa] | 109 | <listitem>
|
---|
[673b0d8] | 110 | <indexterm zone="ch-system-texinfo infokey"><primary sortas="b-infokey">infokey</primary></indexterm>
|
---|
[c6cb3aa] | 111 | <para>compiles a source file containing Info
|
---|
[673b0d8] | 112 | customizations into a binary format.</para>
|
---|
[c6cb3aa] | 113 | </listitem>
|
---|
| 114 | </varlistentry>
|
---|
[73aedd1d] | 115 |
|
---|
[1fe35e1] | 116 | <varlistentry xml:id="install-info">
|
---|
[b8a819f] | 117 | <term><command>install-info</command></term>
|
---|
[c6cb3aa] | 118 | <listitem>
|
---|
[673b0d8] | 119 | <indexterm zone="ch-system-texinfo install-info"><primary sortas="b-install-info">install-info</primary></indexterm>
|
---|
[c6cb3aa] | 120 | <para>is used to install Info files. It updates entries in the Info index file.</para>
|
---|
| 121 | </listitem>
|
---|
| 122 | </varlistentry>
|
---|
[673b0d8] | 123 |
|
---|
[1fe35e1] | 124 | <varlistentry xml:id="makeinfo">
|
---|
[b8a819f] | 125 | <term><command>makeinfo</command></term>
|
---|
[c6cb3aa] | 126 | <listitem>
|
---|
[673b0d8] | 127 | <indexterm zone="ch-system-texinfo makeinfo"><primary sortas="b-makeinfo">makeinfo</primary></indexterm>
|
---|
[c6cb3aa] | 128 | <para>translates the given Texinfo source
|
---|
[673b0d8] | 129 | documents into various other formats: Info files, plain text, or HTML.</para>
|
---|
[c6cb3aa] | 130 | </listitem>
|
---|
| 131 | </varlistentry>
|
---|
[673b0d8] | 132 |
|
---|
[1fe35e1] | 133 | <varlistentry xml:id="texi2dvi">
|
---|
[b8a819f] | 134 | <term><command>texi2dvi</command></term>
|
---|
[c6cb3aa] | 135 | <listitem>
|
---|
[673b0d8] | 136 | <indexterm zone="ch-system-texinfo texi2dvi"><primary sortas="b-texi2dvi">texi2dvi</primary></indexterm>
|
---|
[c6cb3aa] | 137 | <para>is used to format the given Texinfo
|
---|
[673b0d8] | 138 | document into a device-independent file that can be printed.</para>
|
---|
[c6cb3aa] | 139 | </listitem>
|
---|
| 140 | </varlistentry>
|
---|
[673b0d8] | 141 |
|
---|
[1fe35e1] | 142 | <varlistentry xml:id="texindex">
|
---|
[b8a819f] | 143 | <term><command>texindex</command></term>
|
---|
[c6cb3aa] | 144 | <listitem>
|
---|
[673b0d8] | 145 | <indexterm zone="ch-system-texinfo texindex"><primary sortas="b-texindex">texindex</primary></indexterm>
|
---|
[c6cb3aa] | 146 | <para>is used to sort Texinfo index files.</para>
|
---|
| 147 | </listitem>
|
---|
| 148 | </varlistentry>
|
---|
| 149 | </variablelist>
|
---|
[673b0d8] | 150 |
|
---|
[1fe35e1] | 151 | </section>
|
---|
[673b0d8] | 152 |
|
---|
[1fe35e1] | 153 | </section>
|
---|