Macintosh-SW/EMILE
1
0
Fork 0
mirror of https://github.com/vivier/EMILE.git synced 2024-06-09 15:29:28 +00:00
Code Issues Projects Releases Wiki Activity

EMILE documentation: man pages written by Stephen R. Marenka

Browse Source
This commit is contained in:
Laurent Vivier 2005-06-16 05:27:49 +00:00
parent ff81b04c7f
commit 3e762bcf34
7 changed files with 1104 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Makefile
View File

@ -78,7 +78,7 @@ endif
# Target
all: libemile tools first/first_floppy second/$(KARCH)-second_floppy \
second/$(KARCH)-second_scsi
second/$(KARCH)-second_scsi docs
# We can build floppy image only if a kernel is provided
@ -164,6 +164,8 @@ tools::
$(MAKE) -C tools all VERSION=$(VERSION) SIGNATURE="$(SIGNATURE)" \
PREFIX=$(PREFIX) CROSS_COMPILE=$(CROSS_COMPILE)
docs::
$(MAKE) -C docs all
dump: last.bin
dd if=last.bin of=$(FLOPPY) bs=512
@ -190,6 +192,7 @@ install: all
install second/$(KARCH)-second_scsi $(DESTDIR)/$(PREFIX)/boot/emile/$(KARCH)-second_scsi
install -d $(DESTDIR)/$(PREFIX)/lib/emile/
install second/$(KARCH)-second_floppy $(DESTDIR)/$(PREFIX)/lib/emile/$(KARCH)-second_floppy
$(MAKE) -C docs install
uninstall:
rm -f $(DESTDIR)/$(PREFIX)/usr/include/libemile.h
@ -204,12 +207,14 @@ uninstall:
rm -f $(DESTDIR)/$(PREFIX)/lib/emile/first_floppy
rm -f $(DESTDIR)/$(PREFIX)/boot/emile/$(KARCH)-second_scsi
rm -f $(DESTDIR)/$(PREFIX)/lib/emile/$(KARCH)-second_floppy
$(MAKE) -C docs uninstall
clean:
$(MAKE) -C libemile clean
$(MAKE) -C tools clean
$(MAKE) -C first clean
$(MAKE) -C second clean
$(MAKE) -C docs clean
rm -f floppy.bin floppy.bin.X floppy_ramdisk.bin \
floppy_ramdisk.bin.X rescue.bin rescue.bin.X \
debian-installer.bin debian-installer.bin.X \

158
docs/emile-first-tune.sgml Normal file
View File

@ -0,0 +1,158 @@
<!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>DESCRIPTION</title>
<para><command>&dhprogram;</command> sets the
<command>&dhpackage;</command> bootloader first level
boot block info.
Display current values if no flags provided.
</para>
</refsect1>
<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>
</variablelist>
</refsect1>
<refsect1>
<title>WARNING</title>
<para>
!!! USE WITH CAUTION AND AT YOUR OWN RISK !!!
</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).</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>
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:
-->

189
docs/emile-install.sgml Normal file
View File

