[c88cfdd] | 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 | <!ENTITY autogen-download-http "http://ftp.gnu.org/gnu/autogen/rel5.12/autogen-&autogen-version;.tar.bz2">
|
---|
| 8 | <!ENTITY autogen-download-ftp " ">
|
---|
| 9 | <!ENTITY autogen-md5sum "126e56be629cda747390e8ba9be71e4b">
|
---|
| 10 | <!ENTITY autogen-size "1.1 MB">
|
---|
| 11 | <!ENTITY autogen-buildsize "39 MB">
|
---|
| 12 | <!ENTITY autogen-time "0.5 SBU">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="autogen" xreflabel="autogen-&autogen-version;">
|
---|
| 16 | <?dbhtml filename="autogen.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>autogen-&autogen-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="autogen">
|
---|
| 26 | <primary sortas="a-autogen">autogen</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to autogen</title>
|
---|
| 31 |
|
---|
| 32 | <para><application>Autogen</application> is a tool designed to simplify the
|
---|
| 33 | creation and maintenance of programs that contain large amounts of repetitious
|
---|
| 34 | text. It is especially valuable in programs that have several blocks of text
|
---|
| 35 | that must be kept synchronized.</para>
|
---|
| 36 |
|
---|
| 37 | &lfs70_built;
|
---|
| 38 |
|
---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>Download (HTTP): <ulink url="&autogen-download-http;"/></para>
|
---|
| 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>Download (FTP): <ulink url="&autogen-download-ftp;"/></para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>Download MD5 sum: &autogen-md5sum;</para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>Download size: &autogen-size;</para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>Estimated disk space required: &autogen-buildsize;</para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>Estimated build time: &autogen-time;</para>
|
---|
| 58 | </listitem>
|
---|
| 59 | </itemizedlist>
|
---|
| 60 |
|
---|
| 61 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 62 | <itemizedlist spacing='compact'>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>Optional Patch: <ulink
|
---|
| 65 | url="&patch-root;/autogen-&autogen-version;-build_shared-1.patch"/></para>
|
---|
| 66 | </listitem>
|
---|
| 67 | </itemizedlist>
|
---|
| 68 |
|
---|
| 69 | <bridgehead renderas="sect3">autogen Dependencies</bridgehead>
|
---|
| 70 |
|
---|
| 71 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 72 | <para role="required"><xref linkend="guile"/></para>
|
---|
| 73 |
|
---|
| 74 | <para condition="html" role="usernotes">User Notes:
|
---|
| 75 | <ulink url="&blfs-wiki;/autogen"/></para>
|
---|
| 76 |
|
---|
| 77 | </sect2>
|
---|
| 78 |
|
---|
| 79 | <sect2 role="installation">
|
---|
| 80 | <title>Installation of autogen</title>
|
---|
| 81 |
|
---|
| 82 | <!-- yes, I do mean if and only if (ken) : this package is an aggravation -->
|
---|
| 83 | <para>IFF you do not wish to install the static library, and will
|
---|
| 84 | add '--enable-static=no' to the configure, apply the patch.
|
---|
| 85 | This is not recommended, but included as an example of how a common
|
---|
| 86 | option may have an unexpected implementation. The preferred
|
---|
| 87 | approach for this package is to discard the static library after
|
---|
| 88 | the package has been installed.</para>
|
---|
| 89 |
|
---|
| 90 | <screen><userinput>patch -Np1 -i ../autogen-&autogen-version;-build_shared-1.patch
|
---|
| 91 | </userinput></screen>
|
---|
| 92 |
|
---|
| 93 | <para>Install <application>autogen</application> by running the following
|
---|
| 94 | commands:</para>
|
---|
| 95 |
|
---|
| 96 | <screen><userinput>./configure --prefix=/usr &&
|
---|
| 97 | make</userinput></screen>
|
---|
| 98 |
|
---|
| 99 | <para>To test the results, issue: <command>make check</command>.
|
---|
| 100 | You can expect some failures. If you applied the patch, the
|
---|
| 101 | testsuite will fail because it is looking for the static library.</para>
|
---|
| 102 |
|
---|
| 103 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 104 |
|
---|
| 105 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 106 |
|
---|
| 107 | </sect2>
|
---|
| 108 |
|
---|
| 109 | <sect2 role="commands">
|
---|
| 110 | <title>Command Explanations</title>
|
---|
| 111 |
|
---|
| 112 | <para><command>patch -Np1 -i ...</command>: The patch modifies the
|
---|
| 113 | <filename>mk-agen-texi-in</filename> file so that it can use the shared
|
---|
| 114 | <filename>libopts.so</filename> when rebuilding the supplied documentation.
|
---|
| 115 | No doubt similar changes can be made to enable the testsuite to run in the
|
---|
| 116 | absence of the static library.</para>
|
---|
| 117 |
|
---|
| 118 | <para><option>--enable-static=no</option>: This switch prevents the static
|
---|
| 119 | library being installed. Unusually, in this package it prevents it being
|
---|
| 120 | created and used by the package itself.</para>
|
---|
| 121 |
|
---|
| 122 | </sect2>
|
---|
| 123 |
|
---|
| 124 | <sect2 role="content">
|
---|
| 125 | <title>Contents</title>
|
---|
| 126 |
|
---|
| 127 | <segmentedlist>
|
---|
| 128 | <segtitle>Installed Programs</segtitle>
|
---|
| 129 | <segtitle>Installed Library</segtitle>
|
---|
| 130 | <segtitle>Installed Directories</segtitle>
|
---|
| 131 |
|
---|
| 132 | <seglistitem>
|
---|
| 133 | <seg>autogen, autoopts-config, columns, getdefs, and xml2ag</seg>
|
---|
| 134 | <seg>libopts.{so,a}</seg>
|
---|
| 135 | <seg>/usr/{include/autoopts,share/autogen}</seg>
|
---|
| 136 | </seglistitem>
|
---|
| 137 | </segmentedlist>
|
---|
| 138 |
|
---|
| 139 | <variablelist>
|
---|
| 140 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 141 | <?dbfo list-presentation="list"?>
|
---|
| 142 | <?dbhtml list-presentation="table"?>
|
---|
| 143 |
|
---|
| 144 | <varlistentry id="autogen-prog">
|
---|
| 145 | <term><command>autogen</command></term>
|
---|
| 146 | <listitem>
|
---|
| 147 | <para>is an automated text file generator.</para>
|
---|
| 148 | <indexterm zone="autogen autogen-prog">
|
---|
| 149 | <primary sortas="b-autogen-prog">autogen-prog</primary>
|
---|
| 150 | </indexterm>
|
---|
| 151 | </listitem>
|
---|
| 152 | </varlistentry>
|
---|
| 153 |
|
---|
| 154 | <varlistentry id="autoopts-config">
|
---|
| 155 | <term><command>autoopts-config</command></term>
|
---|
| 156 | <listitem>
|
---|
| 157 | <para>does this .....</para>
|
---|
| 158 | <indexterm zone="autogen autoopts-config">
|
---|
| 159 | <primary sortas="b-autoopts-config">autoopts-config</primary>
|
---|
| 160 | </indexterm>
|
---|
| 161 | </listitem>
|
---|
| 162 | </varlistentry>
|
---|
| 163 |
|
---|
| 164 | <varlistentry id="columns">
|
---|
| 165 | <term><command>columns</command></term>
|
---|
| 166 | <listitem>
|
---|
| 167 | <para>does this .....</para>
|
---|
| 168 | <indexterm zone="autogen columns">
|
---|
| 169 | <primary sortas="b-columns">columns</primary>
|
---|
| 170 | </indexterm>
|
---|
| 171 | </listitem>
|
---|
| 172 | </varlistentry>
|
---|
| 173 |
|
---|
| 174 | <varlistentry id="getdefs">
|
---|
| 175 | <term><command>getdefs</command></term>
|
---|
| 176 | <listitem>
|
---|
| 177 | <para>does this .....</para>
|
---|
| 178 | <indexterm zone="autogen getdefs">
|
---|
| 179 | <primary sortas="b-getdefs">getdefs</primary>
|
---|
| 180 | </indexterm>
|
---|
| 181 | </listitem>
|
---|
| 182 | </varlistentry>
|
---|
| 183 |
|
---|
| 184 | <varlistentry id="xml2ag">
|
---|
| 185 | <term><command>xml2ag</command></term>
|
---|
| 186 | <listitem>
|
---|
| 187 | <para>does this .....</para>
|
---|
| 188 | <indexterm zone="autogen xml2ag">
|
---|
| 189 | <primary sortas="b-xml2ag">xml2ag</primary>
|
---|
| 190 | </indexterm>
|
---|
| 191 | </listitem>
|
---|
| 192 | </varlistentry>
|
---|
| 193 |
|
---|
| 194 | <varlistentry id="libopts">
|
---|
| 195 | <term><filename class='libraryfile'>libopts.{so,a}</filename></term>
|
---|
| 196 | <listitem>
|
---|
| 197 | <para>contains functions that .....</para>
|
---|
| 198 | <indexterm zone="autogen libopts">
|
---|
| 199 | <primary sortas="c-libopts">libopts.{so,a}</primary>
|
---|
| 200 | </indexterm>
|
---|
| 201 | </listitem>
|
---|
| 202 | </varlistentry>
|
---|
| 203 |
|
---|
| 204 | </variablelist>
|
---|
| 205 |
|
---|
| 206 | </sect2>
|
---|
| 207 |
|
---|
| 208 | </sect1>
|
---|