chapter06/m4.xml

   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-m4" role="wrap">
   9   <?dbhtml filename="m4.html"?>
  10
  11   <sect1info condition="script">
  12     <productname>m4</productname>
  13     <productnumber>&m4-version;</productnumber>
  14     <address>&m4-url;</address>
  15   </sect1info>
  16
  17   <title>M4-&m4-version;</title>
  18
  19   <indexterm zone="ch-system-m4">
  20     <primary sortas="a-M4">M4</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>The M4 package contains a macro processor.</para>
  27
  28     <segmentedlist>
  29       <segtitle>&buildtime;</segtitle>
  30       <segtitle>&diskspace;</segtitle>
  31
  32       <seglistitem>
  33         <seg>&m4-ch6-sbu;</seg>
  34         <seg>&m4-ch6-du;</seg>
  35       </seglistitem>
  36     </segmentedlist>
  37
  38   </sect2>
  39
  40   <sect2 role="installation">
  41     <title>Installation of M4</title>
  42
  43     <para>Prepare M4 for compilation:</para>
  44
  45 <screen><userinput remap="configure">./configure --prefix=/usr</userinput></screen>
  46
  47     <para>Compile the package:</para>
  48
  49 <screen><userinput remap="make">make</userinput></screen>
  50
  51     <para>To test the results, issue:</para>
  52
  53 <screen><userinput remap="test">make check</userinput></screen>
  54
  55     <para>Install the package:</para>
  56
  57 <screen><userinput remap="install">make install</userinput></screen>
  58
  59   </sect2>
  60
  61   <sect2 id="contents-m4" role="content">
  62     <title>Contents of M4</title>
  63
  64     <segmentedlist>
  65       <segtitle>Installed program</segtitle>
  66
  67       <seglistitem>
  68         <seg>m4</seg>
  69       </seglistitem>
  70     </segmentedlist>
  71
  72     <variablelist>
  73       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  74       <?dbfo list-presentation="list"?>
  75       <?dbhtml list-presentation="table"?>
  76
  77       <varlistentry id="m4">
  78          <!-- Don't remove the extra space, it prevet a FOP warning. -->
  79         <term><command>m4 </command></term>
  80         <listitem>
  81           <para>Copies the given files while expanding the macros that they
  82           contain [These macros are either built-in or user-defined and can
  83           take any number of arguments. Besides performing macro expansion,
  84           <command>m4</command> has built-in functions for including named
  85           files, running Unix commands, performing integer arithmetic,
  86           manipulating text, recursion, etc. The <command>m4</command> program
  87           can be used either as a front-end to a compiler or as a macro processor
  88           in its own right.]</para>
  89           <indexterm zone="ch-system-m4 m4">
  90             <primary sortas="b-m4">m4</primary>
  91           </indexterm>
  92         </listitem>
  93       </varlistentry>
  94
  95     </variablelist>
  96
  97   </sect2>
  98
  99 </sect1>