source: general/prog/nasm.xml@ dafa0dc

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY NASM-download-http "http://prdownloads.sourceforge.net/nasm/nasm-&NASM-version;.tar.bz2">
  <!ENTITY NASM-download-ftp " ">
  <!ENTITY NASM-md5sum "2032ad44c7359f7a9a166a40a633e772">
  <!ENTITY NASM-size "543 KB">
  <!ENTITY NASM-buildsize "17.3 MB (includes building and installing all docs)">
  <!ENTITY NASM-time "0.2 SBU">
]>

<sect1 id="NASM" xreflabel="NASM-&NASM-version;">
  <?dbhtml filename="NASM.html" ?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>NASM-&NASM-version;</title>

  <indexterm zone="NASM">
    <primary sortas="a-NASM">NASM</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to NASM</title>

    <para><application>NASM</application> (Netwide Assembler)
    is an 80x86 assembler designed for portability and modularity. It includes a
    disassembler as well.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&NASM-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&NASM-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &NASM-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &NASM-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &NASM-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &NASM-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem> 
        <para>Required patch to fix a buffer overrun vulnerability: <ulink
        url="&patch-root;/nasm-&NASM-version;-security_fix-1.patch"/></para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">NASM Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional (for Building Documentation)</bridgehead>
    <para><xref linkend="tex"/>, and
    <xref linkend="espgs"/> or <xref linkend="gs"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of NASM</title>

    <para>Install <application>NASM</application> by running
    the following commands:</para>

<screen><userinput>patch -Np1 -i ../nasm-&NASM-version;-security_fix-1.patch &amp;&amp;
./configure --prefix=/usr &amp;&amp;
make &amp;&amp;
make -C rdoff/doc &amp;&amp;
make -C rdoff/doc html</userinput></screen>

    <para>To build the base <application>NASM</application> documentation,
    ensure you have <application>Ghostscript</application> installed and issue:</para>

<screen><userinput>make doc</userinput></screen>

    <para>To build the RDOFF Postscript documentation,
    ensure you have <xref linkend="tex"/> installed and issue:</para>

<screen><userinput>sed -i -e "s/dvips \$&lt;/&amp; -o rdoff.ps/" rdoff/doc/Makefile &amp;&amp;
make -C rdoff/doc ps</userinput></screen>

    <para>To build the RDOFF PDF documentation, ensure you have
    <application>Ghostscript</application> installed and issue:</para>

<screen><userinput>make -C rdoff/doc pdf</userinput></screen>

    <para>This package does not come with a test suite.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install &amp;&amp;
make install_rdf &amp;&amp;
install -v -m644 rdoff/doc/rdoff.info /usr/share/info &amp;&amp;
install -v -m755 -d /usr/share/doc/nasm/html &amp;&amp;
install -v -m644 rdoff/doc/v1-v2.txt /usr/share/doc/nasm &amp;&amp;
cp -v -R rdoff/doc/rdoff /usr/share/doc/nasm/html</userinput></screen>

    <para>If you built the <application>Ghostscript</application> generated
    documentation, install it using the following commands as the
    <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install_doc &amp;&amp;
install -v -m644 rdoff/doc/rdoff.pdf /usr/share/doc/nasm</userinput></screen>

    <para>Lastly, if you built the RDOFF Postscript documentation, install it
    using the following command as the
    <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>install -v -m644 rdoff/doc/rdoff.ps /usr/share/doc/nasm</userinput></screen>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>nasm, ndisasm, ldrdf, rdf2bin, rdf2com, rdf2ihx, rdfdump, rdflib, and
        rdx</seg>
        <seg>None</seg>
        <seg>/usr/share/doc/nasm</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="nasm-prog">
        <term><command>nasm</command></term>
        <listitem>
          <para>is a portable 80x86 assembler.</para>
          <indexterm zone="NASM nasm-prog">
            <primary sortas="b-nasm">nasm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ndisasm">
        <term><command>ndisasm</command></term>
        <listitem>
          <para>is an 80x86 binary file disassembler.</para>
          <indexterm zone="NASM ndisasm">
            <primary sortas="b-ndisasm">ndisasm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ldrdf">
        <term><command>ldrdf</command></term>
        <listitem>
          <para>is an RDOFF linker.</para>
          <indexterm zone="NASM ldrdf">
            <primary sortas="b-ldrdf">ldrdf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rdfdump">
        <term><command>rdfdump</command></term>
        <listitem>
          <para>dumps the contents of an RDOFF file.</para>
          <indexterm zone="NASM rdfdump">
            <primary sortas="b-rdfdump">rdfdump</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rdflib">
        <term><command>rdflib</command></term>
        <listitem>
          <para>is an RDOFF librarian.</para>
          <indexterm zone="NASM rdflib">
            <primary sortas="b-rdflib">rdflib</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rdx">
        <term><command>rdx</command></term>
        <listitem>
          <para>is used to load and execute an RDOFF module.</para>
          <indexterm zone="NASM rdx">
            <primary sortas="b-rdx">rdx</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>