source: BOOK/final-system/ppc/yaboot.xml @ 3f8be484

<?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">
  <!ENTITY % patches-entities SYSTEM "../../patches.ent">
  %general-entities;
  %patches-entities;
]>

<sect1 id="ch-system-yaboot" role="wrap">
  <?dbhtml filename="yaboot.html"?>

  <title>Yaboot-&yaboot-version;</title>

  <indexterm zone="ch-system-yaboot">
    <primary sortas="a-Yaboot">Yaboot</primary>
  </indexterm>

  <sect2 role="package">
    <title/>

    <para>The Yaboot package contains a PowerPC Boot Loader for machines using
    OpenFirmware such as NewWorld Macintoshes.</para>

    <segmentedlist>
      <segtitle>&buildtime;</segtitle>
      <segtitle>&diskspace;</segtitle>

      <seglistitem>
        <seg>Not checked yet</seg>
        <seg>Not checked yet</seg>
      </seglistitem>
    </segmentedlist>

    <segmentedlist>
      <segtitle>&dependencies;</segtitle>

      <seglistitem>
        <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Glibc, Grep,
        Make, Ncurses, and Sed</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

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

    <para>Yaboot has a compilation error. The following patch properly fixes
    that issue</para>

<screen><userinput>patch -Np1 -i ../yaboot-&yaboot-version;-fix-1.patch</userinput></screen>

    <para>Compile the Yaboot package:</para>

<screen><userinput>make PREFIX=/usr</userinput></screen>

    <para>Install the package:</para>

<screen><userinput>make PREFIX=/usr install</userinput></screen>

  </sect2>

  <sect2 id="contents-yaboot" role="content">
    <title>Contents of Yaboot</title>

    <segmentedlist>
      <segtitle>Installed programs</segtitle>
      <segtitle>Installed files</segtitle>

      <seglistitem>
        <seg>addnote, mkofboot (link to ybin), ofboot, ofpath, yaboot,
        yabootconfig, ybin</seg>
        <seg>yaboot.conf</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="addnote">
        <term><command>addnote</command></term>
        <listitem>
          <para>For IBM CHRP machines, add a PT_NOTE program header
          entry to an elf file so that it can be booted.</para>
          <indexterm zone="ch-system-yaboot addnote">
            <primary sortas="b-addnote">addnote</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mkofboot">
        <term><command>mkofboot</command></term>
        <listitem>
          <para>Format the bootstrap partition and install the yaboot
          boot loader.</para>
          <indexterm zone="ch-system-yaboot mkofboot">
            <primary sortas="b-mkofboot">mkofboot</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ofboot">
        <term><command>ofboot</command></term>
        <listitem>
          <para>Script to format the boot menu using yaboot.conf and
          write the resulting OpenFirmware code to the bootstrap.</para>
          <indexterm zone="ch-system-yaboot ofboot">
            <primary sortas="b-ofboot">ofboot</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ofpath">
        <term><command>ofpath</command></term>
        <listitem>
          <para>Determine OpenFirmware path corresponding to a device
          node.</para>
          <indexterm zone="ch-system-yaboot ofpath">
            <primary sortas="b-ofpath">ofpath</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="yaboot">
        <term><command>yaboot</command></term>
        <listitem>
          <para>OpenFirmware boot loader.</para>
          <indexterm zone="ch-system-yaboot yaboot">
            <primary sortas="b-yaboot">yaboot</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="yabootconfig">
        <term><command>yabootconfig</command></term>
        <listitem>
          <para>Generate and install a simple yaboot.conf.</para>
          <indexterm zone="ch-system-yaboot yabootconfig">
            <primary sortas="b-yabootconfig">yabootconfig</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ybin">
        <term><command>ybin</command></term>
        <listitem>
          <para>Shell script to update or install the boot loader
          on a bootstrap partition.</para>
          <indexterm zone="ch-system-yaboot ybin">
            <primary sortas="b-ybin">ybin</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="yaboot.conf">
        <term><filename>yaboot.conf</filename></term>
        <listitem>
          <para>Configuration file used by <command>ybin</command> to determine
          how to install <command>yaboot</command> on the bootstrap partition.</para>
          <indexterm zone="ch-system-yaboot yaboot.conf">
            <primary sortas="e-yaboot.conf">yaboot.conf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>