@ -0,0 +1,189 @@
<!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-install</refentrytitle>">
<!ENTITY dhpackage "emile">
<!ENTITY dhprogram "emile-install">
<!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>install the <command>&dhpackage;</command>
bootloader on a floppy disk
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhprogram;</command>
<arg><replaceable>options</replaceable></arg>
<arg>image</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>&dhprogram;</command> creates an
<command>&dhpackage;</command> bootable floppy disk or
disk image.
</para>
</refsect1>
<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>-v</option>
<option>--verbose</option></term>
<listitem>
<para>Activate verbose mode.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-f</option>
<option>--first PATH</option></term>
<listitem>
<para>Set path of EMILE first level.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-s</option>
<option>--second PATH</option></term>
<listitem>
<para>Set path of EMILE second level.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-k</option>
<option>--kernel PATH</option></term>
<listitem>
<para>Set path of kernel.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-r</option>
<option>--ramdisk PATH</option></term>
<listitem>
<para>Set path to ramdisk.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-b</option>
<option>--buffer SIZE</option></term>
<listitem>
<para>Uncompressed size of kernel.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-g</option>
<option>--get-info</option></term>
<listitem>
<para>Get information from image.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>WARNING</title>
<para>
!!! USE WITH CAUTION AND AT YOUR OWN RISK !!!
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>emile(8), emile-first-tune(8), emile-map-set(8),
emile-set-cmdline(8), emile-set-output(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>
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:
-->

159
docs/emile-map-set.sgml Normal file
View File

@ -0,0 +1,159 @@
<!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-map-set</refentrytitle>">
<!ENTITY dhpackage "emile">
<!ENTITY dhprogram "emile-map-set">
<!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 partition map information.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhprogram;</command>
<arg><replaceable>options</replaceable></arg>
<arg>partition</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>&dhprogram;</command> sets the
<command>&dhpackage;</command> bootloader partition
map information.
Do not use <option>--startup</option> with any other
options.
</para>
</refsect1>
<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>-f</option>
<option>--flags FLAGS</option></term>
<listitem>
<para>Set the flags for the partition.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-t</option>
<option>--type TYPE</option></term>
<listitem>
<para>Set the type of the partition.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-s</option>
<option>--startup</option></term>
<listitem>
<para>Set the startup partition.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>WARNING</title>
<para>
!!! USE WITH CAUTION AND AT YOUR OWN RISK !!!
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>emile(8), emile-install(8), emile-first-tune(8),
emile-set-cmdline(8), emile-set-output(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>
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:
-->

169
docs/emile-set-cmdline.sgml Normal file
View File

@ -0,0 +1,169 @@
<!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-set-cmdline</refentrytitle>">
<!ENTITY dhpackage "emile">
<!ENTITY dhprogram "emile-set-cmdline">
<!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>sets the kernel command line for the
<command>&dhpackage;</command> bootloader
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhprogram;</command>
<arg>image</arg>
<arg>cmdline</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>&dhprogram;</command>
<arg>-r</arg>
<arg>image</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>&dhprogram;</command> sets the kernel command line
to cmdline for a <command>&dhpackage;</command>
bootloader disk image, floppy disk device (/dev/fd0),
or the second level file. Executing with "-r" flag,
displays the current command line.
</para>
</refsect1>
<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>-r</option></term>
<listitem>
<para>Display current kernel command line.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para>
To set root filesystem on disk 1 partition 4:
</para>
<para>
<command>&dhprogram;</command> floppy.img "root=/dev/sda4"
</para>
<para>
To set root filesystem on ramdisk:
</para>
<para>
<command>&dhprogram;</command> floppy.img "root=/dev/ramdisk ramdisk_size=2048"
</para>
<para>
To set root filesystem on NFS:
</para>
<para>
<command>&dhprogram;</command> floppy.img "root=/dev/nfs ip=dhcp nfsroot=192.168.100.1:/tftboot/192.168.100.51"
</para>
</refsect1>
<refsect1>
<title>WARNING</title>
<para>
!!! USE WITH CAUTION AND AT YOUR OWN RISK !!!
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>emile(8), emile-install(8), emile-first-tune(8),
emile-map-set(8), emile-set-output(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>
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:
-->

206
docs/emile-set-output.sgml Normal file
View File

@ -0,0 +1,206 @@
<!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-set-output</refentrytitle>">
<!ENTITY dhpackage "emile">
<!ENTITY dhprogram "emile-set-output">
<!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 display output.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhprogram;</command>
<arg>image</arg>
<arg>--display</arg>
<arg><replaceable>--width WIDTH</replaceable></arg>
<arg><replaceable>--height HEIGHT</replaceable></arg>
<arg><replaceable>--depth DEPTH</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>&dhprogram;</command>
<arg>image</arg>
<arg>--modem</arg>
<arg><replaceable>--bitrate BITRATE</replaceable></arg>
<arg><replaceable>--datasize DATASIZE</replaceable></arg>
<arg><replaceable>--parity PARITY</replaceable></arg>
<arg><replaceable>--stopbits STOPBITS</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>&dhprogram;</command>
<arg>image</arg>
<arg>--printer</arg>
<arg><replaceable>--bitrate BITRATE</replaceable></arg>
<arg><replaceable>--datasize DATASIZE</replaceable></arg>
<arg><replaceable>--parity PARITY</replaceable></arg>
<arg><replaceable>--stopbits STOPBITS</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>&dhprogram;</command> sets the
<command>&dhpackage;</command> output options.
No options displays the current configuration.
PARITY is 0 for none, 1 for odd, 2 for even.
</para>
</refsect1>
<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>--display</option></term>
<listitem>
<para>Enable output to display and set configuration.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--nodisplay</option></term>
<listitem>
<para>Disable output to display.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--modem</option></term>
<listitem>
<para>Enable output to serial port 0 (modem) and set configuration.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--nomodem</option></term>
<listitem>
<para>Disable output to modem port.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--printer</option></term>
<listitem>
<para>Enable output to serial port 1 (printer) and set configuration.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--noprinter</option></term>
<listitem>
<para>Disable output to printer port.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--gestaltid ID</option></term>
<listitem>
<para>Force the gestaltid to ID. Set to 0 to unset.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>WARNING</title>
<para>
!!! USE WITH CAUTION AND AT YOUR OWN RISK !!!
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>emile(8), emile-install(8), emile-first-tune(8),
emile-map-set(8), emile-set-cmdline(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>
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:
-->

217
docs/emile.sgml Normal file
View File

@ -0,0 +1,217 @@
<!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</refentrytitle>">
<!ENTITY dhpackage "emile">
<!ENTITY dhprogram "emile">
<!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>install the <command>&dhpackage;</command>
bootloader
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhprogram;</command>
<arg><replaceable>options</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>&dhprogram;</command> installs the
<command>&dhpackage;</command> bootloader. Run it with
<option>--test</option> to see the default values.
</para>
</refsect1>
<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>-v</option>
<option>--verbose</option></term>
<listitem>
<para>Activate verbose mode.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-t</option>
<option>--test</option></term>
<listitem>
<para>Activate test mode (don't write to disk).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--scanbus</option></term>
<listitem>
<para>Display information about all disks and partitions.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-f</option>
<option>--first PATH</option></term>
<listitem>
<para>Set path of EMILE first level.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-s</option>
<option>--second PATH</option></term>
<listitem>
<para>Set path of EMILE second level.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-k</option>
<option>--kernel PATH</option></term>
<listitem>
<para>Set path of kernel.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-a</option>
<option>--append ARG</option></term>
<listitem>
<para>Set kernel command line.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p</option>
<option>--partition DEV</option></term>
<listitem>
<para>Define device where to install boot block.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--restore[=FILE]</option></term>
<listitem>
<para>Restore current boot block from FILE.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--backup[=FILE]</option></term>
<listitem>
<para>Backup current boot block to FILE.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--set-hfs</option></term>
<listitem>
<para>Set type of partition DEV to Apple_HFS
(needed to be bootable with a MacOS partition).</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>WARNING</title>
<para>
!!! USE WITH CAUTION AND AT YOUR OWN RISK !!!
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>emile-install(8), emile-set-cmdline(8), emile-first-tune(8),
emile-map-set(8), emile-set-output(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>
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:
-->