EMILE/docs/emile-first-tune.sgml

<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@
  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Stephen</firstname>">
  <!ENTITY dhsurname   "<surname>Marenka</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>May 26, 2005</date>">
  <!ENTITY dhsection   "<manvolnum>8</manvolnum>">
  <!ENTITY dhemail     "<email>stephen@marenka.net</email>">
  <!ENTITY dhusername  "Stephen R. Marenka">
  <!ENTITY dhucpackage "<refentrytitle>emile-first-tune</refentrytitle>">
  <!ENTITY dhpackage   "emile">
  <!ENTITY dhprogram   "emile-first-tune">

  <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2005</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhprogram;</refname>

    <refpurpose>Set the <command>&dhpackage;</command> 
		bootloader first level boot block info.
	</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhprogram;</command>
	<arg><replaceable>options</replaceable></arg>
	<arg>image</arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term><option>-h</option>
          <option>--help</option></term>
        <listitem>
          <para>Show summary of options.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-d</option>
          <option>--drive DRIVE</option></term>
        <listitem>
          <para>Set the drive number (default 1).</para>
        </listitem>
      </varlistentry>
      
      <varlistentry>
        <term><option>-o</option>
          <option>--offset SIZE</option></term>
        <listitem>
          <para>Set offset of second level in bytes.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-s</option>
          <option>--size SIZE</option></term>
        <listitem>
          <para>Set size of second level in bytes.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-i</option>
	  <option>-scsi</option></term>
	<listitem>
	<para>specify scsi first level format (offset is a block number)</para>
	</listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-p</option>
	  <option>--path</option></term>
	<listitem>
	   <para>set path of second level</para>
	</listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  <refsect1>
    <title>DESCRIPTION</title>
    <para>
      <command>&dhprogram;</command> is used to set EMILE first level boot block info.
    </para>
    <para>EMILE first level is written into the boot block by EMILE.
    When computer starts it loads in memory this boot block and executes it.
    The aim of the first level is to load the second level. To be able to load
    the second level, first level must be configured with information allowing
    it to know where is located the second level. <command>&dhprogram;</command>
    is the command allowing to set this information.</para>
    <para>Display current values if no flags provided.</para>
  </refsect1>

  <refsect1>
    <title>EXAMPLES</title>
    <programlisting><command>&dhprogram;</command> -o 1024 -s 55864 /dev/fd0</programlisting>
    <para>Set the first level in the boot block of the floppy /dev/fd0
    to load the second level found at the offset 1024 bytes for a size of
    55864 bytes</para>
    <programlisting><command>&dhprogram;</command> /dev/fd0</programlisting>
    <para>Display first level information of the device /dev/fd0
    <programlisting>
    EMILE boot block identified

    Drive number: 1
    Second level offset: 1024
    Second level size: 56320
    </programlisting></para>
    <programlisting><command>&dhprogram; /dev/sda4 --path /boot/emile/m68k-second_scsi</command></programlisting>
    <para>First level will load the second level found in the file 
    /boot/emile/m68k-second_scsi</para>
  </refsect1>

  <refsect1>
    <title>REPORTING BUGS</title>
    <para>Report bugs to Laurent Vivier &lt;Laurent@lvivier.info&gt;</para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>

    <para>emile(8), emile-install(8), emile-set-cmdline(8), 
    	emile-map-set(8), emile-set-output(8), emile-mkisofs(8).</para>

  </refsect1>

  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; <&dhemail;> for
      the &debian; system (but may be used by others).  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the <acronym>GNU</acronym> GPL License, Version 2 
      or any later version published by the Free Software Foundation.
    </para>
    <para>This manual page has been updated by Laurent Vivier 
    &lt;Laurent@lvivier.info&gt;.</para>
    <para>
	On Debian systems, the complete text of the GNU General Public
	License can be found in /usr/share/common-licenses/GPL.
    </para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->