diff options
Diffstat (limited to 'package/aboot/src/doc')
31 files changed, 6152 insertions, 0 deletions
diff --git a/package/aboot/src/doc/faq/.cvsignore b/package/aboot/src/doc/faq/.cvsignore new file mode 100644 index 000000000..2d19fc766 --- /dev/null +++ b/package/aboot/src/doc/faq/.cvsignore @@ -0,0 +1 @@ +*.html diff --git a/package/aboot/src/doc/faq/Makefile b/package/aboot/src/doc/faq/Makefile new file mode 100644 index 000000000..fc38ddba4 --- /dev/null +++ b/package/aboot/src/doc/faq/Makefile @@ -0,0 +1,9 @@ +all-html : SRM-HOWTO/index.html + +clean : + rm -rf SRM-HOWTO + +SRM-HOWTO/index.html : SRM-HOWTO.sgml + sgmltools --backend=html SRM-HOWTO.sgml + +#.PHONY clean diff --git a/package/aboot/src/doc/faq/SRM-HOWTO.sgml b/package/aboot/src/doc/faq/SRM-HOWTO.sgml new file mode 100644 index 000000000..8093647d4 --- /dev/null +++ b/package/aboot/src/doc/faq/SRM-HOWTO.sgml @@ -0,0 +1,2293 @@ +<!DOCTYPE Article PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> + +<!-- <!DOCTYPE Article PUBLIC "-//Davenport//DTD DocBook V3.0//EN"> --> + +<Article id="index"> + +<articleinfo> + +<Title>SRM Firmware Howto</Title> + +<authorgroup> +<AUTHOR> +<firstname>Rich</firstname> <surname>Payne</surname> +<affiliation><address><email>rdp@alphalinux.org</email></address></affiliation> +</AUTHOR> +<!-- and --> +<AUTHOR> +<firstname>David</firstname> <surname>Huggins-Daines</surname> +<affiliation><address><email>dhuggins@linuxcare.com</email></address></affiliation> +</AUTHOR> +</authorgroup> + +<PubDate>v0.8.1, 14 February 2004</PubDate> + +<Abstract> +<Para> +This document describes how to boot Linux/Alpha using the SRM console, +which is the console firmware also used to boot +<productname>HP Tru64 Unix</productname> +(also known as <productname>Digital Unix</productname> and <productname>OSF/1</productname>) and <productname>OpenVMS</productname>. +</Para> +</Abstract> + +</articleinfo> + +<Sect1 id="SRM-about"> +<Title>About this manual</Title> + +<Sect2> +<Title>Who should read this manual</Title> + +<Para> +You should read this manual if you are installing Linux on a new +Alpha system that can only boot from the SRM console, or if you are +installing Linux on an older Alpha system that can use the SRM console +and wish to use SRM to boot your Linux installation. +</Para> + +<Para> +Because SRM is the only way to boot Linux on modern Alpha systems, +and because it provides the proper operating environment for Unix and +Unix-like operating systems (such as Linux), it is the recommended way +of booting Linux on Alpha when available. +</Para> + +<Para> +Sometimes, it is preferable to use the ARC, ARCSBIOS, or AlphaBIOS +console, such as if you have a machine for which SRM is not available, +if you wish to dual-boot with <productname>Windows NT</productname> +without switching consoles, +or if you have hardware that is not supported by SRM. On these +machines, you will typically use MILO to boot Linux. For more +information, refer to the MILO Howto, available from +<ULink URL="http://www.alphalinux.org/faq/milo.html">http://www.alphalinux.org/faq/milo.html</ULink>. +</Para> + +</Sect2> + +<Sect2> +<Title>Conventions</Title> + +<Para> +Throughout this manual, we will use the following conventions for +commands to be entered by the user: +</Para> + +<Para> +SRM console commands will be shown with the characteristic SRM +'>>>' prompt, like this: +<FOOTNOTE> + +<Para> +On multiprocessor machines, you +will see 'P00>>' instead, or possibly some other number depending on +which processor SRM is running. +</Para> + +</FOOTNOTE> + + +<Screen> +>>> boot dva0 -fi linux.gz -fl "root=/dev/fd0 load_ramdisk=1" +</Screen> + +</Para> + +<Para> +Unix commands will be shown with the '#' command prompt if they are +to be run as <Literal remap="tt">root</Literal>, or '$' if they are to be run by a normal user, +like this: + +<Screen> +# swriteboot -f3 /dev/sda /boot/bootlx +</Screen> + +</Para> + +<Para> +Aboot commands will be shown with the 'aboot>' command prompt, like +this: + +<Screen> +aboot> b 6/boot/vmlinuz root=/dev/hda6 +</Screen> + +</Para> + +</Sect2> + +</Sect1> + +<Sect1 id="SRM-whatis"> +<Title>What is SRM?</Title> + +<Para> +SRM console is used by Alpha systems as +Unix-style boot firmware. <productname>Tru64 Unix</productname> and +<productname>OpenVMS</productname> depend on it and +Linux can boot from it. You can recognize SRM console as a blue screen +with a prompt that is presented to you on power-up. +</Para> + +<Sect2> +<Title>Getting to SRM</Title> + +<Para> +Most Alpha systems have both the SRM and ARC/AlphaBIOS console in +their firmware. On one of these machines, if your machine starts up +with ARC/AlphaBIOS by default, you can switch to SRM through the +"<guimenuitem>Console Selection</guimenuitem>" option in the Advanced CMOS Setup menu. To make <!-- FIXME Markup should do the marking --> +the change permanent, you should set the <Literal remap="tt">os_type</Literal> environment +variable in SRM to "OpenVMS" or "Unix", like this: + +<Screen> +>>> set os_type Unix +</Screen> + +</Para> + +<Para> +Either one will work to boot Linux. However, if you intend to +dual-boot OpenVMS on this machine, you must set <Literal remap="tt">os_type</Literal> to +"OpenVMS". Conversely, to return to ARC/AlphaBIOS, you can set +<Literal remap="tt">os_type</Literal> to "NT". +</Para> + +<Para> +Some older systems may not have both SRM and ARC in firmware as +shipped. On these systems, you will have to upgrade your firmware. +See <ULink +URL="http://ftp.digital.com/pub/DEC/Alpha/firmware/" +>http://ftp.digital.com/pub/DEC/Alpha/firmware</ULink +> for the +latest firmware updates and instructions. +</Para> + +<Para> +A few older systems (primarily evaluation boards such as the 164SX +and 164LX) are "half-flash" systems, whose firmware can hold SRM or +AlphaBIOS, but not both. If you have one of these machines, you will +have to reflash your firmware with the SRM console using the AlphaBIOS +firmware update utility. Again, see +<ULink +URL="http://ftp.digital.com/pub/DEC/Alpha/firmware/" +>http://ftp.digital.com/pub/DEC/Alpha/firmware</ULink +> for firmware +images and instructions. If you wish to return to AlphaBIOS on these +machines, you may rerun the firmware update utility from a floppy in +SRM using the <Literal remap="tt">fwupdate</Literal> command. You can also start AlphaBIOS +from a floppy using the <Literal remap="tt">arc</Literal> command. +</Para> + +</Sect2> + +<Sect2> +<Title>Using the SRM console</Title> + +<Para> +The SRM console works very much like a Unix or OpenVMS shell. It +views your NVRAM and devices as a pseudo-filesystem. You can see this +if you use the <command>ls</command> command. Also, it contains a fairly large set +of diagnostic, setup, and debugging utilities, the details of which +are beyond the scope of this document. As in the Unix shell, you can +pipe the output of one command to the input of another, and there is a +<command>more</command> command that works not unlike the Unix one. To get a full +listing of available commands, run: + +<Screen> +>>> help | more +</Screen> + +</Para> + +<Para> +As well, SRM has environment variables, a number of which are +pre-defined and correspond to locations in NVRAM. You can view the +entire list of environment variables and their values with the +<command>show</command> command (there are quite a few of them, so you will probably +want to pipe its output to <command>more</command>). You can also show variables +matching a "glob" pattern - for example, <command>show boot*</command> will show all +the variables starting in "boot". +</Para> + +<Para> +Environment variables are categorized as either <Emphasis>read-only</Emphasis>, +<Emphasis>warm non-volatile</Emphasis>, or <Emphasis>cold non-volatile</Emphasis>. The full listing +of pre-defined variables is detailed in the Alpha Architecture +Reference Manual. The most useful pre-defined environment variables +for the purposes of booting Linux are <varname>bootdef_dev</varname>, +<varname>boot_file</varname>, <varname>boot_flags</varname>, and +<varname>auto_action</varname>, all of which are cold non-volatile. +</Para> + +<Para> +To set environment variables, use the <command>set</command> command, like this: + +<Screen> +>>> set bootdef_def dka0 +</Screen> + +</Para> + +<Para> +If you set an undefined variable, it will be created for you, however +it will not persist across reboots. +</Para> + +<Para> +The <varname>bootdef_dev</varname> variable specifies the device (using +VMS naming conventions - see <XRef LinkEnd="device-naming"> for an +explanation of these) which will be booted from if no device is +specified on the <Literal remap="tt">boot</Literal> command line, or in an automatic boot. +The <varname>boot_file</varname> variable contains the filename to be +loaded by the secondary bootloader, while <varname>boot_flags</varname> +contains any extra flags. <varname>auto_action</varname> specifies the +action which the console should take on power-up. By default, it is +set to <Literal remap="tt">HALT</Literal>, meaning that the machine will start up in the +SRM console. Once you have configured your bootloader and the +boot-related variables, you can set it to <Literal remap="tt">BOOT</Literal> in order to +boot automatically on power-up. +</Para> + +<Para> +Finally, two helpful console keystrokes you should know are +<keycombo action='simul'><keycap>Control</keycap><keycap>C</keycap></keycombo>, +which, as in the shell, halts a command in progress (such +as an automatic boot), and +<keycombo action='simul'><keycap>Control</keycap><keycap>P</keycap></keycombo>, +which if issued from the aboot +prompt (or other secondary bootloader) will halt the bootloader and +return you to the SRM console. +</Para> + +</Sect2> + +<Sect2 id="how-srm-boots"> +<Title>How Does SRM Boot an OS?</Title> + +<Para> +All versions of SRM can boot from SCSI disks and the versions for +recent platforms, such as the Noname or AlphaStations can boot from +floppy disks as well. Network booting via <Literal remap="tt">bootp</Literal> is supported. +Note that older SRM versions (notably the one for the Jensen) +cannot boot from floppy disks. Booting from IDE devices +is supported on newer platforms (164SX, 164LX, 164UX, DS20, DS10, DP264, UP2000(+), UP1000, UP1100 etc.). +</Para> + +<Para> +Booting Linux with SRM is a two step process: first, SRM loads and +transfers control to the secondary bootstrap loader. Then the +secondary bootstrap loader sets up the environment for Linux, reads +the kernel image from a disk filesystem and finally transfers control to Linux. +</Para> + +<Para> +Currently, there are two secondary bootstrap loaders for Linux: +the <Emphasis>raw</Emphasis> loader that comes with the Linux kernel and <Literal remap="tt">aboot</Literal> +which is distributed separately. These two loaders are described in +more detail below. +</Para> + +</Sect2> + +<Sect2> +<Title>Loading The Secondary Bootstrap Loader</Title> + +<Para> +SRM knows nothing about filesystems or disk-partitions. It simply +expects that the secondary bootstrap loader occupies a consecutive +range of physical disk sector, starting from a given offset. The +information on the size of the secondary bootstrap loader and the +offset of its first disk sector is stored in the first 512 byte +sector. Specifically, the long integer at offset 480 stores the +<Emphasis>size</Emphasis> of the secondary bootstrap loader (in 512-byte blocks) and +the long at offset 488 gives the <Emphasis>sector number</Emphasis> at which the +secondary bootstrap loader starts. The first sector also stores a +flag-word at offset 496 which is always 0 and a checksum at offset +504. The checksum is simply the sum of the first 63 long integers in +the first sector. +</Para> + +<Para> +If the checksum in the first sector is correct, SRM goes ahead and +reads the <Emphasis>size</Emphasis> sectors starting from the sector given in the +<Emphasis>sector number</Emphasis> field and places them in <Emphasis>virtual</Emphasis> memory at +address <Literal remap="tt">0x20000000</Literal>. If the reading completes successfully, +SRM performs a jump to address <Literal remap="tt">0x20000000</Literal>. +</Para> + +</Sect2> + +</Sect1> + +<Sect1 id="SRM-DeviceNaming"> +<Title>SRM Device Naming</Title> +<Sect2> +<Title>The First Two Letter</Title> +<Para>The following is based on the example device dkb1.2.3.4.5 taken from a Digital Server 3300 (Whitebox version of +an AS800). +</Para> +<Para> +Two letter port or class driver designator: +<!-- <variablelist> +<varlistentry><term>DR:</term><listitem><para>RAID set device</Para></ListItem></varlistentry> +<varlistentry><term>DV:</term><ListItem><Para>Floppy Drive</Para></ListItem></varlistentry> +<ListItem><Para> EW: Ethernet port (TULIP, DEC 21040) </Para></ListItem> +<ListItem><Para> EI: Ethernet port (Intel 82557 or 82559) </Para></ListItem> +<ListItem><Para> PK: SCSI port (controller) </Para></ListItem> +<ListItem><Para> DK: SCSI disk </Para></ListItem> +<ListItem><Para> MK: SCSI tape </Para></ListItem> +<ListItem><Para> PU: DSSI port </Para></ListItem> +<ListItem><Para> DU: DSSI disk </Para></ListItem> +<ListItem><Para> MU: DSSI tape </Para></ListItem> +<ListItem><Para> JK: SCSI monitor (or robot) </Para></ListItem> +<ListItem><Para> DQ: (E)IDE Device (disk or CD-ROM)</Para></ListItem> +</ItemizedList> +</variablelist> --> +<ItemizedList> +<ListItem><Para> DR: RAID set device </Para></ListItem> +<ListItem><Para> DV: Floppy Drive </Para></ListItem> +<ListItem><Para> EW: Ethernet port (TULIP, DEC 21040) </Para></ListItem> +<ListItem><Para> EI: Ethernet port (Intel 82557 or 82559) </Para></ListItem> +<ListItem><Para> PK: SCSI port (controller) </Para></ListItem> +<ListItem><Para> DK: SCSI disk </Para></ListItem> +<ListItem><Para> MK: SCSI tape </Para></ListItem> +<ListItem><Para> PU: DSSI port </Para></ListItem> +<ListItem><Para> DU: DSSI disk </Para></ListItem> +<ListItem><Para> MU: DSSI tape </Para></ListItem> +<ListItem><Para> JK: SCSI monitor (or robot) </Para></ListItem> +<ListItem><Para> DQ: (E)IDE Device (disk or CD-ROM)</Para></ListItem> +</ItemizedList> +</Para> +</Sect2> +<Sect2> +<Title>The Rest Of The Device Name</Title> +<Para> + +<ItemizedList> +<ListItem><Para> + b->adapter ID (one letter adapter designator)</Para></ListItem> + +<ListItem><Para> + 1->Device number (SCSI unit numbers are forced to 100x Node ID)</Para></ListItem> + +<ListItem><Para> + 2->Bus Node ID</Para></ListItem> + +<ListItem><Para> + 3->Channel Number</Para></ListItem> + +<ListItem><Para> + 4->Channel Number (used for multi-channel devices)</Para></ListItem> + +<ListItem><Para> + 5->Logical Slot number + + <ItemizedList> + <ListItem><Para>EISA: they correspond to the physical slot numbers (1-3)</Para></ListItem> + <ListItem><Para>PCI:</Para> + <ItemizedList> + <ListItem><Para>slot 5= SCSI controller on system backplane (DS3300)</Para></ListItem> + <ListItem><Para>slot 6= On board VGA (DS3300)</Para></ListItem> + <ListItem><Para>slot 7= PCI to EISA bridge chip (DS3300)</Para></ListItem> + <ListItem><Para>slots 11 - 14 = Correspond to Physical PCI option slots: + PCI11, PCI12, PCI13 and PCI14 (64bit) (DS3300)</Para></ListItem> + </ItemizedList> + </ListItem> + </ItemizedList> +</Para> +</ListItem> +<ListItem><Para> + 6->Hose number: 0 PCI_0 (32bit PCI); 1 EISA (DS3300)</Para></ListItem> + +</ItemizedList> +</Para> +</Sect2> +</Sect1> + + +<Sect1 id="SRM-rawloader"> +<Title>The Raw Loader</Title> + +<Para> +The sources for this loader can be found in directory +<filename>arch/alpha/boot</filename> of the Linux kernel source +distribution. It loads the Linux kernel by reading +<varname>START_SIZE</varname> bytes starting at disk offset +<varname>BOOT_SIZE</varname><Literal remap="tt">+512</Literal> +(also in bytes). The constants +<varname>START_SIZE</varname> and <varname>BOOT_SIZE</varname> +are defined in +<filename>linux/include/asm-alpha/system.h</filename>. +<varname>START_SIZE</varname> +must be at least as big as the kernel image (i.e., the size of the +<Literal remap="tt">.text</Literal>, <Literal remap="tt">.data</Literal>, and <Literal remap="tt">.bss</Literal> segments). Similarly, +<varname>BOOT_SIZE</varname> must be at least as big as the image of the +raw bootstrap loader. Both constants should be an integer multiple of the +sector size, which is 512 bytes. The default values are currently 2MB +for <varname>START_SIZE</varname> and 16KB for +<varname>BOOT_SIZE</varname>. Note +that if you want to boot from a 1.44MB floppy disk, you have to reduce +<varname>START_SIZE</varname> to 1400KB and make sure that the kernel you +want to boot is no bigger than that. +</Para> + +<Para> +To build a raw loader, simply type <command>make rawboot</command> in the top +directory of your linux source tree (typically +<filename>/usr/src/linux</filename>). This should produce the following files +in <filename>arch/alpha/boot</filename>: +</Para> + +<Para> +<VariableList> + +<VarListEntry> +<Term><filename>tools/lxboot</filename>:</Term> +<ListItem> +<Para> +The first +sector on the disk. It contains the offset and size of +the next file in the format described above. +</Para> +</Listitem> +</VarListEntry> +<VarListEntry> +<Term><filename>tools/bootlx</filename>:</Term> +<ListItem> +<Para> +The raw boot loader that +will load the file below. +</Para> +</Listitem> +</VarListEntry> +<VarListEntry> +<Term><filename>vmlinux.nh</filename>:</Term> +<ListItem> +<Para> +The raw kernel image consisting of +the <Literal remap="tt">.text</Literal>, <Literal remap="tt">.data</Literal>, and <Literal remap="tt">.bss</Literal> segments of the +object file in <Literal remap="tt">/usr/src/linux/vmlinux</Literal>. The +extension <Literal remap="tt">.nh</Literal> indicates that this file has no object-file +header. +</Para> +</Listitem> +</VarListEntry> +</VariableList> +</Para> + +<Para> +The concatenation of these three files should be written to the +disk from which you want to boot. For example, to boot from a floppy, +insert an empty floppy disk in, say, <filename>/dev/fd0</filename> and then type: + +<Screen> +# cat tools/lxboot tools/bootlx vmlinux >/dev/fd0 +</Screen> + +</Para> + +<Para> +You can then shutdown the system and boot from the floppy by +issuing the command <command>boot dva0</command>. +</Para> + +</Sect1> + +<Sect1 id="SRM-aboot"> +<Title>The aboot Loader</Title> + +<Para> +When using the SRM firmware, <Literal remap="tt">aboot</Literal> is the preferred way of +booting Linux. It supports: +</Para> + +<Para> + +<ItemizedList> +<ListItem> + +<Para> + direct booting from various filesystems (<Literal remap="tt">ext2</Literal>, <Literal remap="tt">ISO9660</Literal>, and +<Literal remap="tt">UFS</Literal>, the <productname>HP Tru64</productname> filesystem) +</Para> +</ListItem> +<ListItem> + +<Para> + listing directories and following symbolic links on ext2 (version 0.6 and later) +</Para> +</ListItem> +<ListItem> + +<Para> + booting of executable object files (both ELF and ECOFF) +</Para> +</ListItem> +<ListItem> + +<Para> + booting compressed kernels +</Para> +</ListItem> +<ListItem> + +<Para> + network booting (using bootp) +</Para> +</ListItem> +<ListItem> + +<Para> + partition tables in <productname>HP Tru64</productname> format (which is +compatible with BSD Unix partition tables) +</Para> +</ListItem> +<ListItem> + +<Para> + interactive booting and default configurations for +SRM consoles that cannot pass long option strings +</Para> +</ListItem> + +<ListItem> + +<Para> + load initrd images to load modules at boot time (0.7 and later) +</Para> +</ListItem> + +</ItemizedList> + +</Para> + +<Sect2> +<Title>Getting and Building aboot</Title> + +<Para> +The latest sources for <Literal remap="tt">aboot</Literal> are available from <ULink +URL="http://www.sf.net/projects/aboot" +>Sourceforge</ULink>. They can +also be obtained via anonymous CVS from www.sf.net, to get the latest version from CVS use these commands: +<Screen> +bash# cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/aboot login +bash# cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/aboot co aboot +</Screen> +(Note there is no password for the CVS login, just press enter) +</Para> + +<Para> +The description in this manual applies to <Literal remap="tt">aboot</Literal> version 0.6 +or newer. Please note that many distributions ship aboot with them so +downloading aboot from this directory is probably not neccesary. +</Para> + +<Para> + Once you downloaded and extracted the latest tar file, take a +look at the <filename>README</filename> and <filename>INSTALL</filename> files +for installation hints. In particular, be sure to adjust the variables in +<filename>Makefile</filename> and in <filename>include/config.h</filename> +to match your +environment. Normally, you won't need to change anything when +building under Linux, but it is always a good idea to double check. +If you're satisfied with the configuration, simply type <command>make</command> +to build it (if you're not building under Linux, be advised that +<Literal remap="tt">aboot</Literal> requires GNU <Literal remap="tt">make</Literal>). +</Para> + +<Para> +After running <Literal remap="tt">make</Literal>, the <filename>aboot</filename> +directory should contain the following files: +</Para> + +<Para> +<VariableList> + +<VarListEntry> +<Term><filename>aboot</filename></Term> +<ListItem> +<Para> +This is the actual <Literal remap="tt">aboot</Literal> executable (either an +ECOFF or ELF object file). +</Para> +</Listitem> +</VarListEntry> +<VarListEntry> +<Term><filename>bootlx</filename></Term> +<ListItem> +<Para> +Same as above, but it contains only the text, data +and bss segments ‐ that is, this file is not an object file. +</Para> +</Listitem> +</VarListEntry> +<VarListEntry> +<Term><filename>sdisklabel/swriteboot</filename></Term> +<ListItem> +<Para> +Utility to install <Literal remap="tt">aboot</Literal> on a +hard disk. +</Para> +</Listitem> +</VarListEntry> +<VarListEntry> +<Term><filename>tools/e2writeboot</filename></Term> +<ListItem> +<Para> +Utility to install <Literal remap="tt">aboot</Literal> on an ext2 +filesystem (usually used for floppies only). +</Para> +</Listitem> +</VarListEntry> +<VarListEntry> +<Term><filename>tools/isomarkboot</filename></Term> +<ListItem> +<Para> +Utility to install <Literal remap="tt">aboot</Literal> on a iso9660 +filesystem (used by CD-ROM distributors). +</Para> +</Listitem> +</VarListEntry> +<VarListEntry> +<Term><filename>tools/abootconf</filename></Term> +<ListItem> +<Para> +Utility to configure an installed <Literal remap="tt">aboot</Literal>. +</Para> +</Listitem> +</VarListEntry> +</VariableList> +</Para> + +</Sect2> + +<Sect2> +<Title>Floppy Installation</Title> + +<Para> + The bootloader can be installed on a floppy using the +<command>e2writeboot</command> command (note: this can't be done on a Jensen +since +its firmware does <Emphasis>not</Emphasis> support booting from floppy). This command +requires that the disk is not overly fragmented as it needs to find +enough contiguous file blocks to store the entire <Literal remap="tt">aboot</Literal> image +(currently about 90KB). If <command>e2writeboot</command> fails because of this, +reformat the floppy and try again (e.g., with <command>fdformat</command>(1)). +For +example, the following steps install <Literal remap="tt">aboot</Literal> on floppy disk +assuming the floppy is in drive <filename>/dev/fd0</filename>: + +<Screen> +# fdformat /dev/fd0 +# mke2fs /dev/fd0 +# e2writeboot /dev/fd0 bootlx +</Screen> + +</Para> + +</Sect2> + +<Sect2> +<Title>Harddisk Installation</Title> + +<Para> +Since the <command>e2writeboot</command> command may fail on highly fragmented +disks and since reformatting a harddisk is not without pain, it is +generally safer to install <Literal remap="tt">aboot</Literal> on a harddisk using the +<command>swriteboot</command> command. +<Literal remap="tt">swriteboot</Literal> requires that the first few +sectors are reserved for booting purposes. We suggest that the disk +be partitioned such that the first partition starts at an offset of +2048 sectors. This leaves 1MB of space for storing <Literal remap="tt">aboot</Literal>. On +a properly partitioned disk, it is then possible to install <Literal remap="tt">aboot</Literal> +as follows (assuming the disk is <filename>/dev/sda</filename>): + +<Screen> +# swriteboot /dev/sda bootlx +</Screen> + +</Para> + +<Para> +On systems where partition <Literal remap="tt">c</Literal> in the entire disk it will be +necessary to 'force' the write of aboot. In this case use the <Literal remap="tt">-f</Literal> +flag followed by the partition number (in the case of partition <Literal remap="tt">c</Literal> +this is 3): + +<Screen> +# swriteboot /dev/sda bootlx -f3 +</Screen> + +</Para> + +<Para> +On a Jensen, you will want to leave some more space, since you need to +write a kernel to this place, too---2MB should be sufficient when +using compressed kernels. Use <Literal remap="tt">swriteboot</Literal> as described in Section +<XRef LinkEnd="booting"> to write <filename>bootlx</filename> together with +the Linux kernel. +</Para> + +</Sect2> + +<Sect2> +<Title>CD-ROM Installation</Title> + +<Para> + To make a CD-ROM bootable by SRM, simply build <Literal remap="tt">aboot</Literal> as +described above. Then, make sure that the <filename>bootlx</filename> file is +present on the iso9660 filesystem (e.g., copy <filename>bootlx</filename> to +the directory that is the filesystem master, then run <command>mkisofs</command> +on that directory). After that, all that remains to be done is to mark the +filesystem as SRM bootable. This is achieved with a command of the +form: + +<Screen> +# isomarkboot filesystem bootlx +</Screen> + +</Para> + +<Para> +The command above assumes that <filename>filesystem</filename> is a file +containing the iso9660 filesystem and that <filename>bootlx</filename> has been +copied into the +root directory of that filesystem. That's it! +</Para> + +</Sect2> + +<Sect2 id="Building-Linux"> +<Title>Building the Linux Kernel</Title> + +<Para> +A bootable Linux kernel can be built with the following steps. +During the <command>make config</command>, be sure to answer "yes" to the +question +whether you want to boot the kernel via SRM (for certain platforms +this is automatically selected). Note that if you build a generic +kernel (by selecting "Generic" as the alpha system type), the kernel +is able to guess whether it is running under SRM or not. + +<Screen> +# cd /usr/src/linux +# make config +# make dep +# make boot +# make modules (if applicable) +# make modules_install (if applicable) +</Screen> + +</Para> + +<Para> +The last command will build the file +<filename>arch/alpha/boot/vmlinux.gz</filename> which can then be copied to the +disk from which you want to boot from. In our floppy disk example +above, this would entail: + +<Screen> +# mount /dev/fd0 /mnt +# cp arch/alpha/boot/vmlinux.gz /mnt +# umount /mnt +</Screen> + +</Para> + +</Sect2> + +<Sect2 id="booting"> +<Title>Booting Linux</Title> + +<Para> + With the SRM firmware and <Literal remap="tt">aboot</Literal> installed, Linux is generally +booted with a command of the form: + +<Screen> +<Literal remap="tt">boot</Literal> <Emphasis remap="it">devicename</Emphasis> <Literal remap="tt">-fi</Literal> <Emphasis remap="it">filename</Emphasis> +<Literal remap="tt">-fl</Literal> <Emphasis remap="it">flags</Emphasis> +</Screen> + +</Para> + +<Para> +The <Emphasis remap="it">filename</Emphasis> and <Emphasis remap="it">flags</Emphasis> arguments are optional. If +they are not specified, SRM uses the default values stored in +environment variables <varname>BOOTDEF_DEV</varname>, +<varname>BOOT_OSFILE</varname> and +<varname>BOOT_OSFLAGS</varname>. The +syntax and meaning of these two arguments is described in more detail +below. To list the current values of these variables type +<command>show boot*</command> at the SRM command prompt. This will also show a +<varname>boot_dev</varname> variable (among others), this variable is +read only +and needs to be changed via the <varname>bootdef_dev</varname> variable. +</Para> + +<Sect3 id="device-naming"> +<Title>Device Naming</Title> + +<Para> +This corresponds to the device from which SRM will attempt to boot. Examples include: +</Para> + +<Para> +<VariableList> + +<VarListEntry> +<Term>dva0</Term> +<ListItem> +<Para> +- First floppy drive, <filename>/dev/fd0</filename> under Linux +</Para> +</Listitem> +</VarListEntry> +<VarListEntry> +<Term>dqa0</Term> +<ListItem> +<Para> +- Primary IDE CD-ROM or hard disk as Master, <filename>/dev/hda</filename> + under Linux +</Para> +</Listitem> +</VarListEntry> +<VarListEntry> +<Term>dqa1</Term> +<ListItem> +<Para> +- Primary IDE CD-ROM or hard disk as Slave, <filename>/dev/hdb</filename> + under Linux +</Para> +</Listitem> +</VarListEntry> +<VarListEntry> +<Term>dka0</Term> +<ListItem> +<Para> +- SCSI disk on first bus, Device 0, <filename>/dev/sda</filename> under Linux +</Para> +</Listitem> +</VarListEntry> +<VarListEntry> +<Term>ewa0</Term> +<ListItem> +<Para> +- First Ethernet Device, <filename>/dev/eth0</filename> under Linux +</Para> +</Listitem> +</VarListEntry> +</VariableList> +</Para> + +<Para> +For example to boot from the disk at SCSI id 6, you would enter: + +<Screen> +>>> boot dka600 +</Screen> + +</Para> + +<Para> +To list the devices currently installed in the system type +<command>show dev</command> at the SRM command line. In contrast to Linux +device naming, the +partition number on a disk device is <Emphasis>not</Emphasis> given as part of the +device name (you may see extra numbers after the device names when +running <command>show dev</command> - these correspond to things like PCI bus and +device numbers and are not useful to the user). Remember, as +mentioned in <XRef LinkEnd="how-srm-boots">, that SRM knows <Emphasis>nothing</Emphasis> +about partitions or disklabels - it merely reads a boot block and +secondary bootstrap from sectors on a disk. Therefore, the partition +number is given as part of the boot filename. +</Para> + +</Sect3> + +<Sect3> +<Title>Boot Filename</Title> + +<Para> +The filename argument takes the form: +<QUOTE +>[<Emphasis>n</Emphasis>/]<Emphasis>filename</Emphasis></QUOTE +> +</Para> + +<Para> +<Emphasis>n</Emphasis> is a single digit in the range 1..8 that gives the partition +number from which to boot from. <filename>filename</filename> is the path of the file +you want boot. For example to boot a kernel named +<filename>vmlinux.gz</filename> from the second partition of SCSI +device 6, you would enter: + +<Screen> +>>> boot dka600 -file 2/vmlinux.gz +</Screen> + +</Para> + +<Para> +Or to boot from floppy drive 0, you'd enter: + +<Screen> +>>> boot dva0 -file vmlinux.gz +</Screen> + +</Para> + +<Para> +If a disk has no partition table, <Literal remap="tt">aboot</Literal> pretends the disk +contains one <Literal remap="tt">ext2</Literal> partition starting at the first diskblock. +This allows booting from floppy disks. +</Para> + +<Para> +As a special case, partition number 0 is used to request booting +from a disk that does not (yet) contain a file system. When +specifying "partition" number 0, <Literal remap="tt">aboot</Literal> assumes that the Linux +kernel is stored right behind the <Literal remap="tt">aboot</Literal> image. Such a layout +can be achieved with the <command>swriteboot</command> command. For example, to +setup a filesystem-less boot from <filename>/dev/sda</filename>, one could use +the command: + +<Screen> +# swriteboot /dev/sda bootlx vmlinux.gz +</Screen> + +</Para> + +<Para> +Booting a system in this way is not normally necessary. The +reason this feature exists is to make it possible to get Linux +installed on a systems that can't boot from a floppy disk (e.g., the +Jensen). +</Para> + +</Sect3> + +<Sect3> +<Title>Boot Flags</Title> + +<Para> +A number of bootflags can be specified. The syntax is: + +<Screen> +-flags "options..." +</Screen> + +</Para> + +<Para> +Where "options..." is any combination the following options (separated +by blanks). There are many more bootoptions, depending on what +drivers your kernel has installed. The options listed below are +therefore just examples to illustrate the general idea: +</Para> + +<Para> +<VariableList> + +<VarListEntry> +<Term>load_ramdisk=1</Term> +<ListItem> +<Para> +Copy root file system from a (floppy) disk to the RAM disk +before starting the system. The RAM disk will be used in +lieu of the root device. This is useful to bootstrap Linux +on a system with only one floppy drive. +</Para> +</Listitem> +</VarListEntry> +<VarListEntry> +<Term>floppy=<Emphasis>str</Emphasis></Term> +<ListItem> +<Para> +Sets floppy configuration to <Emphasis>str</Emphasis>. +</Para> +</Listitem> +</VarListEntry> +<VarListEntry> +<Term>root=<Emphasis>dev</Emphasis></Term> +<ListItem> +<Para> +Select device <Emphasis>dev</Emphasis> as the root-file +system. The device can be specified as a major/minor hex number (e.g., +0x802 for <filename>/dev/sda2</filename>) or one of a few canonical names (e.g., +<filename>/dev/fd0</filename>, <filename>/dev/sda2</filename>). +</Para> +</Listitem> +</VarListEntry> +<VarListEntry> +<Term>single</Term> +<ListItem> +<Para> +Boot system in single user mode. +</Para> +</Listitem> +</VarListEntry> +<VarListEntry> +<Term>kgdb</Term> +<ListItem> +<Para> +Enable kernel-gdb (works only if <varname>CONFIG_KGDB</varname> is +enabled; a second Alpha system needs to be connected over the serial +port in order to make this work) +</Para> +</Listitem> +</VarListEntry> +</VariableList> +</Para> + +<Para> +Some SRM implementations (e.g., the one for the Jensen) are +handicapped and allow only short option strings (e.g., at most 8 +characters). In such a case, <Literal remap="tt">aboot</Literal> can be booted with the +single-character boot flag "i". With this flag, <Literal remap="tt">aboot</Literal> will +enter interactive mode +</Para> + +</Sect3> + +<Sect3> +<Title>Using aboot interactively</Title> + +<Para> +As of version 0.6, <Literal remap="tt">aboot</Literal> supports a simple command-oriented +interactive mode. Note that this is <Emphasis>different</Emphasis> from the prompt +which previous versions issued when booted with the "i" flag, or after +failing to load a kernel. You can get a summary of the available +commands by typing "h" or "?" at the prompt: + +<Screen> +>>> boot dka0 -fl i +aboot> ? + h, ? Display this message + q Halt the system and return to SRM + p 1-8 Look in partition <num> for configuration/kernel + l List pre-configured kernels + d <dir> List directory <dir> in current filesystem + b <file> <args> Boot kernel in <file> (- for raw boot) + with arguments <args> + 0-9 Boot pre-configuration 0-9 (list with 'l') +aboot> b 3/vmlinux.gz root=/dev/sda3 single +</Screen> + +</Para> + +</Sect3> + +<Sect3> +<Title>The <filename>aboot.conf</filename> configuration file</Title> + +<Para> +Since booting in that manner quickly becomes tedious, <Literal remap="tt">aboot</Literal> +allows to define short-hands for frequently used command lines. In +particular, a single digit option (0-9) requests that <Literal remap="tt">aboot</Literal> uses +the corresponding option string stored in file +<filename>etc/aboot.conf</filename>. A sample <filename>aboot.conf</filename> is shown below: + +<Screen> +# +# aboot default configurations +# +0:3/vmlinux.gz root=/dev/sda3 +1:3/vmlinux.gz root=/dev/sda3 single +2:3/vmlinux.new.gz root=/dev/sda3 +3:3/vmlinux root=/dev/sda3 +8:- root=/dev/sda3 # fs-less boot of raw kernel +9:0/vmlinux.gz root=/dev/sda3 # fs-less boot of (compressed) ECOFF kernel +- +</Screen> + +</Para> + +<Para> +With this configuration file, the command + +<Screen> +>>> boot dka0 -fl 1 +</Screen> + +corresponds exactly to the boot command shown above. +</Para> + +<Para> +Finally, at the <Literal remap="tt">aboot</Literal> prompt, it is possible to enter one of the +single character flags ("0"-"9") to get the same effect as if that +flag had been specified in the boot command line. As noted in the +help text cited above, you can also list the available default +configurations with the "l" command. +</Para> + +<Sect4> +<Title>Selecting the Partition of <filename>etc/aboot.conf</filename></Title> + +<Para> +When installed on a harddisk, <Literal remap="tt">aboot</Literal> needs to know what +partition to search for the <filename>/etc/aboot.conf</filename> file. A newly +compiled <Literal remap="tt">aboot</Literal> will search the <Emphasis>second</Emphasis> partition (e.g., +<filename>/dev/sda2</filename>). Since it would be inconvenient to have to +recompile <Literal remap="tt">aboot</Literal> just to change the partition number, +<Literal remap="tt">abootconf</Literal> allows to directly modify an installed <Literal remap="tt">aboot</Literal>. +Specifically, if you want to change <Literal remap="tt">aboot</Literal> to use the <Emphasis>third</Emphasis> +partition on disk <filename>/dev/sda</filename>, you'd use the command: + +<Screen> +# abootconf /dev/sda 3 +</Screen> +</Para> + +<Para> +You can verify the current setting by simply omitting the partition +number. That is: <command>abootconf /dev/sda</command> will print the currently +selected partition number. Note that <Literal remap="tt">aboot</Literal> does have to be +installed already for this command to succeed. As of version 0.6, +<Literal remap="tt">swriteboot</Literal> it will preserve the existing configuration when +installing a new <Literal remap="tt">aboot</Literal> on a hard disk. +</Para> + + +<Para> +Since <Literal remap="tt">aboot</Literal> version 0.5, it is also possible to select the +<filename>aboot.conf</filename> partition via the boot command line. This can +be +done with a command line of the form <Emphasis remap="it">a</Emphasis><Literal remap="tt">:</Literal><Emphasis remap="it">b</Emphasis> +where <Emphasis remap="it">a</Emphasis> +is the partition that holds <filename>etc/aboot.conf</filename> and <Emphasis remap="it">b</Emphasis> is a +single-letter option as described above (<Literal remap="tt">0</Literal>-<Literal remap="tt">9</Literal>, <Literal remap="tt">i</Literal>, or +<Literal remap="tt">h</Literal>). For example, if you type +<command>boot -fl "3:h" dka100</command> the +system boots from SCSI ID 1, loads <filename>etc/aboot.conf</filename> from the +third partition, prints its contents on the screen and waits for you +to enter the boot options. +</Para> + +</Sect4> + +</Sect3> + +</Sect2> + +<Sect2 id="DHCP-and-BOOTPD-server-setup"> +<Title>Setting up a BOOTP capable server using DHCP</Title> + +<Para> +The following configuration assumes that the server is running RH-6.2. +Prerequisites packages are, +<ItemizedList> +<Listitem> +<Para> +dhcp-2.0.5 +</Para> +</Listitem> +<Listitem> +<Para> +tftp-server-0.16.5 +</Para> +</Listitem> +</Itemizedlist> + +</Para> + +<Sect3> +<Title>DHCP & BOOTP configuation</Title> +<Para> +Once those packages are installed there are a few setup issues to take care of. +</Para> + +<Para> +Create the default directory to which files will be pulled from using tftp. +</Para> +<Screen> +# mkdir /tftpboot +</Screen> + +<Para> +Create the <filename>dhcp.leases</filename> file which is not create per default +(though it should be) when +you install the dhcp package so the dhcp server may start. +</Para> + +<Screen> +# mkdir -p /var/state/dhcp +# touch /var/state/dhcp/dhcpd.leases +</Screen> + +<Para> +Configure the inetd to accept the tftp service. Edit your +<filename>/etc/inetd.conf</filename> file and locate +the following line. Then uncomment it and save the file. +</Para> + +<Screen> +#tftp dgram udp wait root /usr/sbin/tcpd in.tftpd +</Screen> + +<Para> +Create the <filename>/etc/dhcp.conf</filename> configuation file. An example +config is provided below with the directives which allow BOOTP. +</Para> + +<Screen> +subnet 192.168.1.0 netmask 255.255.255.0 { + option routers 192.168.1.1; + option subnet-mask 255.255.255.0; + option nis-domain "alphalinux.org"; + option domain-name "alphalinux.org"; + option domain-name-servers 192.168.1.2; + range 192.168.1.3 192.168.1.254; + range dynamic-bootp 192.168.1.3 192.168.1.254; + default-lease-time 21600; + max-lease-time 43200; + allow bootp; + allow booting; + filename "/tftpboot/vmlinux.bootp"; +} +</Screen> + +<Sect4> +<Title>Examination of <filename>/etc/dhcp.conf</filename></Title> +<Para> +There are four directives that you should be concerned with. +</Para> + +<ItemizedList> +<Listitem> +<Para><Literal remap="tt">range dynamic-bootp 192.168.1.3 192.168.1.254;</Literal> +which defines the range of ip's available for bootp. +</Para></Listitem> +<Listitem><Para> +<Literal remap="tt">allow bootp;</Literal> +which tells the dhcp server to allow the bootp protocol.. +</Para></Listitem> +<Listitem><Para> +<Literal remap="tt">allow booting;</Literal> +which tells the dhcp server to allow the transfer of the file specified +either in the the "filename" directive or passed in the "-file" flag in SRM. +</Para></Listitem> +<Listitem><Para> +<Literal remap="tt">filename "<filename>/tftpboot/vmlinux.bootp</filename>";</Literal> + which is the default file which is transferred and executed when no filename +specified in SRM as an argument. +</Para></Listitem> +</ItemizedList> + + + +<Para>Lastly, Restart the inetd daemon so that the changes we made can take effect</Para> + +<Screen># service inet restart</Screen> + +<Para>You should now have a DHCP server that is capable of BOOTP.</Para> +</Sect4> +</Sect3> + +<Sect3> +<Title id="bootpd-setup">bootpd configuration</Title> +<Para> +The bootpd is the older way of making a bootp server and for the most part is not used anymore +in lieu of more modern DHCP servers that are capable of handling the protocol with minimal configuration +and more flexibility. This style of setup does not allow just any client to be granted a BOOTP request. +Instead you must specify the ip address and MAC address of the allowed clients. Naturally this could get +quite tedious if you where say administrating more than a few machines. +</Para> + +<Para> +bootpd rpms can be found on older versions of RedHat's distributions like version 5.2 and below. Note: +the rpm itself is named bootp though the package does contain the bootpd filename. It is available +for download at your favorite RedHat <ulink url="ftp://ftp.freesoftware.com/.1/linux/redhat/old-releases/redhat-5.2/alpha/RedHat/RPMS/">mirror</ulink>. +The bootp package requires the tftp-server just as before and the location to where the files are grabbed from is the same. +</Para> + +<Para> +Once installed you must configure your inetd service to talk to the bootpd daemon. Uncomment the following line in your <filename>/etc/inetd.conf</filename>. +</Para> +<Screen> +#bootps dgram udp wait root /usr/sbin/tcpd bootpd +</Screen> +<Para> +Then restart the inetd. +</Para> +<Screen> +# service inet restart +</Screen> + +<Para> +Configuring the <filename>/etc/bootptab</filename> file. The +<filename>bootptab</filename> file +has one entry describing each client that is allowed to boot from +the server. For example, if you want to boot the machine +<Literal remap="tt">voodoo.alphalinux.org</Literal>, then an entry of the following form would +be needed: + +<Screen> +voodoo.alphalinux.org:\ + :hd=/tftpboot/:bf=vmlinux.bootp:\ + :ht=ethernet:ha=08012B1C51F8:hn:vm=rfc1048:\ + :ip=192.12.69.254:bs=auto: +</Screen> + +</Para> + +<Para> +This entry assumes that the machine's Ethernet address is +<Literal remap="tt">08012B1C51F8</Literal> and that its IP address is 192.12.69.254. The +Ethernet address can be found with the <command>show device</command> command +of the SRM console or, if Linux is running, with the <command>ifconfig</command> +command. +The entry also defines that if the client does not specify otherwise, +the file that will be booted is <filename>vmlinux.bootp</filename> in directory +<filename>/tftpboot</filename>. For more information on configuring <Literal remap="tt">bootpd</Literal>, +please refer to its man page. +</Para> + +</Sect3> + + +</Sect2> + + +<Sect2 id="Network-Booting"> +<Title>Booting Over the Network</Title> + +<Para> +Three steps are necessary before Linux can be booted via +a network. First you need an Ethernet adapter that is supported by SRM. +Most version of SRM support the DE500 series of cards, with newer +versions (5.6 and later) also supporting the Intel EtherExpress/Pro series +of cards. +Second, you need to set the SRM environment variables to +enable booting via the bootp protocol and third you need to setup +another machine as the your boot server. Enabling bootp in SRM is +usually done by setting the ewa0_protocol (DE500 cards) or eia0_protocol (Intel cards) variable to bootp. + +<Screen> +>>> set ewa0_protocol bootp +</Screen> +</Para> + +<Para> +Also check to see that your ethernet device has a link light to whatever hub or switch it is connected to. If you +do not see a link light try forcing the negotiation of the ethernet device. For example: +</Para> + +<Screen> +>>> set ewa0_mode FastFD +</Screen> + +<Para> Would set the DE500 ethernet card to fast full duplex operation. To see a list of the available modes</Para> + +<Screen> +>>> set ewa0_mode +</Screen> + +<Para> +Netboot using the aboot sources is currently broken though for the curious the steps needed are further below. Instead use the directions for netbooting using the kernel sources. +</Para> + +<Sect3> +<Title>Netboot using the kernel sources</Title> + +<Para> +<OrderedList> +<Listitem> +<Para> +Make sure the kernel you want to boot has already been built +</Para> +</Listitem> +<Listitem> +<Para> +Execute the following while in the linux source dir: + <ItemizedList> + <Listitem> + <Para> + <Literal><command>make bootimage</command></Literal> + </Para> + </Listitem> + <Listitem> + <Para> + <Literal><command>make bootpfile</command></Literal> + </Para> + </Listitem> + </Itemizedlist> +</Para> + +<Para> +This creates a uncompressed kernel named <filename>bootpfile</filename> located +in <filename>arch/alpha/boot/</filename>. Note that this kernel is +significantly larger than that produced by the aboot sources. +</Para> +</Listitem> +<Listitem> +<Para> +Copy bootpfile to the bootp server's directory. With a default setup the tftp server would look in +<filename>/tftpboot</filename> so copy <filename>bootpfile</filename> into +<filename>/tftpboot</filename>. + +</Para> +</Listitem> +</Orderedlist> +</Para> +</Sect3> + + +<Sect3> +<Title>Netboot using the aboot sources</Title> +<Para> +<OrderedList> +<Listitem> +<Para> +Build aboot with with the command <command>make netboot</command>. +</Para> +</Listitem> +<Listitem> +<Para> +Make sure the kernel that you want to boot has been built already. + +By default, the aboot Makefile uses the kernel in +<filename>/usr/src/linux/arch/alpha/boot/vmlinux.gz</filename> (edit the +Makefile if you want to use a different path). The result of +<command>make netboot</command> is a file called +<filename>vmlinux.bootp</filename> + which contains aboot and the Linux kernel, ready for network booting. +</Para> +</Listitem> +<Listitem> +<Para> + +Copy <filename>vmlinux.bootp</filename> to the bootp server's directory. In the +example above, you'd copy it into <filename>/tftpboot/vmlinux.bootp</filename>. +</Para> +</Listitem> +</Orderedlist> +</Para> +<Para> +Next, power up the client machine and boot it, specifying the Ethernet adapter as the boot device. Typically, SRM calls the DEC based Ethernet adapter ewa0 and the Intel based adapter +eia0, so to boot from that device, you'd use the command: +<screen> + >>> boot ewa0 +</screen> +</Para> +<Para> +The -fi and -fl options can be used as usual. For example, +</Para> +<Para> +<screen> + >>> boot ewa0 -fi bootpfile -fl "root=/dev/hda2" +</screen> +</Para> +<Para> +In particular, you can ask aboot to prompt for Linux kernel arguments by specifying the option +-fl i . +</Para> +</Sect3> +<Sect3> +<Title>Updating the SRM console through BOOTP</Title> +<Para> +Updating your SRM console over the network through BOOTP is just as easy as booting the Linux kernel +in the same manner. The hardware prerequisites are the same as netbooting Linux. +</Para> + +<Para> +First you have to obtain an SRM image that is able to BOOTP over the network. These images normally +have a .exe extension. For DEC/Compaq/HP Alpha products these images can be found at +<ulink url="ftp://ftp.digital.com/pub/Digital/Alpha/firmware/">ftp://ftp.digital.com/pub/Digital/Alpha/firmware/</ulink>; you will need version 5.8 or later. For access you might need to use an proper ftp client. You can also find these files on the Alpha Systems Firmware Update CD-ROM. <ulink url="http://www.api-networks.com">API NetWorks</ulink> did not offer any net bootable SRM image. +</Para> + +<!-- +ftp://ftp.digital.com/pub/Digital/Alpha/firmware/index.html [openvms ask the wizard link] +or +ftp://ftp.digital.com/pub/DEC/Alpha/firmware/index.html [alpha site left nav firmware link] +but I think they are the same location. +ftp://ftp.digital.com/pub/Digital/Alpha/firmware/archive/ for old images +--> + +<Para> +For example say you had a DS20 and wanted to update it's firmware over the network using BOOTP. You would have to, +<OrderedList> +<Listitem><Para>Get the correct firmware image for the DS20 that supported BOOTP execution which in this case the filename is +<filename>ds20_v5_8.exe</filename> from <ulink url="ftp://gatekeeper.dec.com/pub/DEC/Alpha/firmware/v5.8/">ftp://gatekeeper.dec.com/pub/DEC/Alpha/firmware/v5.8/</ulink>.</Para> +</Listitem> +<Listitem> +<Para>Copy the file to the <filename>/tftpboot</filename> folder located on the +BOOTP server.</Para> <!-- FIXME Folder vs. Directory --> +</Listitem> +</OrderedList> +</Para> + +<Para> +To execute the update from SRM you would do the following: +</Para> +<Screen>>>> b ewa0 -fi ds20_v5_8.exe</Screen> +<Para> +SRM would then proceed to upgrade the firmware in the same fashion as if you had done the firmware update from a CD. +</Para> + +</Sect3> + +</Sect2> + + + +<Sect2> +<Title>Partitioning Disks</Title> + +<Sect3> +<Title>What is a disklabel?</Title> + +<Para> +A disk label is a partition table. Unfortunately, there are several +formats the partition table can take, depending on the operating +system. +</Para> + +<Para> +DOS partition tables are the standard used by Linux and +Windows. AlphaBIOS systems and every Linux kernel can read DOS +partition tables. Unfortunately, the SRM console's boot sector format +overlaps with parts of the DOS partition table on disk, and therefore +DOS partition tables cannot be used with SRM. +</Para> + +<Para> +BSD disklabels are used by several variants of Unix, including +<productname>Tru64</productname>. SRM's boot block does not conflict with +the BSD disklabel (in +fact, the BSD disklabel resides entirely within "reserved" areas of +the first sector), and Linux can use a BSD disklabel, provided that +support for BSD disklabels has been compiled into the kernel. +</Para> + +<Para> +To boot from a disk using SRM, a BSD disklabel is required. If the +disk is not a boot disk, the BSD disklabel is not required. A BSD +disklabel can be created using fdisk, the standard Linux disk +partitioning tool. +</Para> + +</Sect3> + +<Sect3> +<Title>Partitioning the Easy Way: a DOS Disklabel</Title> + +<Para> +The simplest way to partition your disk is to let your Linux installer +do it for you, for example by using Red Hat's disk druid or fdisk. On +Red Hat 6.1, this will produce a valid BSD disklabel, but +<Emphasis>only</Emphasis> if the disk in question previously contained one. In +most cases, this will produce a DOS disklabel. It will be readable by +Linux, but you will not be able to boot from it via SRM. For this +reason, you will probably want to create a BSD disklabel manually in +order to boot Linux +</Para> + +</Sect3> + +<Sect3> +<Title>Partitioning with a BSD Disklabel</Title> + +<Para> + +<OrderedList> +<ListItem> + +<Para> +Start fdisk on the disk you're configuring +</Para> +</ListItem> +<ListItem> + +<Para> +Choose to make a BSD disklabel - option 'b' (newer versions of +fdisk will detect existing BSD disklabels and automatically enter +disklabel mode) +</Para> +</ListItem> +<ListItem> + +<Para> +You'll notice some things: Partitions are letters instead of +numbers, from a-h Partition 'c' covers the whole of the disk. This is +the convention, don't touch it. While you can see it, note down the +disk parameters as you'll use them more often than with the +DOS-disklabel approach +</Para> +</ListItem> +<ListItem> + +<Para> +Creating a new partition uses the same procedure as the +DOS-disklabel approach, except that the partitions are referred to by +letter instead of number. That is, 'n' to make a new partition +followed by the partition letter followed by the starting block +followed by the end block +</Para> +</ListItem> +<ListItem> + +<Para> +Setting partition type is slightly different, because the +numbering scheme is different (1 is swap, 8 is ext2). +</Para> +</ListItem> +<ListItem> + +<Para> +When you are finished, write ('w') and quit ('q') as normal. +</Para> +</ListItem> + +</OrderedList> + +</Para> + +<Para> +There are some important catches that you must be aware of when +partitioning using a BSD disklabel: + +<ItemizedList> +<ListItem> + +<Para> +Partition 'a' should start about 1M into the disk: don't start +it at sector 1, try starting at sector 10 (for example). This leaves +plenty of space for writing the boot block (see below) +</Para> +</ListItem> +<ListItem> + +<Para> +There is a bug in some versions of fdisk which makes the disk +look one sector bigger than it actually is. The listing when you +create the BSD disklabel is correct. The last sector of partition 'c' +is correct. The default last sector when creating a new partition is +1 sector too big +</Para> +</ListItem> +<ListItem> + +<Para> +Always adjust for this extra sector. This bug exists in the +version of fdisk shipped with Red Hat 6.0. Not making an adjustment +for this problem almost always leads to "Access beyond end of device" +errors from the Linux kernel. +</Para> +</ListItem> + +</ItemizedList> + +</Para> + +<Para> +Once you have made a BSD disklabel, continue the installation. After +installation, you can write a boot block to your disk to make it +bootable from SRM. +</Para> + +</Sect3> + +</Sect2> + +</Sect1> + +<Sect1 id="SRM-sharingWithDEC"> +<Title>Sharing a Disk With <productname>HP Tru64</productname></Title> + +<Para> +Unfortunately, <productname>HP Tru64</productname> doesn't know anything about Linux, so sharing +a single disk between the two OSes is not entirely trivial. However, +it is not a difficult task if you heed the tips in this section. The +section assumes you are using <Literal remap="tt">aboot</Literal> version 0.5 or newer. +</Para> + +<Sect2> +<Title>Partitioning the disk</Title> + +<Para> +First and foremost: <Emphasis>never</Emphasis> use any of the Linux partitioning +programs (<Literal remap="tt">minlabel</Literal> or <Literal remap="tt">fdisk</Literal>) on a disk that is also +used by <productname>HP Tru64</productname>. The Linux <Literal remap="tt">minlabel</Literal> program uses the same +partition table format as <productname>HP Tru64</productname> <Literal remap="tt">disklabel</Literal>, but there are +some incompatibilities in the data that <Literal remap="tt">minlabel</Literal> fills in, so +<productname>HP Tru64</productname> will simply refuse to accept a partition table generated by +<Literal remap="tt">minlabel</Literal>. To setup a Linux <Literal remap="tt">ext2</Literal> partition under <productname>HP Tru64</productname>, +you'll have to change the disktab entry for your disk. For the +purpose of this discussion, let's assume that you have an rz26 disk (a +common 1GB drive) on which you want to install Linux. The disktab +entry under <productname>HP Tru64</productname> v3.2 looks like this (see file +<filename>/etc/disktab</filename>): + +<Screen> +rz26|RZ26|DEC RZ26 Winchester:\ + :ty=winchester:dt=SCSI:ns#57:nt#14:nc#2570:\ + :oa#0:pa#131072:ba#8192:fa#1024:\ + :ob#131072:pb#262144:bb#8192:fb#1024:\ + :oc#0:pc#2050860:bc#8192:fc#1024:\ + :od#393216:pd#552548:bd#8192:fd#1024:\ + :oe#945764:pe#552548:be#8192:fe#1024:\ + :of#1498312:pf#552548:bf#8192:ff#1024:\ + :og#393216:pg#819200:bg#8192:fg#1024:\ + :oh#1212416:ph#838444:bh#8192:fh#1024: +</Screen> + +</Para> + +<Para> +The interesting fields here are <Literal remap="tt">o</Literal><Emphasis remap="it">?</Emphasis>, and +<Literal remap="tt">p</Literal><Emphasis remap="it">?</Emphasis>, where <Emphasis remap="it">?</Emphasis> is a letter in the range +<Literal remap="tt">a</Literal>-<Literal remap="tt">h</Literal> (first through 8-th partition). The <Literal remap="tt">o</Literal> +value gives the starting offset of the partition (in sectors) and the +<Literal remap="tt">p</Literal> value gives the size of the partition (also in sectors). +See <Literal remap="tt">disktab</Literal>(4) for more info. Note that <productname>HP Tru64</productname> likes to +define overlapping partitions. For the entry above, the partition +layout looks like this (you can verify this by adding up the various +<Literal remap="tt">o</Literal> and <Literal remap="tt">p</Literal> values): + +<Screen> + a b d e f +|---|-------|-----------|-----------|-----------| + + c +|-----------------------------------------------| + + g h + |-----------------|-----------------| +</Screen> <!-- FIXME This is screen? --> + +</Para> + +<Para> +<productname>HP Tru64</productname> insists that partition <Literal remap="tt">a</Literal> starts at offset 0 and that +partition <Literal remap="tt">c</Literal> spans the entire disk. Other than that, you can +setup the partition table any way you like. +</Para> + +<Para> +Let's suppose you have <productname>HP Tru64</productname> using partition <Literal remap="tt">g</Literal> and want to +install Linux on partition <Literal remap="tt">h</Literal> with partition <Literal remap="tt">b</Literal> being a +(largish) swap partition. To get this layout without destroying the +existing <productname>HP Tru64</productname> partition, you need to set the partition types +explicitly. You can do this by adding a <Literal remap="tt">t</Literal> field for each +partition. In our case, we add the following line to the above +disktab entry. + +<Screen> + :ta=unused:tb=swap:tg=4.2BSD:th=resrvd8: +</Screen> + +</Para> + +<Para> +Now why do we mark partition <Literal remap="tt">h</Literal> as "reservd8" instead of "ext2"? +Well, <productname>HP Tru64</productname> doesn't know about Linux. It so happens that partition +type "ext2" corresponds to a numeric value of 8, and <productname>HP Tru64</productname> uses the +string "reservd8" for that value. Thus, in <productname>HP Tru64</productname> speak, "reservd8" +means "ext2". OK, this was the hard part. Now we just need to +install the updated disktab entry on the disk. Let's assume the disk +has SCSI id 5. In this case, we'd do: + +<Screen> +# disklabel -rw /dev/rrz5c rz26 +</Screen> + +</Para> + +<Para> +You can verify that everything is all right by reading back the +disklabel with <command>disklabel -r /dev/rrz5c</command>. At this point, you +may want to reboot <productname>HP Tru64</productname> and make sure the existing <productname>HP Tru64</productname> +partition is still alive and well. If that is the case, you can shut +down the machine and start with the Linux installation. Be sure to +skip the disk partitioning step during the install. Since we already +installed a good partition table, you should be able to proceed and +select the 8th partition as the Linux root partition and the 2nd +partition as the swap partition. If the disk is, say, the second SCSI +disk in the machine, then the device name for these partitions would +be <filename>/dev/sdb8</filename> and <filename>/dev/sdb2</filename>, +respectively (note that +Linux uses letters to name the drives and numbers to name the +partitions, which is exactly reversed from what <productname>HP Tru64</productname> does; the +Linux scheme makes more sense, of course ;-). +</Para> + +</Sect2> + +<Sect2> +<Title>Installing <Literal remap="tt">aboot</Literal></Title> + +<Para> +<Emphasis>First big caveat</Emphasis>: with the SRM firmware, you can boot one and +only one operating system per disk. For this reason, it is generally +best to have at least two SCSI disks in a machine that you want to +dual-boot between Linux and <productname>HP Tru64</productname>. Of course, you could also boot +Linux from a floppy if speed doesn't matter or over the network, if +you have a <Literal remap="tt">bootp</Literal>-capable server. But in this section we assume +you want to boot Linux from a disk that contains one or more <productname>HP Tru64</productname> +partitions. +</Para> + +<Para> +<Emphasis>Second big caveat</Emphasis>: installing <Literal remap="tt">aboot</Literal> on a disk shared with +<productname>HP Tru64</productname> renders the first and third partition unusable (since those +<Emphasis>must</Emphasis> have a starting offset of 0). For this reason, we recommend +that you change the size of partition <Literal remap="tt">a</Literal> to something that is just +big enough to hold <Literal remap="tt">aboot</Literal> (1MB should be plenty). +</Para> + +<Para> +Once these two caveats are taken care of, installing <Literal remap="tt">aboot</Literal> is +almost as easy as usual: since partition <Literal remap="tt">a</Literal> and <Literal remap="tt">c</Literal> will +overlap with <Literal remap="tt">aboot</Literal>, we need to tell <Literal remap="tt">swriteboot</Literal> that this is +indeed OK. We can do this under Linux with a command line of the +following form (again, assuming we're trying to install <Literal remap="tt">aboot</Literal> on +the second SCSI disk): + +<Screen> +# swriteboot -f1 -f3 /dev/sdb bootlx +</Screen> + +</Para> + +<Para> +The <Literal remap="tt">-f1</Literal> means that we want to force writing +<filename>bootlx</filename> even +though it overlaps with partition 1. The corresponding applies for +partition 3. +</Para> + +<Para> +This is it. You should now be able to shutdown the system and boot +Linux from the harddisk. In our example, the SRM command line to do +this would be: + +<Screen> +>>> boot dka5 -fi 8/vmlinux.gz -fl root=/dev/sdb8 +</Screen> + +</Para> + +</Sect2> + +</Sect1> + +<Sect1 id="SRM-Distributions"> +<Title>Installation of Distributions</Title> + +<Sect2> +<Title>RedHat 6.0, 6.1 and 6.2</Title> + +<Sect3> +<Title>Installation from the Red Hat 6.0, 6.1 or 6.2 CD</Title> + +<Para> +Red Hat have made their distribution CD bootable from SRM console +<FOOTNOTE> + +<Para> +Please note that through the official RedHat CD-ROM is SRM +bootable, copies made by various other companies may not be +bootable. +</Para> + +</FOOTNOTE> + +To start an installation, put the CD in and type +the following: + +<Screen> +>>> boot srm-device -file kernels/generic.gz -flags root=linux-device +</Screen> + +</Para> + +<Para> +In the above, the SRM device name and Linux device name for your +CD-ROM drive are needed. For Example if the machine had an IDE CD-ROM +installed as primary master the command would look like this: + +<Screen> +>>> boot dqa0 -file kernels/generic.gz -flags "root=/dev/hda" +</Screen> + +</Para> + +<Para> +See the section on <XRef LinkEnd="device-naming"> conventions if you don't know what these are. +</Para> + +</Sect3> + +</Sect2> + +<!-- FIXME Newer RedHat ?? --> + +<Sect2> +<Title>SuSE 6.1</Title> + +<Sect3> +<Title>Installation from the SuSE 6.1 CD</Title> + +<Para> +The SuSE 6.1 CD is not bootable from SRM console. SuSE have an +alternative approach which involves creating two boot floppies, the +images of which are included on the CD. The boot disks can be created +in various ways, depending on the systems you have available +</Para> + +<Para> +Writing the boot disks from a linux system +The command to use is dd. From the mount-point of SuSE CD 1, the commands are: + +<Screen> +# dd if=disks/aboot of=/dev/fd0 +# dd if=disks/install of=/dev/fd0 +</Screen> + +</Para> + +<Para> +For writing the boot disks from a windows system, the command to use +is rawrite. It is available on the CD. + +<Screen> + D:\tools\> rawrite +</Screen> + +</Para> + +<Para> +The program then prompts for input disk image and output disk +drive. Run this command once for each of the disk images as shown +above. +</Para> + +<Para> +Starting the SuSE installer from the boot disks +With the floppy disk made from the aboot image in place, type: + +<Screen> +>>> boot dva0 -file vmlinux.gz -flags "root=/dev/fd0 load_ramdisk=1" +</Screen> + +</Para> + +<Para> +This will start the kernel, prompt you for the second boot disk, and start the installer +</Para> + +</Sect3> + +</Sect2> + +<Sect2> +<Title>SuSE 6.3</Title> + +<Sect3> +<Title>Installation from the SuSE 6.3 CD</Title> + +<Para> +The SuSE 6.3 CD-ROM is SRM bootable much like the RedHat 6.0 and 6.1 CD-ROMs. The best way +to start the install from SRM is to use the following command: + +<Screen> +>>> boot srm-device -flags 0 +</Screen> + +</Para> + +<Para> +In the above, the SRM device names for your +CD-ROM drive is needed. For example if the machine had an IDE CD-ROM +installed as primary master the command would look like this: + +<Screen> +>>> boot dqa0 -flags 0 +</Screen> + +SuSE has added support to aboot to allow it to load initrd files. The above command will from the +CD-ROM drive and use config number 0 from the <filename>/etc/aboot.conf</filename> file. For other variations +on this refer to the SuSE installation guide. +</Para> + +</Sect3> + +</Sect2> +<!-- FIXME Newer RedHat ?? --> +<!-- FIXME Debian ?? --> + +</Sect1> + +<Sect1 id="SRM-history"> +<Title>Document History</Title> +<para> +v0.8.1 14th February 2004 Updated by Helge Kreutzmann <email>kreutzm@physik.uni-hannover.de</email> +</para> +<ItemizedList> +<listitem> +<para> +Introduced more SGML-Tags, updated DocBook-Version +</para> +</listitem> +<listitem> +<para> +Minor typographic corrections (e.g., whitespaces) +</para> +</listitem> +<listitem> +<para> +Fixed some (outdated) URLS +</para> +</listitem> +</ItemizedList> +<Para> +v0.8 9th November 2000 Changed from Rich Payne <email>rdp@alphalinux.org</email> +<ItemizedList> +<ListItem> +<Para> + Added section on SRM Device names +</Para> +</ListItem> + +<ListItem> +<Para> + Many spelling/grammer fixes. +</Para> +</ListItem> + +</ItemizedList> +</Para> + +<Para> +v0.7.1 6th November 2000 Changes from Peter Petrakis <email>ppetrakis@alphalinux.org</email> + +<ItemizedList> +<ListItem> + +<Para> + Cleaned up netbooting section. Avoid duplicate information. +</Para> +</ListItem> +<ListItem> + +<Para> + Added DHCP/BOOTP server configuration section. +</Para> +</ListItem> + +<ListItem> +<Para> + Added SRM netbooting section. +</Para> +</ListItem> + +<ListItem> +<Para> + Put the older bootpd configuration in it's own section and elaborated on it. +</Para> +</ListItem> + +</ItemizedList> +</Para> + + +<Para> +v0.7 10th July 2000 Changes from Rich Payne <email>rdp@alphalinux.org</email> + +<ItemizedList> +<ListItem> + +<Para> + Updated for RedHat 6.2 +</Para> +</ListItem> +<ListItem> + +<Para> + Fixed aboot link for alphalinux.org and added CVS information. +</Para> +</ListItem> + +<ListItem> +<Para> + Added additional netboot information from Peter Petrakis <email>ppetrakis@alphalinux.org</email> +</Para> +</ListItem> +</ItemizedList> +</Para> + + +<Para> +v0.6.1 21 March 2000 Changes from Rich Payne <email>rdp@alphalinux.org</email> + +<ItemizedList> +<ListItem> + +<Para> + Made the installation hints a new chapter +</Para> +</ListItem> +<ListItem> + +<Para> + Added information on Netbooting +</Para> +</ListItem> +<ListItem> + +<Para> + Added to the new section on RedHat 6.1 and BSD disklabels +</Para> +</ListItem> +<ListItem> + +<Para> + Removed David Mosberger-Tang's name from the authors list +</Para> +</ListItem> +<ListItem> + +<Para> + Marked a few of the feature as being in 0.6 only +</Para> +</ListItem> +<ListItem> + +<Para> + Added info for SuSE 6.3 and RedHat 6.1 +</Para> +</ListItem> + +</ItemizedList> + +</Para> + +<Para> +v0.6 3 March 2000 Changes and information from David Huggins-Daines +<email>dhd@linuxcare.com</email> + +<ItemizedList> +<ListItem> + +<Para> +Moved the notes on MILO vs. SRM to an "About this document" section +</Para> +</ListItem> +<ListItem> + +<Para> +Added sections on switching to SRM, and basic SRM usage +</Para> +</ListItem> +<ListItem> + +<Para> +Added section on the new interactive use of aboot +</Para> +</ListItem> +<ListItem> + +<Para> +Updated the note on DOS partition tables to mention the Red Hat 6.1 +installer's behavior. +</Para> +</ListItem> +<ListItem> + +<Para> +Normalized the markup, and codified the conventions used for +user-entered commands. +</Para> +</ListItem> +<ListItem> + +<Para> +Corrected the notes on BSD disklabels (SRM does <Emphasis>not</Emphasis> +read BSD disklabels, it's just that they don't conflict with the boot +block). +</Para> +</ListItem> + +</ItemizedList> + +</Para> + +<Para> +v0.5.2 5 December 1999 Added comments and information from Stig Telfer +(<email>stig@alpha-processor.com</email>). + +<ItemizedList> +<ListItem> + +<Para> +Added chart on SRM to Linux name mappings +</Para> +</ListItem> +<ListItem> + +<Para> +Added RedHat 6.0 and SuSE 6.1 installation information +</Para> +</ListItem> +<ListItem> + +<Para> +Added Disk Partitioning Information +</Para> +</ListItem> + +</ItemizedList> + +</Para> + +<Para> +v0.5.1 (Not Released) 13 November 1999 Took the original 0.5 document and updated several parts: +</Para> + +<Para> + +<ItemizedList> +<ListItem> + +<Para> +Update information on SRM booting from IDE devices +</Para> +</ListItem> +<ListItem> + +<Para> +Fixed URL to aboot source +</Para> +</ListItem> +<ListItem> + +<Para> +Update toc page to reflect MILO's future +</Para> +</ListItem> +<ListItem> + +<Para> +Included information on bootdef_dev and boot_dev to chapter 3 +</Para> +</ListItem> +<ListItem> + +<Para> +Added this section +</Para> +</ListItem> + +</ItemizedList> + +</Para> + +<Para> +v0.5 17 August 1996 - Original Document by David Mosberger-Tang +</Para> + +</Sect1> + +</Article> diff --git a/package/aboot/src/doc/man/Makefile b/package/aboot/src/doc/man/Makefile new file mode 100644 index 000000000..4ccdd4c0d --- /dev/null +++ b/package/aboot/src/doc/man/Makefile @@ -0,0 +1,51 @@ +# eventually this should have rules for recreating the man pages from the +# sgml source, but since this doesn't work on my machine right now i'm +# leaving it out. + +# if this is a recursive make, and mandir was set in the top-level Makefile, +# use that value. Otherwise default to /usr/man. + +ifeq ($(mandir),) +MANDIR=/usr/man +else +MANDIR=$(mandir) +endif +MAN1=$(MANDIR)/man1 +MAN5=$(MANDIR)/man5 +MAN8=$(MANDIR)/man8 + +all: aboot.8 aboot.conf.5 abootconf.8 isomarkboot.1 sdisklabel.8 netabootwrap.1 + +install: + install -d $(MAN1) $(MAN5) $(MAN8) + install -c isomarkboot.1 netabootwrap.1 $(MAN1) + install -c aboot.conf.5 $(MAN5) + install -c aboot.8 abootconf.8 e2writeboot.8 swriteboot.8 sdisklabel.8 $(MAN8) +install-gz: install + gzip -f9 $(MAN1)/isomarkboot.1 $(MAN1)/netabootwrap.1 + gzip -f9 $(MAN5)/aboot.conf.5 + gzip -f9 $(MAN8)/aboot.8 $(MAN8)/abootconf.8 $(MAN8)/e2writeboot.8 \ + $(MAN8)/swriteboot.8 $(MAN8)/sdisklabel.8 +install-gzip: install-gz + +clean: + rm -f aboot.8 aboot.conf.5 abootconf.8 isomarkboot.1 sdisklabel.8 netabootwrap.1 manpage.log manpage.links manpage.refs + +aboot.8: aboot.sgml + nsgmls aboot.sgml | sgmlspl sgmlspl-specs/docbook2man-spec.pl + +aboot.conf.5: aboot.conf.sgml + nsgmls aboot.conf.sgml | sgmlspl sgmlspl-specs/docbook2man-spec.pl + +abootconf.8: abootconf.sgml + nsgmls abootconf.sgml | sgmlspl sgmlspl-specs/docbook2man-spec.pl + +isomarkboot.1: isomarkboot.sgml + nsgmls isomarkboot.sgml | sgmlspl sgmlspl-specs/docbook2man-spec.pl + +netabootwrap.1: netabootwrap.sgml + nsgmls netabootwrap.sgml | sgmlspl sgmlspl-specs/docbook2man-spec.pl + +sdisklabel.8: sdisklabel.sgml + nsgmls sdisklabel.sgml | sgmlspl sgmlspl-specs/docbook2man-spec.pl + diff --git a/package/aboot/src/doc/man/README b/package/aboot/src/doc/man/README new file mode 100644 index 000000000..f2af31271 --- /dev/null +++ b/package/aboot/src/doc/man/README @@ -0,0 +1,32 @@ +This compilation contains man pages for various boot aspects on the Linux/Alpha +platform. They are licensed under the GPL. Comments, suggestions and patches +should be forwarded either to me or to the current aboot maintainer. + +The following files are included: + +README this document +aboot.8 man pages for aboot +aboot.sgml sgml-source for man page for aboot +aboot.conf.5 man page for configuration file etc/aboot.conf +aboot.conf.sgml sgml-source for above man page +abootconf.8 man page for abootconf +abootconf.sgml sgml-source for man page for abootconf +e2writeboot.8 man page for e2writeboot (from aboot 7a tarball, modified) +swriteboot.8 man page for swriteboot (from debian distribution, modified) +isomarkboot.sgml sgml-source for man page for isomarkboot +isomarkboot.8 man page for isomarkboot +sdisklabel.sgml sgml-source for man page for sdisklabel +sdisklabel.8 man page for sdisklabel + +Since I have no experience regarding e2writeboot and swriteboot I made only +small modifications in these man pages. + +The list of authors was verified as best as possible (by contacting all +person still reachable via email), if you feel this is not complete/accureate +please contact me. + +Technical note: +To create the nroff version from the SGML sources, nsgml was used like + nsgmls abootconf.sgml | sgmlspl sgmlspl-specs/docbook2man-spec.pl + +Hannover, Germany, January 17th 2003 diff --git a/package/aboot/src/doc/man/aboot.8 b/package/aboot/src/doc/man/aboot.8 new file mode 100644 index 000000000..5aa86a568 --- /dev/null +++ b/package/aboot/src/doc/man/aboot.8 @@ -0,0 +1,57 @@ +.\" This manpage has been automatically generated by docbook2man-spec +.\" from a DocBook document. docbook2man-spec can be found at: +.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "ABOOT" "8" "11 Juli 2002" "aboot" "" +.SH NAME +aboot \- The secondary boot loader for Linux/Alpha +.SH "COPYRIGHT" +.PP +\fBaboot\fR is Copyright (C) 1996 Linus Torvalds, David Mosberger-Tang and Michael Schwingen +.SH "DESCRIPTION" +.PP + +\fBaboot\fR is the secondary boot loader needed if +the Linux/Alpha system is booted via SRM. It is usually installed during +system installation by \fBswriteboot\fR(8). +.PP +To automate the booting process predefined boot configurations can be stored +in \fIetc/aboot.conf\fR(5). +.PP +\fBaboot\fR can also be used interactively by issuing +.PP +\fBboot \fIdka0 -fl "i"\fB\fR +.PP +at the SRM-Prompt where dka0 has to be replaced by the device used. +.PP +In the interactive mode you can use the command h to show your current +\fIetc/aboot.conf\fR and then the appropriate number +(or a complete boot command as in SRM) to boot Linux. +.PP +If you do not want to use the \fIetc/aboot.conf\fR as set +up by \fBabootconf\fR you can explicitly tell +\fBaboot\fR where to look for \fIetc/aboot.conf\fR by prepending the number of the configuration with the proper +partition, i.e. if your \fIetc/aboot.conf\fR is on your +second partition and you want to boot the entry labeled three you would +issue +.PP +\fBboot \fIdqa -fl "2:3"\fB\fR +.PP +Note that this applies to Linux booting via SRM only as +VMS, Tru64, *BSD and +Windows NT each have their own secondary boot loader. +Furthermore \fBaboot\fR is also not needed if the system is booted via +\fBmilo\fR. +.SH "AUTHOR" +.PP +This man page was written by Helge Kreutzmann +<kreutzm@itp.uni-hannover.de> for the Debian GNU/Linux project +but may be used by others. +.SH "FILES" +.PP +\fIetc/aboot.conf\fR +.SH "SEE ALSO" +.PP +\fBabootconf\fR(8), \fIaboot.conf\fR(5), +\fBswriteboot\fR(8), HP SRM Manual diff --git a/package/aboot/src/doc/man/aboot.conf.5 b/package/aboot/src/doc/man/aboot.conf.5 new file mode 100644 index 000000000..b3cb49393 --- /dev/null +++ b/package/aboot/src/doc/man/aboot.conf.5 @@ -0,0 +1,81 @@ +.\" This manpage has been automatically generated by docbook2man-spec +.\" from a DocBook document. docbook2man-spec can be found at: +.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "ABOOT.CONF" "5" "16 Juli 2003" "aboot.conf" "" +.SH NAME +aboot.conf \- The configuration file for aboot(8) +.SH "DESCRIPTION" +.PP + +\fIaboot.conf\fR contains a list of boot settings +for \fBaboot\fR(8). Each boot setting +has a unique number which can be supplied at the SRM-Prompt. +. +.PP +\fIaboot.conf\fR must be in a directory called +\fIetc\fR on the \fBsame partition\fR +as your kernels reside on unless you explicitly list the partitions +for your kernels (see below for details). So if you create a separate +boot partition (called \fI/boot\fR) then +\fIaboot.conf\fR should reside in \fI/boot/etc/\fR. +.PP +In the following example the kernels reside on a different partition (hda4) +then \fI/\fR belongs to (hda5) while in the fourth +line \fI/boot\fR is on the same partition (hda6) as +\fI/\fR. +Therefore \fIaboot.conf\fR can be located on any of the +three partitions but \fBalways\fR in a directory +\fIetc\fR at the top level of the file system on that +partition. You can change the partition to use with +\fBabootconf\fR(8). +.PP +.SS "EXAMPLE ABOOT.CONF" +.sp +.RS +.sp +.nf +0:4/vmlinuz root=/dev/hda5 +1:4/vmlinuz root=/dev/hda5 single +2:4/vmlinuz.old ro root=/dev/hda5 +3:4/vmlinuz-2.4.9-32 root=/dev/sdc3 initrd=/initrd-2.4.9-32.img console=tty0 +8:6/boot/vmlinuz ro root=/dev/hda6 +.sp +.fi +.RE +.sp +.PP +The first number is a unique identifier for each boot configuration. +To boot a certain configuration at the SRM-Prompt you would issue +.PP +\fBboot \fIdka0 -fl "0"\fB\fR +.PP +where dka0 has to be replaced by your boot device and the boot configuration +(0 in this case) can be replaced by any defined in +\fIetc/aboot.conf\fR. +.PP +After the colon the number of the partition the kernel resides on is given. 1 +corresponds to the BSD partition labeled A:, 2 to B: and so on. +.PP +After the slash the name of the kernel to boot is given, including a possible +path. If your kernel does not reside on a file system but is located directly +after \fBaboot\fR at the beginning of the hard disk +you would omit the number, the slash and the kernel name. +.PP +Next the name of the partition to mount as \fI/\fR is given. +Other kernel parameters follow as required. As shown also an initrd can be +specified. +.PP +The contents of this file can be shown before booting if necessary by +using the interactive +mode of \fBaboot\fR(8) (booting with the flag "i") +and then issuing "h" at the \fBaboot\fR-prompt. +.SH "AUTHOR" +.PP +This man page was written by Helge Kreutzmann +<kreutzm@itp.uni-hannover.de> for the Debian GNU/Linux project but +may be used by others. +.SH "SEE ALSO" +.PP +\fBaboot\fR(8), \fBabootconf\fR(8), \fBswriteboot\fR(8), HP SRM Manual diff --git a/package/aboot/src/doc/man/aboot.conf.sgml b/package/aboot/src/doc/man/aboot.conf.sgml new file mode 100644 index 000000000..f29813e7f --- /dev/null +++ b/package/aboot/src/doc/man/aboot.conf.sgml @@ -0,0 +1,106 @@ +<!DOCTYPE RefEntry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="aboot.conf"> + +<refmeta> +<refentrytitle>aboot.conf</refentrytitle> +<manvolnum>5</manvolnum> +<refmiscinfo>aboot.conf</refmiscinfo> +</refmeta> + +<refnamediv> +<refname>aboot.conf</refname> +<refpurpose>The configuration file for <application>aboot</application>(8) +</refpurpose> +</refnamediv> + +<refsect1><title>DESCRIPTION</title> +<para> +<indexterm><primary>aboot.conf</primary></indexterm> +<filename>aboot.conf</filename> contains a list of boot settings +for <application>aboot</application>(8). Each boot setting +has a unique number which can be supplied at the SRM-Prompt. +<indexterm><primary>SRM</primary></indexterm>. +</para> +<para> +<filename>aboot.conf</filename> must be in a directory called +<filename>etc</filename> on the <emphasis>same partition</emphasis> +as your kernels reside on unless you explicitly list the partitions +for your kernels (see below for details). So if you create a separate +boot partition (called <filename>/boot</filename>) then +<filename>aboot.conf</filename> should reside in <filename>/boot/etc/</filename>. +</para> +<para> +In the following example the kernels reside on a different partition (hda4) +then <filename>/</filename> belongs to (hda5), while in the fifth +line <filename>/boot</filename> is on the same partition (hda6) as +<filename>/</filename>. +Therefore <filename>aboot.conf</filename> can be located on any of the +three partitions but <emphasis>always</emphasis> in a directory +<filename>etc</filename> at the top level of the file system on that +partition. You can change the partition to use with +<application>abootconf</application>(8). +</para> +<para><example> +<title>Example <filename>aboot.conf</filename></title> +<blockquote> +<literallayout> +0:4/vmlinuz root=/dev/hda5 +1:4/vmlinuz root=/dev/hda5 single +2:4/vmlinuz.old ro root=/dev/hda5 +3:4/vmlinuz-2.4.9-32 root=/dev/sdc3 initrd=/initrd-2.4.9-32.img console=tty0 +8:6/boot/vmlinuz ro root=/dev/hda6 +</literallayout> +</blockquote> +</example></para> +<para> +The first number is a unique identifier for each boot configuration. +To boot a certain configuration at the SRM-Prompt you would issue +</para> +<para> +<command> +boot <parameter>dka0 -fl "0"</parameter> +</command> +</para> +<para> +where dka0 has to be replaced by your boot device and the boot configuration +(0 in this case) can be replaced by any defined in +<filename>etc/aboot.conf</filename>. +</para> + +<para> +After the colon the number of the partition the kernel resides on is given. 1 +corresponds to the BSD partition labeled A:, 2 to B: and so on. +</para> + +<para> +After the slash the name of the kernel to boot is given, including a possible +path. If your kernel does not reside on a file system but is located directly +after <application>aboot</application>(8) at the beginning of the hard disk +you would omit the number, the slash and the kernel name. +</para> + +<para> +Next the name of the partition to mount as <filename>/</filename> is given. +Other kernel parameters follow as required. As shown also an initrd can be +specified. +</para> + +<para> +The contents of this file can be shown before booting if necessary by +using the interactive +mode of <application>aboot</application>(8) (booting with the flag "i") +and then issuing "h" at the <application>aboot</application>-prompt. +</para> + +</refsect1> +<refsect1><title>AUTHOR</title> +<para> +This man page was written by Helge Kreutzmann +<email>debian@helgefjell.de</email> for the Debian GNU/Linux project but +may be used by others. +</para> +</refsect1> +<refsect1><title>SEE ALSO</title> +<para><application>aboot</application>(8), <application>abootconf</application>(8), <application>swriteboot</application>(8), HP SRM Manual (<ULink URL="http://h18002.www1.hp.com/alphaserver/download/srm_reference.pdf"></ULink>) +</refsect1> +</refentry> diff --git a/package/aboot/src/doc/man/aboot.sgml b/package/aboot/src/doc/man/aboot.sgml new file mode 100644 index 000000000..d54d3ad8c --- /dev/null +++ b/package/aboot/src/doc/man/aboot.sgml @@ -0,0 +1,83 @@ +<!DOCTYPE RefEntry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="aboot"> + +<refmeta> +<refentrytitle>aboot</refentrytitle> +<manvolnum>8</manvolnum> +<refmiscinfo>aboot</refmiscinfo> +</refmeta> + +<refnamediv> +<refname>aboot</refname> +<refpurpose>The secondary boot loader for Linux/Alpha</refpurpose> +</refnamediv> + +<refsect1><title>COPYRIGHT</title> +<para> +<application>aboot</application> is Copyright (C) 1996 Linus Torvalds, David Mosberger-Tang and Michael Schwingen +</para> +</refsect1> + +<refsect1><title>DESCRIPTION</title> +<para> +<indexterm><primary>aboot</primary></indexterm> +<application>aboot</application> is the secondary boot loader needed if +the Linux/Alpha system is booted via SRM. It is usually installed during +system installation by <application>swriteboot</application>(8). +</para> +<para> +To automate the booting process predefined boot configurations can be stored +in <filename>etc/aboot.conf</filename>(5). +</para> +<para> +<application>aboot</application> can also be used interactively by issuing +</para> +<para> +<command>boot <parameter>dka0 -fl "i"</parameter></command> +</para> +<para> +at the SRM-Prompt where dka0 has to be replaced by the device used. +</para> +<para> +In the interactive mode you can use the command l to show your current +<filename>etc/aboot.conf</filename> and then the appropriate number +(or a complete boot command as in SRM) to boot Linux. +</para> +<para> +If you do not want to use the <filename>etc/aboot.conf</filename> as set +up by <application>abootconf</application>(8) you can explicitly tell +<application>aboot</application> where to look for <filename>etc/aboot.conf</filename> by prepending the number of the configuration with the proper +partition, i.e. if your <filename>etc/aboot.conf</filename> is on your +second partition and you want to boot the entry labeled three you would +issue +</para> +<para> +<command>boot <parameter>dqa -fl "2:3"</parameter></command> +</para> +<para> +Note that this applies to Linux booting via SRM only as +<ProductName>VMS</ProductName>, <ProductName>Tru64</ProductName>, *BSD and +<ProductName>Windows NT</ProductName> each have their own secondary boot loader. +Furthermore <application>aboot</application> is also not needed if the system is booted via +<application>milo</application>. +</para> +</refsect1> + + +<refsect1><title>AUTHOR</title> +<para> +This man page was written by Helge Kreutzmann +<email>debian@helgefjell.de</email> for the Debian GNU/Linux project +but may be used by others. +</para> +</refsect1> + +<refsect1><title>FILES</title> +<para><filename>etc/aboot.conf</filename></para> +</refsect1> + +<refsect1><title>SEE ALSO</title> +<para><application>abootconf</application>(8), <filename>aboot.conf</filename>(5), +<application>swriteboot</application>(8), HP SRM Manual (<ULink URL="http://h18002.www1.hp.com/alphaserver/download/srm_reference.pdf"></ULink>)</para> +</refsect1> +</refentry> diff --git a/package/aboot/src/doc/man/abootconf.8 b/package/aboot/src/doc/man/abootconf.8 new file mode 100644 index 000000000..cb0f00624 --- /dev/null +++ b/package/aboot/src/doc/man/abootconf.8 @@ -0,0 +1,96 @@ +.\" This manpage has been automatically generated by docbook2man-spec +.\" from a DocBook document. docbook2man-spec can be found at: +.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "ABOOTCONF" "8" "26 Oktober 2003" "abootconf" "" +.SH NAME +abootconf \- Configure the location of the configuration file for the secondary bootloader aboot(8) for Linux/Alpha. +.SH SYNOPSIS +.sp +\fBabootconf\fR \fB/dev/xxx num\fR +.SH "COPYRIGHT" +.PP +\fBabootconf\fR is Copyright (C) 1996 Linus Torvalds, David Mosberger-Tang and Michael Schwingen +.SH "DESCRIPTIONS" +.PP + + +\fBabootconf\fR is used to change the partition +the alpha Linux boot loader \fBaboot\fR(8) +looks for its configuration file in. The configuration file is stored +in \fIetc/aboot.conf\fR(5) +relative to the root of the file system in this partition. +.PP +\fBabootconf\fR requires the boot device +(e.g. \fI/dev/hdb\fR, \fI/dev/sda\fR) and the +partition +to be used (e.g. 3). Thus if you want to boot from partition E: on your second +SCSI disk you would enter +.PP +\fBabootconf \fI/dev/sdb 5\fB\fR +.SH "NOTES" +.PP +\fBabootconf\fR is not needed if you are booting +your alpha system via \fBmilo\fR. +.PP +For each disk one partition can be activated to contain the configuration +for \fBaboot\fR(8) which is located in +\fIetc/aboot.conf\fR(5). +The disk chosen to boot from is selected at +the SRM prompt as the second argument, e.g. +.PP +\fBboot \fIdqa\fB\fR +.PP +to boot from your first IDE hard disk. See the HP SRM-Manual and +\fBaboot\fR(8) +for details. +.PP +\fBaboot\fR(8) can load a kernel from an +arbitrary partition and can even use a different +root partition than the one \fIetc/aboot.conf\fR +belongs to. Hence you would usually +set up one \fIetc/aboot.conf\fR with all combinations and +would not require \fBabootconf\fR except for initial +set up. You can then +boot the requested +Linux kernel by giving the appropriate flags at the SRM prompt, e.g. to boot +the entry labeled 2 you would use +.PP +\fBboot \fIdqa -fl "2"\fB\fR +.PP +See the HP SRM manual and \fIaboot.conf\fR(5) +for details. +.PP +To show the current setting simply omit the last argument (i.e. the partition +number). +.PP +Note that you have to rerun \fBabootconf\fR if you updated +\fBaboot\fR. +.PP +Strictly speaking \fBabootconf\fR is not necessary as +you can specify the partition which \fIetc/aboot.conf\fR +resides on at the SRM-Prompt by prepending the partition number and a colon +in the flags-parameter, i.e. if \fIetc/aboot.conf\fR +resided on the fourth partition and you want to boot the entry labeled 2 +you could also issue +.PP +\fBboot \fIdqa -fl "4:2"\fB\fR +.PP +at the SRM prompt. +.PP +Note that this applies to Linux only as VMS, Tru64, *BSD and +Windows NT each have their own secondary boot loader. +.PP +Also note that for initial hard disk setup \fBabootconf\fR +is no longer needed as \fBswriteboot\fR(8) contains the +entire functionality of \fBabootconf\fR. +.SH "AUTHOR" +.PP +This man page was written by Helge Kreutzmann <kreutzm@itp.uni-hannover.de> for the Debian GNU/Linux project but may be used by others. +.SH "FILES" +.PP +\fIetc/aboot.conf\fR +.SH "SEE ALSO" +.PP +\fBaboot\fR(8), \fBswriteboot\fR(8), \fIaboot.conf\fR(5), HP SRM Manual diff --git a/package/aboot/src/doc/man/abootconf.sgml b/package/aboot/src/doc/man/abootconf.sgml new file mode 100644 index 000000000..5281cd323 --- /dev/null +++ b/package/aboot/src/doc/man/abootconf.sgml @@ -0,0 +1,141 @@ +<!DOCTYPE RefEntry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="abootconf"> + +<refmeta> +<refentrytitle>abootconf</refentrytitle> +<manvolnum>8</manvolnum> +<refmiscinfo>abootconf</refmiscinfo> +</refmeta> + +<refnamediv> +<refname>abootconf</refname> +<refpurpose> +Configure the location of the configuration file for the secondary boot +loader <application>aboot</application>(8) for Linux/Alpha. +</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>abootconf</command> <arg choice="plain">/dev/xxx num</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>COPYRIGHT</title> +<para> +<application>abootconf</application> is Copyright (C) 1996 Linus Torvalds, David Mosberger-Tang and Michael Schwingen +</para> +</refsect1> + +<refsect1><title>DESCRIPTIONS</title> +<para> +<indexterm><primary>abootconf</primary></indexterm> +<indexterm><primary>aboot</primary></indexterm> +<application>abootconf</application> is used to change the partition<indexterm><primary>partition +</primary></indexterm> +the alpha Linux boot loader <application>aboot</application>(8) +looks for its configuration file in. The configuration file is stored +in <filename>etc/aboot.conf</filename>(5) +relative to the root of the file system in this partition. +</para> +<para> +<application>abootconf</application> requires the boot device +(e.g. <filename>/dev/hdb</filename>, <filename>/dev/sda</filename>) and the +partition +to be used (e.g. 3). Thus if you want to boot from partition E: on your second +SCSI disk you would enter</para> +<para> +<command> +abootconf <parameter>/dev/sdb 5</parameter> +</command> +</para> +</refsect1> +<refsect1><title>NOTES</title> +<para> +<application>abootconf</application> is not needed if you are booting +your alpha system via <application>milo</application>. +</para> +<para> +For each disk one partition can be activated to contain the configuration +for <application>aboot</application>(8) which is located in +<filename>etc/aboot.conf</filename>(5). +The disk chosen to boot from is selected at +the SRM prompt as the second argument, e.g. +</para> +<para> +<command> +boot <parameter>dqa</parameter> +</command> +</para> +<para> +to boot from your first IDE hard disk. See the HP SRM-Manual and +<application>aboot</application>(8) +for details. +</para> +<para> +<application>aboot</application>(8) can load a kernel from an +arbitrary partition and can even use a different +root partition than the one <filename>etc/aboot.conf</filename> +belongs to. Hence you would usually +set up one <filename>etc/aboot.conf</filename> with all combinations and +would not require <application>abootconf</application> except for initial +set up. You can then +boot the requested +Linux kernel by giving the appropriate flags at the SRM prompt, e.g. to boot +the entry labeled 2 you would use +</para> +<para> +<command> +boot <parameter>dqa -fl "2"</parameter> +</command> +</para> +<para> +See the HP SRM manual and <filename>aboot.conf</filename>(5) +for details. +</para> +<para> +To show the current setting simply omit the last argument (i.e. the partition +number). +</para> +<para> +Note that you have to rerun <application>abootconf</application> if you updated +<application>aboot</application>(8). +</para> +<para> +Strictly speaking <application>abootconf</application> is not necessary as +you can specify the partition which <filename>etc/aboot.conf</filename> +resides on at the SRM-Prompt by prepending the partition number and a colon +in the flags-parameter, i.e. if <filename>etc/aboot.conf</filename> +resided on the fourth partition and you want to boot the entry labeled 2 +you could also issue +</para> +<para> +<command> +boot <parameter>dqa -fl "4:2"</parameter> +</command> +</para> +<para> +at the SRM prompt. +</para> +<para> +Note that this applies to Linux only as <ProductName>VMS</ProductName>, <ProductName>Tru64</ProductName>, *BSD and +<ProductName>Windows NT</ProductName> each have their own secondary boot loader. +</para> +<para> +Also note that for initial hard disk setup <application>abootconf</application> +is no longer needed as <application>swriteboot</application>(8) contains the +entire functionality of <application>abootconf</application>. +</para> +</refsect1> +<refsect1><title>AUTHOR</title> +<para> +This man page was written by Helge Kreutzmann <email>debian@helgefjell.de</email> for the Debian GNU/Linux project but may be used by others. +</para> +</refsect1> +<refsect1><title>FILES</title> +<para><filename>etc/aboot.conf</filename></para> +</refsect1> +<refsect1><title>SEE ALSO</title> +<para><application>aboot</application>(8), <application>swriteboot</application>(8), <filename>aboot.conf</filename>(5), HP SRM Manual (<ULink URL="http://h18002.www1.hp.com/alphaserver/download/srm_reference.pdf"></ULink>)</para> +</refsect1> +</refentry> diff --git a/package/aboot/src/doc/man/de/Makefile b/package/aboot/src/doc/man/de/Makefile new file mode 100644 index 000000000..22ef583a1 --- /dev/null +++ b/package/aboot/src/doc/man/de/Makefile @@ -0,0 +1,46 @@ +all: srmbootraw.de.8 aboot.de.8 aboot.conf.de.5 abootconf.de.8 isomarkboot.de.1 sdisklabel.de.8 srmbootfat.de.1 e2writeboot.de.8 swriteboot.de.8 netabootwrap.de.1 + +aboot.de.8: aboot.sgml + nsgmls aboot.sgml | sgmlspl docbook2man-de-spec.pl + mv aboot.8 aboot.de.8 + +aboot.conf.de.5: aboot.conf.sgml + nsgmls aboot.conf.sgml | sgmlspl docbook2man-de-spec.pl + mv aboot.conf.5 aboot.conf.de.5 + +abootconf.de.8: abootconf.sgml + nsgmls abootconf.sgml | sgmlspl docbook2man-de-spec.pl + mv abootconf.8 abootconf.de.8 + +netabootwrap.de.1: netabootwrap.sgml + nsgmls netabootwrap.sgml | sgmlspl docbook2man-de-spec.pl + mv netabootwrap.1 netabootwrap.de.1 + +isomarkboot.de.1: isomarkboot.sgml + nsgmls isomarkboot.sgml | sgmlspl docbook2man-de-spec.pl + mv isomarkboot.1 isomarkboot.de.1 + +sdisklabel.de.8: sdisklabel.sgml + nsgmls sdisklabel.sgml | sgmlspl docbook2man-de-spec.pl + mv sdisklabel.8 sdisklabel.de.8 + +srmbootfat.de.1: srmbootfat.sgml + nsgmls srmbootfat.sgml | sgmlspl docbook2man-de-spec.pl + mv srmbootfat.1 srmbootfat.de.1 + +srmbootraw.de.8: srmbootraw.sgml + nsgmls srmbootraw.sgml | sgmlspl docbook2man-de-spec.pl + mv srmbootraw.8 srmbootraw.de.8 + +e2writeboot.de.8: e2writeboot.8 + ln -s e2writeboot.8 e2writeboot.de.8 + +swriteboot.de.8: swriteboot.8 + ln -s swriteboot.8 swriteboot.de.8 + +clean : + rm -f *.html *.de.? srmbootraw.8 srmbootfat.1 sdisklabel.8 isomarkboot.8 abootconf.8 aboot.conf.5 aboot.8 netabootwrap.1 manpage.links manpage.log manpage.refs + rm -rf SRM-HOWTO + + +#.PHONY clean diff --git a/package/aboot/src/doc/man/de/aboot.conf.sgml b/package/aboot/src/doc/man/de/aboot.conf.sgml new file mode 100644 index 000000000..5702c70db --- /dev/null +++ b/package/aboot/src/doc/man/de/aboot.conf.sgml @@ -0,0 +1,108 @@ +<!DOCTYPE RefEntry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="aboot.conf"> + +<refmeta> +<refentrytitle>aboot.conf</refentrytitle> +<manvolnum>5</manvolnum> +<refmiscinfo>aboot.conf</refmiscinfo> +</refmeta> + +<refnamediv> +<refname>aboot.conf</refname> +<refpurpose>Die Konfigurationsdatei für <application>aboot</application>(8) +</refpurpose> +</refnamediv> + +<refsect1><title>BESCHREIBUNG</title> +<para> +<indexterm><primary>aboot.conf</primary></indexterm> +<filename>aboot.conf</filename> enthält eine Liste von Boot-Einstellungen +für <application>aboot</application>(8). Jede Boot-Einstellung hat eine +eindeutige Zahl, die am SRM-Prompt angegeben werden kann. +<indexterm><primary>SRM</primary></indexterm>. +</para> +<para> +<filename>aboot.conf</filename> muß sich in einem Verzeichnis names +<filename>etc</filename> auf der <emphasis>gleichen Partition</emphasis> +wie Ihre Kernel befinden, es sei den, Sie geben explizit die Partition +für Ihre Kernel an (siehe dazu die Ausführungen weiter unten). Falls Sie +also eine seperate Boot-Partition (namens <filename>/boot</filename>) +erzeugen, dann sollte <filename>aboot.conf</filename> in +<filename>/boot/etc/</filename> liegen. +</para> +<para> +Im folgenden Beispiel liegen die Kernel auf einer anderen Partition (hda4) +als <filename>/</filename> (hda5), während in der fünften Zeile +<filename>/boot</filename> auf der gleichen Partition (hda6) wie +<filename>/</filename> liegt. Daher kann sich <filename>aboot.conf</filename> +auf einer der drei Partitionen befinden, muß aber <emphasis>immer</emphasis> +in einem Verzeichnis namens <filename>etc</filename> relativ zur obersten +Verzeichnisebene auf dieser Partition angelegt sein. Die zu verwendene +Partition können Sie mittels <application>abootconf</application>(8) +ändern. +</para> +<para><example> +<title>BEISPIEL <filename>aboot.conf</filename></title> +<blockquote> +<literallayout> +0:4/vmlinuz root=/dev/hda5 +1:4/vmlinuz root=/dev/hda5 single +2:4/vmlinuz.old ro root=/dev/hda5 +3:4/vmlinuz-2.4.9-32 root=/dev/sdc3 initrd=/initrd-2.4.9-32.img console=tty0 +8:6/boot/vmlinuz ro root=/dev/hda6 +</literallayout> +</blockquote> +</example></para> +<para> +Die erste Zahl ist ein eindeutige Identifikation für jede Boot-Konfiguration. +Um eine bestimmte Konfiguration am SRM-Prompt zu booten, geben Sie +</para> +<para> +<command> +boot <parameter>dka0 -fl "0"</parameter> +</command> +</para> +<para> +ein, wobei dka0 durch Ihr Boot-Gerät und die 0 durch die zur bootende, +in <filename>etc/aboot.conf</filename> angegegebene Konfigurationszahl +ersetzt werden muß. +</para> + +<para> +Nach dem Doppelpunkt ist die Partition, auf der sich der Kernel befindet, +angegeben. 1 entspricht der BSD-Partition mit Namen A:, 2 B: und so weiter. +</para> + +<para> +Nach dem Schrägstrich ist der Name (ggf. inklusive des zugehörigen Pfads) +des zu bootenden Kernels angegeben. Falls sich Ihr Kernel nicht in einem +Dateisystem, sondern direkt nach <application>aboot</application>(8) am Anfang +der Festplatte befindet lassen Sie die Zahl, den Schrägstrich und den +Kernelnamen weg. +</para> + +<para> +Als nächstes ist die als <filename>/</filename> zu montierende Partition +angegeben. Andere benötigte Kernel-Parameter folgen. Wie gezeigt kann auch +eine initrd angegeben werden. +</para> + +<para> +Der Inhalt dieser Datei kann vor dem Booten mittels des interaktiven +Modus -- durch Booten mit dem Paramter "i" -- +von <application>aboot</application>(8) und der Angabe von +"h" am <application>aboot</application>-Prompt angezeigt werden. +</para> + +</refsect1> +<refsect1><title>AUTOR</title> +<para> +Diese Handbuchseite wurde von Helge Kreutzmann +<email>debian@helgefjell.de</email> für das Debian GNU/Linux-Projekt +geschrieben, sie darf aber auch von anderen verwendet werden. +</para> +</refsect1> +<refsect1><title>SIEHE AUCH</title> +<para><application>aboot</application>(8), <application>abootconf</application>(8), <application>swriteboot</application>(8), HP SRM Handbuch (<ULink URL="http://h18002.www1.hp.com/alphaserver/download/srm_reference.pdf"></ULink>) +</refsect1> +</refentry> diff --git a/package/aboot/src/doc/man/de/aboot.sgml b/package/aboot/src/doc/man/de/aboot.sgml new file mode 100644 index 000000000..49fa124e6 --- /dev/null +++ b/package/aboot/src/doc/man/de/aboot.sgml @@ -0,0 +1,89 @@ +<!DOCTYPE RefEntry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="aboot"> + +<refmeta> +<refentrytitle>aboot</refentrytitle> +<manvolnum>8</manvolnum> +<refmiscinfo>aboot</refmiscinfo> +</refmeta> + +<refnamediv> +<refname>aboot</refname> +<refpurpose>Der Bootloader (Urlader) der zweiten Stufe auf Linux/Alpha</refpurpose> +</refnamediv> + +<refsect1><title>COPYRIGHT</title> +<para> +<application>aboot</application> unterliegt dem Copyright (C) 1996 Linus Torvalds, David Mosberger-Tang und Michael Schwingen +</para> +</refsect1> + +<refsect1><title>BESCHREIBUNG</title> +<para> +<indexterm><primary>aboot</primary></indexterm> +<application>aboot</application> wird als Bootloader (Urlader) der zweiten +Stufe benötigt, falls das System via SRM gebootet wird. Er wird normalerweise +während der Systeminstallation durch +<application>swriteboot</application>(8) installiert. +</para> +<para> +Um den Bootprozess zu automatisieren können vordefinierte Boot-Konfigurationen +in <filename>etc/aboot.conf</filename>(5) eingetragen werden. +</para> +<para> +<application>aboot</application> kann durch die Angabe von +</para> +<para> +<command>boot <parameter>dka0 -fl "i"</parameter></command> +</para> +<para> +am SRM-Prompt auch interaktiv verwendet werden, wobei dka0 durch das +verwendete Gerät ersetzt werden muß. +</para> +<para> +Im interaktiven Modus können Sie das Kommando l zur Anzeige der derzeitigen +<filename>etc/aboot.conf</filename> verwenden, und durch die Angabe der +entsprechenden Zahl (oder des kompletten Boot-Kommandos wie bei SRM) +Linux booten. +</para> +<para> +Falls Sie nicht die von <application>abootconf</application>(8) erstellte +<filename>etc/aboot.conf</filename> verwenden wollen, können Sie +<application>aboot</application> explizit angeben, wo es nach der +<filename>etc/aboot.conf</filename> suchen soll, indem Sie vor die +Zahl der Konfiguration die passende Partition angeben, d.h. falls +Ihre <filename>etc/aboot.conf</filename> sich auf Ihrer zweiten Partition +befindet und Sie den mit 3 benannten Eintrag booten wollen, dann gäben +Sie an +</para> +<para> +<command>boot <parameter>dqa -fl "2:3"</parameter></command> +</para> +<para> +Beachten Sie, daß dies nur für das Booten von Linux via SRM zutrifft, da +<ProductName>VMS</ProductName>, <ProductName>Tru64</ProductName>, *BSD und +<ProductName>Windows NT</ProductName> jeweils über ihren eigenen Bootloader +für die zweite Stufe verfügen. Desweiteren wird <application>aboot</application> +nicht benötigt, falls das System mittels <application>milo</application> +gebootet wird. +</para> +</refsect1> + + +<refsect1><title>AUTOR</title> +<para> +Diese Handbuchseite wurde von Helge Kreutzmann +<email>debian@helgefjell.de</email> für das Debian GNU/Linux-Projekt +geschrieben, sie darf aber auch von anderen verwendet werden. +</para> +</refsect1> + +<refsect1><title>DATEIEN</title> +<para><filename>etc/aboot.conf</filename></para> +</refsect1> + +<refsect1><title>SIEHE AUCH</title> +<para><application>abootconf</application>(8), <filename>aboot.conf</filename>(5), +<application>swriteboot</application>(8), HP SRM Handbuch (<ULink URL="http://h18002.www1.hp.com/alphaserver/download/srm_reference.pdf"></ULink>)</para> +</refsect1> +</refentry> diff --git a/package/aboot/src/doc/man/de/abootconf.sgml b/package/aboot/src/doc/man/de/abootconf.sgml new file mode 100644 index 000000000..21cbe5ebf --- /dev/null +++ b/package/aboot/src/doc/man/de/abootconf.sgml @@ -0,0 +1,146 @@ +<!DOCTYPE RefEntry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="abootconf"> + +<refmeta> +<refentrytitle>abootconf</refentrytitle> +<manvolnum>8</manvolnum> +<refmiscinfo>abootconf</refmiscinfo> +</refmeta> + +<refnamediv> +<refname>abootconf</refname> +<refpurpose> +Konfiguration des Ortes der Konfigurationsdatei für den Bootloader der zweiten Stufe <application>aboot</application>(8) von Linux/Alpha. +</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>abootconf</command> <arg choice="plain">/dev/xxx num</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>COPYRIGHT</title> +<para> +<application>abootconf</application> unterliegt dem Copyright (C) 1996 Linus Torvalds, David Mosberger-Tang und Michael Schwingen +</para> +</refsect1> + +<refsect1><title>BESCHREIBUNG</title> +<para> +<indexterm><primary>abootconf</primary></indexterm> +<indexterm><primary>aboot</primary></indexterm> +<application>abootconf</application> wird zur Änderung der +Partition<indexterm><primary>partition</primary></indexterm>, in der der Linux +Boot-Loader (Urlader) <application>aboot</application>(8) nach seiner +Konfigurationsdatei schaut, verwendet. Die Konfiguration wird in +<filename>etc/aboot.conf</filename>(5) relativ zur Wurzel des Dateisystems +auf dieser Partition gespeichert. +</para> +<para> +<application>abootconf</application> benötigt das Boot-Gerät (bspw. +<filename>/dev/hdb</filename>, <filename>/dev/sda</filename>) und die +zu verwendende Partition (z.B. 3). Wollen Sie daher von Partition E: +auf Ihrer zweiten SCSI-Festplatte booten, dann geben Sie</para> +<para> +<command> +abootconf <parameter>/dev/sdb 5</parameter> +</command> +</para> +<para> +ein. +</para> +</refsect1> +<refsect1><title>HINWEISE</title> +<para> +<application>abootconf</application> wird nicht benötigt, wenn Sie Ihr +alpha-System mittels <application>milo</application> booten. +</para> +<para> +Auf jeder Festplatte kann eine Partition aktiviert werden, die die +Konfiguration für <application>aboot</application>(8) enthält, welche +unter <filename>etc/aboot.conf</filename>(5) liegt. Die zu bootende +Festplatte wird am SRM-Prompt als zweites Argument ausgewählt, also +beispielsweise +</para> +<para> +<command> +boot <parameter>dqa</parameter> +</command> +</para> +<para> +um von der ersten IDE-Festplatte zu booten. Lesen Sie bitte das +HP SRM-Handbuch und <application>aboot</application>(8) für weitere +Informationen. +</para> +<para> +<application>aboot</application>(8) kann einen Kernel von einer beliebiegen +Partition laden und kann soger eine andere Root-Partition verwenden, als die +zu der <filename>etc/aboot.conf</filename> gehört. Daher sollten Sie +normalerweise eine <filename>etc/aboot.conf</filename> mit allen Kombinationen +erstellen und benötigten <application>abootconf</application> außer für +die Erstinstallation nicht. Sie können dann den gewünschten Linuxkernel über +die entsprechenden Parameter am SRM-Prompt booten, z.B. um den mit 2 +bezeichneten Eintrag zu booten würden Sie +</para> +<para> +<command> +boot <parameter>dqa -fl "2"</parameter> +</command> +</para> +<para> +verwenden. Bitte lesen Sie das HP SRM-Handbuch und +<filename>aboot.conf</filename>(5) für weitere Informationen. +</para> +<para> +Um die derzeitigen Einstellungen anzuzeigen, lassen Sie einfach das letzte +Argument fort (d.h. die Partitionsnummer). +</para> +<para> +Beachten Sie, daß Sie <application>abootconf</application> erneut ausführen +müssen, wenn Sie <application>aboot</application>(8) aktualisiert haben. +</para> +<para> +Streng genommen wird <application>abootconf</application> nicht benötigt, +da Sie die Partition, auf der <filename>etc/aboot.conf</filename> liegt +auf dem SRM-Prompt spezifizieren können, indem Sie den Flags-Parameter mit +der Partitions-Nummer, gefolgt vom einem Doppelpunkt, einleiten, d.h. +falls <filename>etc/aboot.conf</filename> auf der vierten Partition liegt +und Sie den Eintrag mit der Nummer 2 booten wollen, dann könnte Sie am +SRM-Prompt auch +</para> +<para> +<command> +boot <parameter>dqa -fl "4:2"</parameter> +</command> +</para> +<para> +eingeben. +</para> +<para> +Beachten Sie, daß dies nur auf Linux zutrifft, da +<ProductName>VMS</ProductName>, <ProductName>Tru64</ProductName>, *BSD und +<ProductName>Windows NT</ProductName> jeweils über Ihren eigenen Bootloader +der zweiten Stufe verfügen. +</para> +<para> +Beachten Sie desweiteren, daß für das erstmalige Aufsetzen auf der Festplatte +<application>abootconf</application> ebenfalls nicht mehr benötigt wird, da +<application>swriteboot</application>(8) über die gesamte Funktionalität +von <application>abootconf</application> verfügt. +</para> +</refsect1> +<refsect1><title>AUTOR</title> +<para> +Diese Handbuchseite wurde von Helge Kreutzmann +<email>debian@helgefjell.de</email> für das Debian GNU/Linux-Projekt +geschrieben, sie darf aber auch von anderen verwendet werden. +</para> +</refsect1> +<refsect1><title>DATEIEN</title> +<para><filename>etc/aboot.conf</filename></para> +</refsect1> +<refsect1><title>SIEHE AUCH</title> +<para><application>aboot</application>(8), <application>swriteboot</application>(8), <filename>aboot.conf</filename>(5), HP SRM Handbuch (<ULink URL="http://h18002.www1.hp.com/alphaserver/download/srm_reference.pdf"></ULink>)</para> +</refsect1> +</refentry> diff --git a/package/aboot/src/doc/man/de/docbook2man-de-spec.pl b/package/aboot/src/doc/man/de/docbook2man-de-spec.pl new file mode 100644 index 000000000..2eed9015e --- /dev/null +++ b/package/aboot/src/doc/man/de/docbook2man-de-spec.pl @@ -0,0 +1,1304 @@ +=head1 NAME + +docbook2man-spec - convert DocBook RefEntries to Unix manpages + +=head1 SYNOPSIS + +The SGMLSpm package from CPAN. This contains the sgmlspl script which +is used to grok this file. Use it like this: + +nsgmls some-docbook-document.sgml | sgmlspl sgmlspl-specs/docbook2man-spec.pl + +=head1 OPTIONS + +=over 4 + +=item --section <label> + +Use the specified manpage section number, +if not specified in <MANVOLNUM>. Default is one (1). + +=item --date <string> + +Use the specified date in the .TH header. +Default is today. + +=item --lowercase | --preserve-case + +Convert output file names and cross-references to lower case. +Default is to convert to upper case. + +=head1 DESCRIPTION + +This is a sgmlspl spec file that produces Unix-style +manpages from RefEntry markup. + +See the accompanying RefEntry man page for 'plain new' documentation. :) + +=head1 LIMITATIONS + +Trying docbook2man on non-DocBook or non-conformant SGML results in +undefined behavior. :-) + +This program is a slow, dodgy Perl script. + +This program does not come close to supporting all the possible markup +in DocBook, and will produce wrong output in some cases with supported +markup. + +=head1 TODO + +Add new element handling and fix existing handling. Be robust. +Produce cleanest, readable man output as possible (unlike some +other converters). Follow Linux man(7) convention. +If this results in added logic in this script, +that's okay. The code should still be reasonably organized. + +Make it faster. If Perl sucks port it to another language. + +=head1 COPYRIGHT + +Copyright (C) 1998-1999 Steve Cheng <steve@ggi-project.org> + +Copyright (C) 1999 Thomas Lockhart <lockhart@alumni.caltech.edu> + +This program is free software; you can redistribute it and/or modify it +under the terms of the GNU General Public License as published by the Free +Software Foundation; either version 2, or (at your option) any later +version. + +You should have received a copy of the GNU General Public License along with +this program; see the file COPYING. If not, please write to the Free +Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. + +=cut + +# $Id: docbook2man-de-spec.pl,v 1.1 2004/07/05 09:32:10 kreutzm-guest Exp $ + +use SGMLS; # Use the SGMLS package. +use SGMLS::Output; # Use stack-based output. +use SGMLS::Refs; + + +######################################################################## +# SGMLSPL script produced automatically by the script sgmlspl.pl +# +# Document Type: any, but processes only RefEntries +# Edited by: me :) +######################################################################## + + +$write_manpages = 0; +$blank_xrefs = 0; + +$default_sect = "1"; +$default_date = `date "+%d %B %Y"`; # L10N + +while (@ARGV) { + my $arg = shift @ARGV; + if ($arg eq "--section") { + $default_sect = shift @ARGV || die "$arg requires an argument\n"; # L10N + } elsif ($arg eq "--date") { + $default_date = shift @ARGV || die "$arg requires an argument\n"; # L10N + } elsif ($arg eq "--lowercase") { + $lowercase_names = 1; + } elsif ($arg eq "--preserve-case") { + $lowercase_names = 0; + } elsif ($arg eq "--help") { + print "Usage: $0", + " [ --section <label> ]", + " [ --date <string> ]", + " [ --lowercase | --preserve-case ]", + "\n"; + exit; + } else { + die "unrecognized switch $arg; try $0 --help\n"; # L10N + } +} + +sgml('start', sub { + push_output('nul'); + $raw_cdata = 1; # Makes it a bit faster. + + # Links file + open(LINKSFILE, ">manpage.links"); + + $Refs = new SGMLS::Refs("manpage.refs", "manpage.log"); +}); +sgml('end', sub { + close(LINKSFILE); + + # Explicitly invoke destructor, + # otherwise cache file may not get written! + # Thomas Lockhart, 1999-08-03, perl-5.004, RedHat5.2 + undef $Refs; + + if($blank_xrefs) { + warn "Warning: output contains unresolved XRefs\n"; # L10N + } +}); + + +######################################################################## +# +# Output helpers +# +######################################################################## + +# Remove leading and trailing blanks. + +sub StripString +{ + my $str = shift; + + $str = $1 if ($str =~ m#^\s*(\S.*)#); + $str = $1 if ($str =~ m#^(.*\S)\s*$#); + + return $str; +} + +# Generate a good file name, for given manpage title and manvolnum +# (cdata content). +# Cleanup whitespace and convert to lower case if required. + +sub FileInfo +{ + my $title = StripString(shift); + my $volnum = StripString(shift); + + $title = lc $title if $lowercase_names; + + $title =~ tr/ /_/; + $volnum =~ tr/ /_/; + + # The 'package name' part of the section should + # not be used when citing it. + my $sectcite = $1 if ($volnum =~ /([0-9]*)/); + + return ("$title.$volnum", "$title($sectcite)"); +} + +# Our own version of sgml() and output() to allow simple string output +# to play well with roff's stupid whitespace rules. + +sub man_sgml +{ + if(ref($_[1]) eq 'CODE') { + return &sgml; + } + + my $s = $_[1]; + $s =~ s/\\/\\\\/g; + $s =~ s/'/\\'/g; + + sgml($_[0], eval("sub { man_output '$s' }")); +} + +sub man_output +{ + if($separator eq 'full') { + output "\n" unless $newline_last++; + output ".PP\n"; + $separator = ''; + } + + $_ = shift; + if(s/^\n//) { + output "\n" unless $newline_last++; + } + return if $_ eq ''; + + output $_; + + if(@_) { + output @_; + $newline_last = (pop(@_) =~ /\n$/); + } else { + $newline_last = ($_ =~ /\n$/) + } +} + +# Fold lines into one, quote some characters +sub fold_string +{ + $_ = shift; + + s/\\/\\\\/g; + s/"/\\\&"/g; + + # Change tabs and newlines to spaces + # The newlines will be swallowed later while trimming + tr/[\t\n]/ /; + + # Trim whitespace from beginning and end. + s/^ +//; + s/ +$//; + + return $_; +} + +sub save_cdata() +{ + $raw_cdata++; + push_output('string'); +} + +sub bold_on() +{ + # If the last font is also bold, don't change anything. + # Basically this is to just get more readable man output. + if($fontstack[$#fontstack] ne 'bold') { + if(!$raw_cdata) { + output '\fB'; + #$newline_last = 0; + } + } + push(@fontstack, 'bold'); +} + +sub italic_on() +{ + # If the last font is also italic, don't change anything. + if($fontstack[$#fontstack] ne 'italic') { + if(!$raw_cdata) { + output '\fI'; + #$newline_last = 0; + } + } + push(@fontstack, 'italic'); +} + +sub font_off() +{ + my $thisfont = pop(@fontstack); + my $lastfont = $fontstack[$#fontstack]; + + # Only output font change if it is different + if($thisfont ne $lastfont) { + if($raw_cdata) { return; } + elsif($lastfont eq 'bold') { output '\fB'; } + elsif($lastfont eq 'italic') { output '\fI'; } + else { output '\fR'; } + + #$newline_last = 0; + } +} + + +######################################################################## +# +# Manpage management +# +######################################################################## + +sgml('<REFENTRY>', sub { + # This will be overwritten at end of REFMETA, when we know the name of the page. + pop_output(); + + $write_manpages = 1; # Currently writing manpage. + + $nocollapse_whitespace = 0; # Current whitespace collapse counter. + $newline_last = 1; # At beginning of line? + # Just a bit of warning, you will see this variable manipulated + # manually a lot. It makes the code harder to follow but it + # saves you from having to worry about collapsing at the end of + # parse, stopping at verbatims, etc. + $raw_cdata = 0; # Instructs certain output functions to + # leave CDATA alone, so we can assign + # it to a string and process it, etc. + @fontstack = (); # Fonts being activated. + + $list_nestlevel = 0; # Indent certain nested content. + + # Separator to use between 'elements' in the content of a + # paragraph (usually). This makes sure that PCDATA after a list + # in a PARA gets a break in between and not become part of the + # last listitem. Note that we can't do it after the list ends, + # because often the list ends the paragraph and we'll get an + # extra break. Anything that changes the separator status from + # the default should also save its last state in the parent + # element's ext, but I'm not going to explain further. It's a + # gross hack and almost guaranteed to fail in unforseen cases. + # The only way to avoid all this is to use a tree/grove model, which + # we're _not_ doing. + $separator = ''; + + $manpage_title = ''; # Needed for indexing. + $manpage_sect = ''; + @manpage_names = (); + + $manpage_misc = ''; +}); +sgml('</REFENTRY>', sub { + if(!$newline_last) { + output "\n"; + } + + $raw_cdata = 1; + push_output('nul'); + + $write_manpages = 0; +}); + +sgml('</REFMETA>', sub { + my ($filename, $citation) = + FileInfo($manpage_title, $manpage_sect || $default_sect); + + push_output('file', $filename); + + output <<_END_BANNER; +.\\" This manpage has been automatically generated by docbook2man-spec +.\\" from a DocBook document. docbook2man-spec can be found at: +.\\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\\" Please send any bug reports, improvements, comments, patches, +.\\" etc. to Steve Cheng <steve\@ggi-project.org>. +_END_BANNER + + my $manpage_date = $_[0]->parent->ext->{'date'} || $default_date; + + output '.TH "'; + + # If the title is not mixed-case, convention says to + # uppercase the whole title. (The canonical title is + # lowercase.) + if($manpage_title =~ /[A-Z]/) { + output fold_string($manpage_title); + } else { + output uc(fold_string($manpage_title)); + } + + output '" "', fold_string($manpage_sect), + '" "', fold_string($manpage_date), + '" "', $manpage_misc, + '" "', $manpage_manual, + "\"\n"; + + $newline_last = 1; + + # References to this RefEntry. + if(defined($_[0]->parent->attribute('ID')->value)) { + my $id = $_[0]->parent->attribute('ID')->value; + + # Append XREFLABEL content to citations. + if(defined($_[0]->parent->attribute('XREFLABEL')->value)) { + $citation = $_[0]->parent->attribute('XREFLABEL')->value . + ' [' . $citation . ']'; + } + + $Refs->put("refentry:$id", $citation); + } +}); + +sgml('<REFENTRYTITLE>', sub { + if($_[0]->in('REFMETA')) { + save_cdata(); + } else { + # Manpage citations are in bold. + bold_on(); + } +}); +sgml('</REFENTRYTITLE>', sub { + if($_[0]->in('REFMETA')) { + $raw_cdata--; + $manpage_title = pop_output(); + } + else { font_off(); } + + if (defined($_[0]->attribute('ID')->value)) { + my $id = $_[0]->attribute('ID')->value; + my ($name, $citation) = FileInfo($manpage_title, $default_sect); + + $Refs->put("refentrytitle:$id", $citation); + } +}); + +sgml('<MANVOLNUM>', sub { + if($_[0]->in('REFMETA')) { + save_cdata(); + } else { + # Manpage citations use (). + output '('; + } +}); +sgml('</MANVOLNUM>', sub { + if($_[0]->in('REFMETA')) { + $raw_cdata--; + $manpage_sect = pop_output(); + } + else { output ')' } +}); + +sgml('<REFMISCINFO>', \&save_cdata); +sgml('</REFMISCINFO>', sub { + $raw_cdata--; + $manpage_misc = fold_string(pop_output()); +}); + + +# NAME section +man_sgml('<REFNAMEDIV>', "\n.SH NAME\n"); # L10N + +sgml('<REFNAME>', \&save_cdata); +sgml('</REFNAME>', sub { + $raw_cdata--; + push(@manpage_names, pop_output()); +}); + +sgml('<REFPURPOSE>', \&save_cdata); +sgml('</REFPURPOSE>', sub { + $raw_cdata--; + my $manpage_purpose = fold_string(pop_output()); + + for(my $i = 0; $i < $#manpage_names; $i++) { + output fold_string($manpage_names[$i]), ', '; + } + + output fold_string($manpage_names[$#manpage_names]); + output " \\- $manpage_purpose\n"; + + $newline_last = 1; + + foreach(@manpage_names) { + # Don't link to itself + if($_ ne $manpage_title) { + print LINKSFILE "$manpage_title.$manpage_sect $_.$manpage_sect\n"; + } + } +}); + +man_sgml('<REFCLASS>', "\n.sp\n"); + +#RefDescriptor + + +######################################################################## +# +# SYNOPSIS section and synopses +# +######################################################################## + +man_sgml('<REFSYNOPSISDIV>', "\n.SH ÜBERSICHT\n"); # L10N +man_sgml('</REFSYNOPSISDIV>', "\n"); + +## FIXME! Must be made into block elements!! +#sgml('<FUNCSYNOPSIS>', \&bold_on); +#sgml('</FUNCSYNOPSIS>', \&font_off); +#sgml('<CMDSYNOPSIS>', \&bold_on); +#sgml('</CMDSYNOPSIS>', \&font_off); + +man_sgml('<FUNCSYNOPSIS>', sub { + #man_output("\n.sp\n"); + bold_on(); +}); +man_sgml('</FUNCSYNOPSIS>', sub { + font_off(); + man_output "\n"; +}); + +man_sgml('<CMDSYNOPSIS>', "\n.sp\n"); +man_sgml('</CMDSYNOPSIS>', "\n"); + +man_sgml('<FUNCPROTOTYPE>', "\n.sp\n"); + +# Arguments to functions. This is C convention. +man_sgml('<PARAMDEF>', '('); +man_sgml('</PARAMDEF>', ");\n"); +man_sgml('<VOID>', "(void);\n"); + + +sub arg_start +{ + # my $choice = $_[0]->attribute('CHOICE')->value; + + # The content model for CmdSynopsis doesn't include #PCDATA, + # so we won't see any of the whitespace in the source file, + # so we have to add it after each component. + man_output ' '; + + if($_[0]->attribute('CHOICE')->value =~ /opt/i) { + man_output '[ '; + } + bold_on(); +} +sub arg_end +{ + font_off(); + if($_[0]->attribute('REP')->value =~ /^Repeat/i) { + italic_on(); + man_output '...'; + font_off(); + } + if($_[0]->attribute('CHOICE')->value =~ /opt/i) { + man_output ' ] '; + } +} + +sgml('<ARG>', \&arg_start); +sgml('</ARG>', \&arg_end); +sgml('<GROUP>', \&arg_start); +sgml('</GROUP>', \&arg_end); + +sgml('<OPTION>', \&bold_on); +sgml('</OPTION>', \&font_off); + +# FIXME: This is one _blank_ line. +man_sgml('<SBR>', "\n\n"); + + +######################################################################## +# +# General sections +# +######################################################################## + +# The name of the section is handled by TITLE. This just sets +# up the roff markup. +man_sgml('<REFSECT1>', sub { $separator = ''; man_output "\n.SH "}); +man_sgml('<REFSECT2>', sub { $separator = ''; man_output "\n.SS "}); +man_sgml('<REFSECT3>', sub { $separator = ''; man_output "\n.SS "}); + + +######################################################################## +# +# Titles, metadata. +# +######################################################################## + +sgml('<TITLE>', sub { + if($_[0]->in('REFERENCE') or $_[0]->in('BOOK')) { + $write_manpages = 1; + } + save_cdata(); +}); +sgml('</TITLE>', sub { + my $title = fold_string(pop_output()); + $raw_cdata--; + + if($_[0]->in('REFERENCE') or $_[0]->in('BOOK')) { + # We use TITLE of enclosing Reference or Book as manual name + $manpage_manual = $title; + $write_manpages = 0; + } + elsif(exists $_[0]->parent->ext->{'title'}) { + # By far the easiest case. Just fold the string as + # above, and then set the parent element's variable. + $_[0]->parent->ext->{'title'} = $title; + } + else { + # If the parent element's handlers are lazy, + # output the folded string for them :) + # We assume they want uppercase and a newline. + man_output '"', uc($title), "\"\n"; + } + + if (defined($_[0]->attribute('ID')->value)) { + my $id = $_[0]->attribute('ID')->value; + my ($name, $citation) = FileInfo($manpage_title, $default_sect); + + $Refs->put("title:$id", $citation); + } +}); + +sgml('<ATTRIBUTION>', sub { + if($_[0]->in('BLOCKQUOTE')) { + push_output('string'); + } +}); +sgml('</ATTRIBUTION>', sub { + if($_[0]->in('BLOCKQUOTE')) { + $_[0]->parent->ext->{'attribution'} = pop_output(); + } else { + # For an Epigraph. + man_output "\n\n"; + } +}); + +sgml('<DATE>', sub { + save_cdata(); +}); +sgml('</DATE>', sub { + $_[0]->parent->parent->ext->{'date'} = fold_string(pop_output()); + $raw_cdata--; +}); + +sub ignore_content { push_output 'nul'; } +sub restore_content { pop_output(); } + +sgml('<DOCINFO>', \&ignore_content); +sgml('</DOCINFO>', \&restore_content); +sgml('<REFSYNOPSISDIVINFO>', \&ignore_content); +sgml('</REFSYNOPSISDIVINFO>', \&restore_content); +sgml('<REFSECT1INFO>', \&ignore_content); +sgml('</REFSECT1INFO>', \&restore_content); +sgml('<REFSECT2INFO>', \&ignore_content); +sgml('</REFSECT2INFO>', \&restore_content); +sgml('<REFSECT3INFO>', \&ignore_content); +sgml('</REFSECT3INFO>', \&restore_content); + +sgml('<INDEXTERM>', \&ignore_content); +sgml('</INDEXTERM>', \&restore_content); + +sgml('<AUTHORBLURB>', \&ignore_content); +sgml('</AUTHORBLURB>', \&restore_content); + + +######################################################################## +# +# Set bold on enclosed content +# +######################################################################## + +sgml('<APPLICATION>', \&bold_on); +sgml('</APPLICATION>', \&font_off); + +sgml('<CLASSNAME>', \&bold_on); sgml('</CLASSNAME>', \&font_off); +sgml('<STRUCTNAME>', \&bold_on); sgml('</STRUCTNAME>', \&font_off); +sgml('<STRUCTFIELD>', \&bold_on); sgml('</STRUCTFIELD>', \&font_off); +sgml('<SYMBOL>', \&bold_on); sgml('</SYMBOL>', \&font_off); +sgml('<TYPE>', \&bold_on); sgml('</TYPE>', \&font_off); + +sgml('<ENVAR>', \&bold_on); sgml('</ENVAR>', \&font_off); + +sgml('<FUNCTION>', \&bold_on); sgml('</FUNCTION>', \&font_off); + +sgml('<EMPHASIS>', \&bold_on); sgml('</EMPHASIS>', \&font_off); + +sgml('<ERRORNAME>', \&bold_on); sgml('</ERRORNAME>', \&font_off); +# ERRORTYPE + +sgml('<COMMAND>', \&bold_on); sgml('</COMMAND>', \&font_off); + +sgml('<GUIBUTTON>', \&bold_on); sgml('</GUIBUTTON>', \&font_off); +sgml('<GUIICON>', \&bold_on); sgml('</GUIICON>', \&font_off); +# GUILABEL +# GUIMENU +# GUIMENUITEM +# GUISUBMENU +# MENUCHOICE + +sgml('<ACCEL>', \&bold_on); sgml('</ACCEL>', \&font_off); +# KEYCODE +# SHORTCUT + + +sgml('<KEYCOMBO>', sub { + $separator = 'none'; + $_[0]->ext->{'separator'} = 'none'; +}); +sgml('</KEYCOMBO>', sub { $separator = $_[0]->parent->ext->{'separator'}; }); + +sub _keycombo { + if($_[0]->in('KEYCOMBO')) { + if($separator eq 'none') { $separator = '' } + else { man_output "+"; } + } + bold_on(); +} +sgml('<KEYCAP>', \&_keycombo); sgml('</KEYCAP>', \&font_off); +sgml('<KEYSYM>', \&_keycombo); sgml('</KEYSYM>', \&font_off); +sgml('<MOUSEBUTTON>', \&_keycombo); sgml('</MOUSEBUTTON>', \&font_off); + + +sgml('<USERINPUT>', \&bold_on); sgml('</USERINPUT>', \&font_off); + +sgml('<INTERFACEDEFINITION>', \&bold_on); +sgml('</INTERFACEDEFINITION>', \&font_off); + +# May need to look at the CLASS +sgml('<SYSTEMITEM>', \&bold_on); +sgml('</SYSTEMITEM>', \&font_off); + + +######################################################################## +# +# Set italic on enclosed content +# +######################################################################## + +sgml('<FIRSTTERM>', \&italic_on); sgml('</FIRSTTERM>', \&font_off); + +sgml('<FILENAME>', \&italic_on); sgml('</FILENAME>', \&font_off); +sgml('<PARAMETER>', \&italic_on); sgml('</PARAMETER>', \&font_off); +sgml('<PROPERTY>', \&italic_on); sgml('</PROPERTY>', \&font_off); + +sgml('<REPLACEABLE>', sub { + italic_on(); + if($_[0]->in('TOKEN')) { + # When tokenizing, follow more 'intuitive' convention + output "<"; + } +}); +sgml('</REPLACEABLE>', sub { + if($_[0]->in('TOKEN')) { + output ">"; + } + font_off(); +}); + +sgml('<CITETITLE>', \&italic_on); sgml('</CITETITLE>', \&font_off); +sgml('<FOREIGNPHRASE>', \&italic_on); sgml('</FOREIGNPHRASE>', \&font_off); + +sgml('<LINEANNOTATION>', \&italic_on); sgml('</LINEANNOTATION>', \&font_off); + + +######################################################################## +# +# Other 'inline' elements +# +######################################################################## + +man_sgml('<EMAIL>', '<'); +man_sgml('</EMAIL>', '>'); +man_sgml('<OPTIONAL>', '['); +man_sgml('</OPTIONAL>', ']'); + +man_sgml('</TRADEMARK>', "\\u\\s-2TM\\s+2\\d"); # L10N + +man_sgml('<COMMENT>', "[Kommentar: "); # L10N +man_sgml('</COMMENT>', "]"); + +man_sgml('<QUOTE>', "»"); # L10N +man_sgml('</QUOTE>', "«"); # L10N + +#man_sgml('<LITERAL>', '"'); +#man_sgml('</LITERAL>', '"'); +# There doesn't seem to be a good way to represent LITERAL in -man +# ComputerOutput, SGMLTag, Markup are the same thing. + +# These create spaces between content in special elements +# without PCDATA content. +man_sgml('</HONORIFIC>', " "); +man_sgml('</FIRSTNAME>', " "); +man_sgml('</SURNAME>', " "); +man_sgml('</LINEAGE>', " "); +man_sgml('</OTHERNAME>', " "); + +man_sgml('<AFFILIATION>', "("); +man_sgml('</AFFILIATION>', ") "); +man_sgml('<CONTRIB>', "("); +man_sgml('</CONTRIB>', ") "); + +man_sgml('</STREET>', " "); +man_sgml('</POB>', " "); +man_sgml('</POSTCODE>', " "); +man_sgml('</CITY>', " "); +man_sgml('</STATE>', " "); +man_sgml('</COUNTRY>', " "); +man_sgml('</PHONE>', " "); +man_sgml('</FAX>', " "); +man_sgml('</OTHERADDRESS>', " "); + +man_sgml('</ALT>', ": "); +man_sgml('<GRAPHIC>', " [GRAPHIK] "); # L10N + +# No special presentation: + +# AUTHORINITIALS + +# ABBREV +# ACTION +# ACRONYM +# CITATION +# PHRASE +# QUOTE +# WORDASWORD + +# PROMPT +# RETURNVALUE +# TOKEN + +# DATABASE +# HARDWARE +# INTERFACE +# MEDIALABEL + + +######################################################################## +# +# Paragraph and paragraph-like elements +# +######################################################################## + +sub para_start { + if($separator eq '' or $separator eq 'full') { + $separator = ''; + man_output "\n.PP\n"; + } elsif($separator eq 'blank') { + man_output "\n\n"; + } elsif($separator eq 'none' ) { + $_[0]->parent->ext->{'separator'} = 'blank'; + $separator = 'blank'; + } +} +# Actually applies to a few other block elements as well +sub para_end { + $separator = $_[0]->parent->ext->{'separator'}; + man_output "\n"; +} + +sgml('<PARA>', \¶_start); +sgml('</PARA>', \¶_end); +sgml('<SIMPARA>', \¶_start); +sgml('</SIMPARA>', \¶_end); + +# Nothing special, except maybe FIXME set nobreak. +sgml('<INFORMALEXAMPLE>', \¶_start); +sgml('</INFORMALEXAMPLE>', \¶_end); + + +######################################################################## +# +# Blocks using SS sections +# +######################################################################## + +# FIXME: We need to consider the effects of SS +# in a hanging tag :( + +# Complete with the optional-title dilemma (again). +sgml('<ABSTRACT>', sub { + $_[0]->ext->{'title'} = 'ABSTRAKT'; # L10N + output "\n" unless $newline_last++; + push_output('string'); +}); +sgml('</ABSTRACT>', sub { + my $content = pop_output(); + + # As ABSTRACT is never on the same level as RefSect1, + # this leaves us with only .SS in terms of -man macros. + output ".SS \"", uc($_[0]->ext->{'title'}), "\"\n"; + + output $content; + output "\n" unless $newline_last++; +}); + + + +# Ah, I needed a break. Example always has a title. +sgml('<EXAMPLE>', sub { $separator = ''; man_output "\n.SS "}); +sgml('</EXAMPLE>', \¶_end); + +# Same with sidebar. +sgml('<SIDEBAR>', sub { $separator = ''; man_output "\n.SS "}); +sgml('</SIDEBAR>', \¶_end); + +sgml('<FORMALPARA>', sub { $separator = ''; man_output "\n.SS "}); +sgml('</FORMALPARA>', \¶_end); + +sgml('<FIGURE>', sub { $separator = ''; man_output "\n.SS "}); +sgml('</FIGURE>', \¶_end); + + + +# NO title. # L10N +sgml('<HIGHLIGHTS>', sub { $separator = ''; man_output "\n.SS HIGHLIGHTS\n"}); +sgml('</HIGHLIGHTS>', \¶_end); + + +######################################################################## +# +# Indented 'Block' elements +# +######################################################################## + +sub indent_block_start +{ + $separator = ''; + man_output "\n.sp\n.RS\n"; +} +sub indent_block_end +{ + $separator = $_[0]->parent->ext->{'separator'}; + man_output "\n.RE\n.sp\n"; +} + +sgml('<ADDRESS>', sub { + &indent_block_start; + if($_[0]->attribute('FORMAT')->type eq 'NOTATION' + and $_[0]->attribute('FORMAT')->value->name eq 'LINESPECIFIC') { + &verbatim_start; + } +}); +sgml('</ADDRESS>', sub { + if($_[0]->attribute('FORMAT')->type eq 'NOTATION' + and $_[0]->attribute('FORMAT')->value->name eq 'LINESPECIFIC') { + &verbatim_end; + } + &indent_block_end; +}); + +# This element is almost like an admonition (below), +# only the default title is blank :) + +sgml('<BLOCKQUOTE>', sub { + $_[0]->ext->{'title'} = ''; + &indent_block_start; + push_output('string'); +}); +sgml('</BLOCKQUOTE>', sub { + my $content = pop_output(); + + if($_[0]->ext->{'title'}) { + output ".B \"", $_[0]->ext->{'title'}, ":\"\n"; + } + + output $content; + + if($_[0]->ext->{'attribution'}) { + man_output "\n\n -- ", + $_[0]->ext->{'attribution'}, "\n"; + } + + &indent_block_end; +}); + +# Set off admonitions from the rest of the text by indenting. +# FIXME: Need to check if this works inside paragraphs, not enclosing them. +sub admonition_end { + my $content = pop_output(); + + # When the admonition is only one paragraph, + # it looks nicer if the title was inline. + my $num_para; + while ($content =~ /^\.PP/gm) { $num_para++ } + if($num_para==1) { + $content =~ s/^\.PP\n//; + } + + output ".B \"" . $_[0]->ext->{'title'} . ":\"\n"; + output $content; + + &indent_block_end; +} + +sgml('<NOTE>', sub { + # We can't see right now whether or not there is a TITLE + # element, so we have to save the output now and add it back + # at the end of this admonition. + $_[0]->ext->{'title'} = 'Note'; # L10N + + &indent_block_start; + + push_output('string'); +}); +sgml('</NOTE>', \&admonition_end); + +# Same as above. +sgml('<WARNING>', sub { + $_[0]->ext->{'title'} = 'Warnung'; # L10N + &indent_block_start; + push_output('string'); +}); +sgml('</WARNING>', \&admonition_end); + +sgml('<TIP>', sub { + $_[0]->ext->{'title'} = 'Tipp'; # L10N + &indent_block_start; + push_output('string'); +}); +sgml('</TIP>', \&admonition_end); +sgml('<CAUTION>', sub { + $_[0]->ext->{'title'} = 'Caution'; # L10N + &indent_block_start; + push_output('string'); +}); +sgml('</CAUTION>', \&admonition_end); + +sgml('<IMPORTANT>', sub { + $_[0]->ext->{'title'} = 'Wichtig'; # L10N + &indent_block_start; + push_output('string'); +}); +sgml('</IMPORTANT>', \&admonition_end); + + +######################################################################## +# +# Verbatim displays. +# +######################################################################## + +sub verbatim_start { + $separator = ''; + man_output "\n.sp\n"; + man_output "\n.nf\n" unless $nocollapse_whitespace++; +} + +sub verbatim_end { + man_output "\n.sp\n"; + man_output "\n.fi\n" unless --$nocollapse_whitespace; + $separator = $_[0]->parent->ext->{'separator'}; +} + +sgml('<PROGRAMLISTING>', \&verbatim_start); +sgml('</PROGRAMLISTING>', \&verbatim_end); + +sgml('<SCREEN>', \&verbatim_start); +sgml('</SCREEN>', \&verbatim_end); + +sgml('<LITERALLAYOUT>', \&verbatim_start); +sgml('</LITERALLAYOUT>', \&verbatim_end); + +sgml('<SYNOPSIS>', sub { + my $format = $_[0]->attribute('FORMAT'); + + if($format->type eq 'NOTATION' + and $format->value->name eq 'LINESPECIFIC') + { + &verbatim_start; + } else { + $separator = ''; + man_output "\n.sp\n"; + } +}); + +sgml('</SYNOPSIS>', sub { + my $format = $_[0]->attribute('FORMAT'); + + if($format->type eq 'NOTATION' + and $format->value->name eq 'LINESPECIFIC') + { + &verbatim_end; + } else { + man_output "\n"; + $_[0]->parent->ext->{'separator'} = 'full'; + $separator = 'full'; + } +}); + + +######################################################################## +# +# Lists +# +######################################################################## + +# Indent nested lists. +sub list_start { + man_output "\n.RS\n" if $list_nestlevel++; +} +sub list_end { + man_output "\n.RE\n" if --$list_nestlevel; + $_[0]->parent->ext->{'separator'} = 'full'; + $separator = 'full'; +} + +sgml('<VARIABLELIST>', \&list_start); +sgml('</VARIABLELIST>', \&list_end); +sgml('<ITEMIZEDLIST>', \&list_start); +sgml('</ITEMIZEDLIST>', \&list_end); +sgml('<ORDEREDLIST>', sub { + &list_start; + $_[0]->ext->{'count'} = 1; +}); +sgml('</ORDEREDLIST>', \&list_end); + +# Output content on one line, bolded. +sgml('<TERM>', sub { + man_output "\n.TP\n"; + bold_on(); + push_output('string'); +}); +sgml('</TERM>', sub { + my $term = StripString(pop_output()); + $term =~ tr/\n/ /; + output $term; + font_off(); + output "\n"; + $newline_last = 1; +}); + +sgml('<LISTITEM>', sub { + # A bulleted list. + if($_[0]->in('ITEMIZEDLIST')) { + man_output "\n.TP 0.2i\n\\(bu\n"; + } + + # Need numbers. + # Assume Arabic numeration for now. + elsif($_[0]->in('ORDEREDLIST')) { + man_output "\n.IP ", $_[0]->parent->ext->{'count'}++, ". \n"; + } + + $_[0]->ext->{'separator'} = 'none'; + $separator = 'none'; +}); + +sgml('<SIMPLELIST>', sub { + $_[0]->ext->{'first_member'} = 1; +}); +sgml('<MEMBER>', sub { + my $parent = $_[0]->parent; + + if($parent->attribute('TYPE')->value =~ /Inline/i) { + if($parent->ext->{'first_member'}) { + # If this is the first member don't put any commas + $parent->ext->{'first_member'} = 0; + } else { + man_output ", "; + } + + # We don't really have Horiz rendering, so it's the same + # as Vert. + } else { + man_output "\n\n"; + } +}); + +# We implement Procedures as indent and lists + +sgml('<PROCEDURE>', sub { + $_[0]->ext->{'count'} = 1; + &indent_block_start; +}); +sgml('</PROCEDURE>', sub { + &indent_block_end; + $_[0]->parent->ext->{'separator'} = 'full'; + $separator = 'full'; +}); + +sgml('<STEP>', sub { + man_output "\n.IP ", $_[0]->parent->ext->{'count'}++, ". \n"; + $_[0]->ext->{'separator'} = 'none'; + $separator = 'none'; +}); + + +######################################################################## +# +# Linkage, cross references +# +######################################################################## + +# Print the URL +sgml('</ULINK>', sub { + man_output ' <URL:', $_[0]->attribute('URL')->value, '>'; +}); + +# If cross reference target is a RefEntry, +# output CiteRefEntry-style references. +sgml('<XREF>', sub { + my $id; + + $id = $_[0]->attribute('LINKEND')->value; + + my $manref = $Refs->get("refentry:$id"); + if(!defined $manref) { + $blank_xrefs++ if $write_manpages; + man_output "[XRef auf $id]"; # L10N + return; + } + + # Limited ENDTERM support. + if(defined $_[0]->attribute('ENDTERM')->value) { + my $content = $Refs->get("title:$id") || + $Refs->get("refentrytitle:$id"); + man_output $content, ' ['; + } + + # This also displays the XREFLABEL (as bold)... + # It's not worth the bother to fix it though, there + # are better tools for this. + my ($title, $sect) = ($manref =~ /(.*)(\(.*\))/); + bold_on(); + man_output $title; + font_off(); + man_output $sect; + + if(defined $_[0]->attribute('ENDTERM')->value) { + man_output ']'; + } +}); + +# Anchor + + +######################################################################## +# +# SDATA +# +######################################################################## + +man_sgml('|[lt ]|', '<'); +man_sgml('|[gt ]|', '>'); +man_sgml('|[amp ]|', '&'); + +man_sgml('|[ndash ]|', '\(en'); +man_sgml('|[mdash ]|', '\(em'); + +sgml('sdata',sub { + man_output "|[", $_[0], "]|"; + warn "Warning: unrecognized SDATA: please add definition to docbook2man-spec.pl\n"; # L10N +}); + +# +# Default handlers (uncomment these if needed). Right now, these are set +# up to gag on any unrecognised elements, sdata, processing-instructions, +# or entities. +# +# sgml('start_element',sub { die "Unknown element: " . $_[0]->name; }); # L10N +# sgml('end_element',''); + +# This is for weeding out and escaping certain characters. +# This looks like it's inefficient since it's done on every line, but +# in reality, SGMLSpm and sgmlspl parsing ESIS takes _much_ longer. + +sgml('cdata', sub +{ + if(!$write_manpages) { return; } + elsif($raw_cdata) { output $_[0]; return; } + + if($separator eq 'full') { + output "\n" unless $newline_last++; + output ".PP\n"; + $separator = ''; + } + + # Escape backslashes + $_[0] =~ s/\\/\\\\/g; + + # In non-'pre'-type elements: + if(!$nocollapse_whitespace) { + # Change tabs to spaces + $_[0] =~ tr/\t / /s; + + # Do not allow indents at beginning of line + # groff chokes on that. + if($newline_last) { + $_[0] =~ s/^ //; + + # If the line is all blank, don't do anything. + if($_[0] eq '') { return; } + + $_[0] =~ s/^\./\\\&\./; + + # Argh... roff doesn't like ' for some unknown reason + $_[0] =~ s/^\'/\\\&\'/; + } + } + + $newline_last = 0; + + output $_[0]; +}); + + +# When in whitespace-collapsing mode, we disallow consecutive newlines. + +sgml('re', sub +{ + if($nocollapse_whitespace || !$newline_last) { + output "\n"; + } + + $newline_last = 1; +}); + +sgml('pi', sub {}); +sgml('entity',sub { die "Unknown external entity: " . $_[0]->name; }); # L10N +sgml('start_subdoc',sub { die "Unknown subdoc entity: " . $_[0]->name; });# L10N +sgml('end_subdoc',sub{}); +sgml('conforming',sub{}); + +1; + diff --git a/package/aboot/src/doc/man/de/e2writeboot.8 b/package/aboot/src/doc/man/de/e2writeboot.8 new file mode 100644 index 000000000..1c6b786dd --- /dev/null +++ b/package/aboot/src/doc/man/de/e2writeboot.8 @@ -0,0 +1,45 @@ +.\" e2writeboot - Write secondary SRM bootloader to ext2 filesystem. +.\" +.\" Translated to German by Helge Kreutzmann <debian@helgefjell.de> +.TH e2writeboot 8 "27 Juni 2004" "David Mosberger-Tang" "" +.SH NAME +e2writeboot \- Schreibt den sekundären Boot-Lader in ein ext2-Dateisystem. +.SH "ÜBERSICHT" +\fBe2writeboot\fP <ext2fs> <bootlader> +.SH BESCHREIBUNG + +\fBe2writeboot\fP kann zum Schreiben des sekundären Boot-Laders in ein +ext2-formatiertes Dateisystem (normalerweise auf einer Diskette) verwendet +werden. Der Lader ist so geschrieben, daß die SRM-Firmware von diesem +Dateisystem booten kann (SRM ist die Firmware die auch zu Booten von +\fBHP Tru64\fP, \fBOpenVMS\fP und *BSD verwendet wird). Insbesondere ist +der Lader so geschrieben, daß er einen kontinuierlichen Bereich von Sektoren +belegt und der erste Sektor wird so aktualisiert, daß die SRM-Firmware den +Boot-Lader finden kann. Der Lader wird immer unter dem Dateinamen +\fBlinuxboot\fP gespeichert und falls solch eine Datei bereits existiert, +wird diese ohne Rückfrage überschrieben. Dieser Befehl kann fehlschlagen, +wenn das Dateisystem stark fragmentiert ist. In diesem Fall reformatieren +Sie das Dateisystem mit \fBmke2fs\fP(8) (dies wird den derzeitigen +Inhalt des Dateisystems zerstören, daher mit Vorsicht verwenden). + +.P +Das \fI<ext2fs>\fP-Argument spezifiziert das Dateisystem oder spezielle +Gerät auf das die \fI<bootlader>\fP-Datei geschrieben werden soll. Die +Boot-Lader-Datei muß eine ECOFF-Objektdatei sein. Ein typischer Befehl, +um eine Diskette mit dem \fIaboot\fP(8)-Lader zu machen, ist im folgenden +gezeigt: + +.I »e2writeboot /dev/fd0 aboot« + +.nf +.SH SIEHE AUCH +.IR aboot (8) , +.IR mke2fs (8) , +.IR swriteboot (8) +.nf +.SH AUTOREN +.nf +Jim Paradis <paradis@amt.tay1.dec.com> +Jay Estabrook <Jay.Estabrook@hp.com> +David Mosberger-Tang <David.Mosberger@acm.org> +.fi diff --git a/package/aboot/src/doc/man/de/isomarkboot.sgml b/package/aboot/src/doc/man/de/isomarkboot.sgml new file mode 100644 index 000000000..7155bcb82 --- /dev/null +++ b/package/aboot/src/doc/man/de/isomarkboot.sgml @@ -0,0 +1,92 @@ +<!DOCTYPE RefEntry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="isomarkboot"> + +<refmeta> +<refentrytitle>isomarkboot</refentrytitle> +<manvolnum>1</manvolnum> +<refmiscinfo>isomarkboot</refmiscinfo> +</refmeta> + +<refnamediv> +<refname>isomarkboot</refname> +<refpurpose> +Erzeugt bootbare CD-ROMs für Linux/Alpha-Systeme. +</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>isomarkboot</command> + <arg choice="plain">/dev/xxx</arg> + <arg choice="plain">pfad/zu/bootlx</arg> + <arg choice="opt">pfad/zu/root.bin</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>COPYRIGHT</title> +<para> +<application>isomarkboot</application> unterliegt dem Copyright (C) 1996 David Mosberger-Tang +</para> +</refsect1> + +<refsect1><title>BESCHREIBUNG</title> +<para> +<indexterm><primary>isomarkboot</primary></indexterm> +<application>isomarkboot</application> +befähigt mit <application>mkisofs</application>(8) erstellte oder vom Netz +heruntergeladene ISO-Images auf Linux/Alpha-Systemen zu booten. +</para> + +<para> +Zuerst müssen Sie Ihr ISO-Image vorbereiten und über das Loopback-Gerät +auf <filename>/dev/xxx</filename> (typischerweise +<filename>/dev/loop0</filename>) montieren (siehe +<application>mount</application>(8) für Details). +</para> + +<para> +Als nächstes müssen Sie den aboot-Loader (<filename>bootlx</filename> genannt) +und das RAM-Disk-Image, das das Wurzelverzeichnisdateisystem enthält, +welches oft <filename>root.bin</filename> heißt, in Ihrem ISO-Image bestimmen. +Die Angabe letzterm ist optional, aber oft sinnvoll. +</para> +<para> +Schließlich machen Sie das Image bootbar: +</para> +<para> +<command> +isomarkboot <parameter>/dev/xxx pfad/zu/bootlx pfad/zu/root.bin</parameter> +</command> +</para> +<para> +Ein typischer Ort für <filename>bootlx</filename> auf dem Disk-Image ist +<filename>boot/bootlx</filename>. Die Pfade von <filename>bootlx</filename> +und <filename>root.bin</filename> sind relativ zur Wurzel des Images. Falls +Ihr Image nicht montiert ist müssen Sie <filename>/dev/xxx</filename> durch +dem Pfad zu Ihrem Image ersetzen. +</para> + +</refsect1> +<refsect1><title>FEHLER</title> +<para> +<application>isomarkboot</application> ist auf anderen Architekturen +(außer Alpha) nicht sehr intensiv getestet, obwohl es (mit kleinen Patches) +dort übersetzt. Bitte berichten Sie uns von Ihren Erfahrungen. +</para> +</refsect1> +<refsect1><title>ANMERKUNGEN</title> +<para> +<application>isomarkboot</application> ist in der Lage, Symlinks im Image +zu verarbeiten. +</para> +</refsect1> +<refsect1><title>AUTOR</title> +<para> +Diese Handbuchseite wurde von Helge Kreutzmann <email>debian@helgefjell.de</email> für das Debian GNU/Linux-Projekt geschrieben; sie darf aber auch von +anderen verwendet werden. +</refsect1> +<refsect1><title>SIEHE AUCH</title> +<para><application>aboot</application>(8), <application>mkisofs</application>(8) +</para> +</refsect1> +</refentry> diff --git a/package/aboot/src/doc/man/de/netabootwrap.sgml b/package/aboot/src/doc/man/de/netabootwrap.sgml new file mode 100644 index 000000000..9ef857674 --- /dev/null +++ b/package/aboot/src/doc/man/de/netabootwrap.sgml @@ -0,0 +1,107 @@ +<!DOCTYPE RefEntry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="netabootwrap"> + +<refmeta> +<refentrytitle>netabootwrap</refentrytitle> +<manvolnum>1</manvolnum> +<refmiscinfo>netabootwrap</refmiscinfo> +</refmeta> + +<refnamediv> +<refname>netabootwrap</refname> +<refpurpose> +erzeugt netzbootbare Images für Linux/Alpha +</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>netabootwrap</command> + <arg choice="opt">-t netboot.img</arg> + <arg choice="opt">-k vmlinux.gz</arg> + <arg choice="opt">-i initrd.gz</arg> + <arg choice="opt">-a "einige Kernelparameter"</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>COPYRIGHT</title> +<para> +<application>netabootwrap</application> ist (c) 2000 von Soohoon Lee +<email>soohoon.lee@api-networks.com</email> +</para> +</refsect1> + +<refsect1><title>BESCHREIBUNG</title> +<para> +<indexterm><primary>netabootwrap</primary></indexterm> +<application>netabootwrap</application> fügt <filename>net_aboot</filename>, +den Kernel und die initrd Images zusammen, um ein netzbootbares Image für +Linux/Alpha-Systeme zu erstellen. +<filename>net_aboot.nh</filename> ist nicht funktionstüchtig, aber +<application>netabootwrap</application> hat die volle Funktionalität. +Ohne Optionen schaut es nach <filename>vmlinux.gz</filename> +und baut <filename>netboot.img</filename>, das ist <filename>net_aboot</filename> ++ <filename>vmlinux.gz</filename>. +</para> + +<para> +<variablelist> +<varlistentry><term>-t dateiname</term> +<listitem><para> +Setzt den Dateinamen des zu erzeugenden Netboot-Images, standardmäßig ist dies +<filename>netboot.img</filename>. Diese Datei wird überschrieben falls sie +existiert. +</para></listitem></varlistentry> +<varlistentry><term>-k dateiname</term> +<listitem><para> +Setzt den Dateinamen des Kernel-Images, standardmäßig ist dies +<filename>vmlinux.gz</filename> +</para></listitem></varlistentry> +<varlistentry><term>-i dateiname</term> +<listitem><para> +Setzt den Dateinamen des anfänglichen RAM-Disk-Images, standardmäßig ist dies <filename>initrd.gz</filename> +</para></listitem></varlistentry> +<varlistentry><term>-a "einige Kernelparameter"</term> +<listitem><para> +Stellt weitere Kerneloptionen bereit, z.B. -a "root=/dev/sda1 single" +</variablelist> +</para> + +</refsect1> + +<!-- <refsect1><title>FEHLER</title> +<para> +</para> + +</refsect1> --> + +<refsect1><title>HINWEISE</title> +<para> +Um das Image zu verwenden, benötigen Sie einen +<application>tftpd</application>(8)- und einen <application>dhcp</application>(8)- +oder <application>bootpd</application>(8)-Server. +Weitere Details finden Sie im SRM-HOWTO: +(<ULink URL="http://www.alphalinux.org/faq/srm.html"></ULink> oder in +<filename>/usr/share/doc/aboot/SRM-HOWTO/</filename> auf Debian GNU/Linux-Systemen (und möglicherweise auch anderen)) +</para> + +</refsect1> + +<refsect1><title>AUTOR</title> +<para> +Diese Handbuchseite wurde von Helge Kreutzmann +<email>debian@helgefjell.de</email> für das Debian GNU/Linux-Projekt geschrieben. Sie darf auch +von anderen verwendet werden. +</para> +</refsect1> +<refsect1><title>SIEHE AUCH</title> +<para> +<application>tftpd</application>(8), +<application>dhcpd</application>(8), +<application>bootpd</application>(8), +<application>aboot</application>(8), +SRM-HOWTO in <filename>/usr/share/doc/aboot/SRM-HOWTO/</filename> oder <ULink URL="http://www.alphalinux.org/faq/srm.html"></ULink>, +HP SRM Manual (<ULink URL="http://h18002.www1.hp.com/alphaserver/download/srm_reference.pdf"></ULink>) +</para> +</refsect1> +</refentry> diff --git a/package/aboot/src/doc/man/de/sdisklabel.sgml b/package/aboot/src/doc/man/de/sdisklabel.sgml new file mode 100644 index 000000000..e1dbbd67a --- /dev/null +++ b/package/aboot/src/doc/man/de/sdisklabel.sgml @@ -0,0 +1,247 @@ +<!DOCTYPE RefEntry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="sdisklabel"> + +<refmeta> +<refentrytitle>sdisklabel</refentrytitle> +<manvolnum>8</manvolnum> +<refmiscinfo>sdisklabel</refmiscinfo> +</refmeta> + +<refnamediv> +<refname>sdisklabel</refname> +<refpurpose> +Erzeugt/verändert Disklabels auf Linux/Alpha-Systemen +</refpurpose> +</refnamediv> + +<!-- This is the proper SGML way, but somehow doesn't work here --> +<refsynopsisdiv> + <cmdsynopsis> + <command>sdisklabel</command> + <arg choice="plain">gerät</arg> + <group choice="opt"><arg choice="plain">print</arg> + <arg choice="plain">zero</arg> + <arg choice="plain">sum</arg> + </group> + </cmdsynopsis> + <cmdsynopsis> + <command>sdisklabel</command> + <arg choice="plain">gerät</arg> + <arg choice="plain">size</arg> + <arg choice="plain">partitionsgrösse</arg> + </cmdsynopsis> + <cmdsynopsis> + <command>sdisklabel</command> + <arg choice="plain">gerät</arg> + <arg choice="plain">partnum</arg> + <arg choice="plain">offset</arg> + <arg choice="plain">größe</arg> + <arg choice="plain">parttype</arg> + </cmdsynopsis> +</refsynopsisdiv> +<!-- <refsect1><title>SYNOPSIS</title> +<para>sdisklabel <parameter>drive [print|zero|sum]</parameter></para> +<para>sdisklabel <parameter>drive size partsize</parameter></para> +<para>sdisklabel <parameter>drive partnum offset size parttype</parameter></para> +</refsect1> --> + +<refsect1><title>COPYRIGHT</title> +<para> +<application>sdisklabel</application> unterliegt dem Copyright von Red Hat +Inc. Der Autor dieser Handbuchseite hat versucht, den Originalautor des +Programms ausfindig zu machen, was ihm aber nicht gelungen ist. Ein +abschließender Bugzilla-Eintrag bei Red Hat ergab die folgende Antwort: +<quote> +I can't track down a Bob Manson (and I cannot find any record of his association +with Red Hat in the aboot sources), but any work he did on behalf of Red Hat +would be property of Red Hat, and you can consider all our changes to be release +under the GPL the same as the rest of the aboot package.</quote> + +</para> +</refsect1> + +<refsect1><title>BESCHREIBUNG</title> +<para> +<indexterm><primary>sdisklabel</primary></indexterm> +<application>sdisklabel</application> +kann zum Anlegen von Partitionen (genannt Disklabels) auf Linux/Alpha-Systemen +verwendet werden. Sie <emphasis>müssen</emphasis> Disklabels anstatt des +<productname>DOS</productname>-artigen Partitionierungsschematas auf jeder +Festplatte, von der Sie mittels SRM booten, oder welche Sie mit +<productname>HP Tru64</productname> gemeinsam nutzen wollen, verwenden. +Falls Sie stattdessen mit <application>milo</application> booten, dann +dürfen Sie <emphasis>keine</emphasis> Disklabels auf Ihrer +Boot-Festplatte verwenden. +</para> + +<para> +Selbst wenn Sie Disklabels verwenden, wird der Einsatz von +<application>fdisk</application>(8) anstelle von +<application>sdisklabel</application> empfohlen. +</para> + +<para> +<application>sdisklabel</application> nimmt desweiteren an, daß Sie +eine SCSI-Festplatte mit 512 Byte Sektoren haben, obwohl es auch +problemlos auf IDE-Laufwerken arbeiten sollte. Alle Größenangaben werden +auf der Kommandozeile in Sektoren angegeben. +</para> + +<para> +Es gibt insgesamt 8 Partitionen, nummeriert von 0 bis 7. Sie entsprechen +den BSD Disklabels A bis H. Partitionen müssen sequentiell hinzugefügt +werden, da <application>sdisklabel</application> im Gegensatz zu vielen anderen +BSD-Disklabel-Programmen keine leeren Partitionen erlaubt. Falls Sie dies +möchten (oder falls Sie überlappende Disklabels wollen), verwenden Sie +stattdessen <application>fdisk</application>(8). +</para> + +<para> +Zuersteinmal, wenn Sie ein ungültiges Disklabel haben (Sie haben +<application>sdisklabel</application> auf dieser Festplatte nie zuvor +verwendet), dann müssen Sie +</para> + +<para> +<command> +sdisklabel <parameter>/dev/sda zero</parameter> +</command> +</para> + +<para> +eingeben (<filename>/dev/sda</filename> ist das Gerät, das Sie +partitionieren, passen Sie es entsprechend an). +</para> + +<para> +Dies überschreibt Ihr Disklabel. Verwenden Sie dies nur, wenn Sie das +Disklabel wirklich überschreiben wollen. Es macht genau das; es fragt +nicht, oder warnt nicht, oder sonstwas. +</para> + +<para> +Das Programm hat wahrscheinlich auch die Größe Ihrer Festplatte in kB +ausgegeben. Falls dies falsch war, können Sie die »<parameter>size +xxx</parameter>«-Option zusammen mit den restlichen Kommandos verwenden. +Die Größe ist nicht kritisch, sie wird nur verwendet, um zu versuchen, +sie am Überschreiten des Endes der Festplatte zu hindern. +</para> + +<para> +Als nächstes fügen Sie Ihre erste Partition hinzu. Diese fängt +<emphasis>nicht</emphasis> bei 0 an, da Sie für den Bootloader und +anderen Kram Platz lassen müssen. 256 kB (oder 512 Sektoren) sind genug. +</para> + +<para> +Nehmen wir an, daß Sie eine 250000 kB große Partition, beginnend beim +Sektor-Offset 512, anlegen wollen: +</para> + +<para> +<command> +sdisklabel <parameter>/dev/sda 0 512 500000 8 print</parameter> +</command> +</para> + +<para> +Die letzte Zahl ist der Dateisystemtyp, und ist derzeit 8 für ext2fs +Dateisysteme (Eine andere Zahl würde verwendet, um beispielsweise eine +<productname>Tru64</productname>-Partition anzugeben). +</para> + +<para> +Falls alles erfolgreich war, zeigt das Programm die Partition an (das letzte +Schlüsselwort, »print«, spezifiziert, das es die Partition nach der Veränderung +mit dem vorhergehenden Befehl anzeigen soll), und Sie sollten etwas ähnlich zu +</para> + +<para> +<blockquote> +<literallayout> +---------------------------------------------------------- +I think your disk is 528870K total size. +If I'm wrong, override the size with the 'size num' option + +partition 0: type 8, starts sector 512, size 500000 +---------------------------------------------------------- +</literallayout> +</blockquote> +</para> + +<para> +sehen. Sie können dann die nächste Partition, dies wäre dann Partition 1, +hinzufügen. Um eine zweite Partition, die 200000 kB lang ist, hinzuzufügen, +geben Sie +</para> + +<para> +<command> +sdisklabel <parameter>/dev/sda 1 512256 400000 8 print</parameter> +</command> +</para> +<para> +ein und beide Partitionen würden ausgegeben. +</para> + +<para> +Falls aus irgendeinem Grund die Größe falsch bestimmt worden wäre, würden +Sie stattdessen +</para> +<para> +<command> +sdisklabel <parameter>/dev/sda size 528870 0 512 400000 8 print</parameter> +</command> +</para> + +<para> +eingeben. Die »size«-Option sollte direkt dem Gerätenamen folgen, und +die Größe ist die Gesamtanzahl von Sektoren auf diesem Laufwerk. +</para> + +</refsect1> +<refsect1><title>FEHLER</title> +<para> +<application>sdisklabel</application> prüft nicht auf alle Fehler, bitte +mit Vorsicht benutzen. +</para> +</refsect1> +<refsect1><title>ANMERKUNGEN</title> +<para> +Falls Sie die Festplatte mit <productname>HP Tru64</productname> +(<productname>OSF/1</productname>) gemeinsam nutzen wollen, wird +empfohlen, die Partitionierungswerkzeuge von <productname>Tru64</productname> +zu verwenden, um die Festplatte vorzubereiten. +</para> +<para> +Um tatsächlich von der frisch markierten Festplatte zu booten müssen Sie +ebenfalls einen Urlader (boot strap) installieren, lesen Sie hierzu +<application>aboot</application>(8) und <application>swriteboot</application>(8) +für Einzelheiten. +</para> +<para> +Das »print«-Kommando kann vor oder nach jedem anderen Kommando angegeben werden. +</para> +<para> +Falls Sie leere Partitionen erhalten oder Labels, die über das Ende der +Festplatte hinausreichen, erstellen wollen (z.B. wenn Sie wissen, daß +<application>sdisklabel</application> eine falsche Größe meldet), dann +können Sie den <parameter>force</parameter>-Schalter auf der Kommandozeile +verwenden. +</para> +</refsect1> +<refsect1><title>AUTOR</title> +<para> +Diese Handbuchseite wurde von Helge Kreutzmann <email>debian@helgefjell.de</email> +für das Debian GNU/Linux-Projekt geschrieben; Sie kann aber von +anderen verwendet werden. Sie basiert wesentlich auf der bei den +<application>sdisklabel</application>-Quellen mitgelieferten +<filename>README</filename>-Datei. +</para> +</refsect1> +<refsect1><title>SIEHE AUCH</title> +<para> +<application>fdisk</application>(8), <application>aboot</application>(8), <application>swriteboot</application>(8) +</para> +</refsect1> +</refentry> diff --git a/package/aboot/src/doc/man/de/srmbootfat.sgml b/package/aboot/src/doc/man/de/srmbootfat.sgml new file mode 100644 index 000000000..5711983b9 --- /dev/null +++ b/package/aboot/src/doc/man/de/srmbootfat.sgml @@ -0,0 +1,86 @@ +<!DOCTYPE RefEntry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="srmbootfat"> + +<refmeta> +<refentrytitle>srmbootfat</refentrytitle> +<manvolnum>1</manvolnum> +<refmiscinfo>srmbootfat</refmiscinfo> +</refmeta> + +<refnamediv> +<refname>srmbootfat</refname> +<refpurpose> +Linux/Alpha SRM Boot-Block-Ersteller +</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>srmbootfat</command> + <arg choice="plain">dateisystem_image</arg> + <arg choice="plain">boot_datei</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<!-- <refsect1><title>COPYRIGHT</title> +<para> +</para> +</refsect1> --> + +<refsect1><title>BESCHREIBUNG</title> +<para> +<indexterm><primary>srmbootfat</primary></indexterm> +Dieses Werkzeug ist schnell zusammengestrickt und sollte in seiner +derzeitigen Form nicht lange existieren. +</para> + +<para> +<application>Srmbootfat</application> findet die <filename>boot_datei</filename> +im Wurzelverzeichnis des in der Datei +<filename>dateisystem_image</filename> gespeicherten +<acronym>FAT</acronym>-Dateisystems und macht dies bootbar indem es den +geeigneten SRM-Boot-Block in diese Dateisystem-Image-Datei schreibt. +Dies funktioniert nur mit nicht partitionierten Medien (wie beispielsweise +Disketten), da andernfalls der Boot-Block in die Partitionstabelle geschrieben +werden müßte, welche sich außerhalb des Dateisystems befindet. Allerdings ist +eine Festplatte, die ein FAT-Dateisystem enthält, höchstwahrscheinlich mit der +PC-Partitionstabelle partitioniert, von der SRM sowieso nicht booten kann. +</para> + +<para> +Der Boot-Lader (<filename>boot_datei</filename>) muß fortlaufend sein, d.h. +hintereinanderfolgende Blöcke belegen. +</para> +</refsect1> + +<refsect1><title>ARGUMENTE</title> +<para> +<variablelist> +<varlistentry><term><filename>dateisystem_image</filename></term> +<listitem><para> +Der Name der Datei die das FAT-Dateisystem-Image enthält, bspw. +<filename>/dev/fd0</filename>. +</para></listitem></varlistentry> +<varlistentry><term><filename>boot_datei</filename></term> +<listitem><para> +Der Dateiname des Boot-Laders. +</para></listitem></varlistentry> +</variablelist> +</refsect1> + +<!-- <refsect1><title>FEHLER</title> +<para> +</para> +</refsect1> --> + +<refsect1><title>AUTOR</title> +<para> +Nikita Schmidt <email>cetus@snowball.ucd.ie</email> +</para> +</refsect1> +<refsect1><title>SIEHE AUCH</title> +<para> +<application>aboot</application>(8), <application>mke2fs</application>(8), <application>e2writeboot</application>(8) +</para> +</refsect1> +</refentry> diff --git a/package/aboot/src/doc/man/de/srmbootraw.sgml b/package/aboot/src/doc/man/de/srmbootraw.sgml new file mode 100644 index 000000000..465401ecd --- /dev/null +++ b/package/aboot/src/doc/man/de/srmbootraw.sgml @@ -0,0 +1,84 @@ +<!DOCTYPE RefEntry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="srmbootraw"> + +<refmeta> +<refentrytitle>srmbootraw</refentrytitle> +<manvolnum>8</manvolnum> +<refmiscinfo>srmbootraw</refmiscinfo> +</refmeta> + +<refnamediv Lang="de"> +<refname>srmbootraw</refname> +<refpurpose> +Linux/Alpha SRM Bootblock-Ersteller +</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>srmbootraw</command> + <arg choice="plain">boot_gerät</arg> + <arg choice="plain">boot_datei</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<!-- <refsect1><title>COPYRIGHT</title> +<para> +</para> +</refsect1> --> + +<refsect1><title>BESCHREIBUNG</title> +<para> +<indexterm><primary>srmbootraw</primary></indexterm> +Dieses Werkzeug ist ein schneller Hack und soll in seinem derzeitigen +Zustand nicht lange exisitieren. +</para> + +<para> +<application>Srmbootraw</application> schreibt das Image aus +<filename>boot_datei</filename> +mit vorangestelltem SRM Bootblock unter Beibehaltung des disklabels +in die ersten Blocks des <filename>boot_geräts</filename>. +Es ist dazu gedacht, wenn Sie eine kleine rohe, für den Bootloader +dedizierte Partition am Anfang Ihrer Festplatte haben. Falls Sie diese +nicht haben, wird <application>srmbootraw</application> ohne Fehlermeldung +Ihr System unbenutzbar machen. +</para> +</refsect1> + +<refsect1><title>ARGUMENTE</title> +<para> +<variablelist> +<varlistentry><term><filename>boot_gerät</filename></term> +<listitem><para> +Das Gerät von dem Sie planen zu booten, bspw. <filename>/dev/sda</filename>. +Es muß genug Platz am Anfang sein, um den Bootblock und den Bootloader +aufzunehmen. +</para></listitem></varlistentry> +<varlistentry><term><filename>boot_datei</filename></term> +<listitem><para> +Der Dateiname des Bootloaders. +</para></listitem></varlistentry> +</variablelist> +</refsect1> + +<!-- <refsect1><title>FEHLER</title> +<para> +</para> +</refsect1> --> + +<refsect1><title>AUTOR</title> +<para> +Nikita Schmidt <email>cetus@snowball.ucd.ie</email> +</para> +</refsect1> +<refsect1><title>SIEHE AUCH</title> +<para> +<application>aboot</application>(8), +<application>mke2fs</application>(8), +<application>swriteboot</application>(8), +<application>e2writeboot</application>(8), +<application>srmbootfat</application>(1) +</para> +</refsect1> +</refentry> diff --git a/package/aboot/src/doc/man/de/swriteboot.8 b/package/aboot/src/doc/man/de/swriteboot.8 new file mode 100644 index 000000000..69e25e2f9 --- /dev/null +++ b/package/aboot/src/doc/man/de/swriteboot.8 @@ -0,0 +1,61 @@ +.\" sdisklabel - Write secondary SRM bootloader to harddisk +.\" +.\" Translated to german by Helge Kreutzmann <debian@helgefjell.de> +.TH swriteboot 8 "27 Juni 2004" "David Mosberger" "" +.SH NAME +swriteboot \- Schreibt sekundären SRM-Boot-Lader auf Festplatte. +.SH "ÜBERSICHT" +\fBswriteboot\fP [-v] [-f#] <gerät> <bootlader> [kernel] +.SH BESCHREIBUNG + +\fBswriteboot\fP kann zum Schreiben des sekundären Boot-Laders und -- +optional -- eines Kernels auf die Festplatte verwendet werden. Das +Ladeprogramm ist so geschrieben, daß es der SRM-Firmware erlaubt, davon +zu booten (SRM ist die Firmware, die auch zum Booten von \fBHP Tru64\fP, +\fBOpenVMS\fP und *BSD verwendet wird). Insbesondere ist das Ladeprogramm +so geschrieben, daß ein physikalisch kontinuierlicher Bereich von Sektoren, +beginnend bei Sektor 2 belegt wird und das der erste Sektor so aktualisiert +wird, daß die SRM-Firmware den Boot-Lader finden kann. \fBswriteboot\fP +kann versagen, falls der Bootstrap-Lader zu groß ist, um in die reservierten +Sektoren zu passen. Es wird daher empfohlen, die ersten 512 Sektoren +einer Festplatte für Boot-Zwecke zu reservieren. Dies läßt 256 kB Platz +für einen sekundären Bootstrap-Lader, was massig ausreichen sollte (derzeit +ist der \fBaboot\fP(8) Bootstrap-Lader ungefähr 90 kB groß). Reservieren Sie +mehr, falls Sie dort auch einen Kernel haben wollen - 2 MB sollte in diesem +Fall ausreichen. + +.P +Das \fI<gerät>\fP-Argument bestimmt das spezielle Gerät auf das die +\fI<bootlader>\fP-Datei geschrieben werden soll. Die Boot-Lader-Datei +muß ein »Header-Less«-Image (keine Objekt-Datei) sein, die den rohen +Inhalt der Text-, Data- und BSS-Sektionen enthält. Ein typisches Kommando +um SCSI-Platte 0 bootbar mit dem \fIaboot\fP(8)-Lader zu machen wird im +folgenden gezeigt: + +.I »swriteboot /dev/sda bootlx« + +.P +Die \fI-v\fP Option sorgt für etwas ausführlichere Meldungen von +\fBswriteboot\fP. +.P +Die \fI-f#\fP Option teilt \fBswriteboot\fP mit, einen Überlapp des Bootbereichs +mit der Partition \fI#\fP zu ignorieren. +.P +Die \fI-c#\fP Option teilt \fBswriteboot\fP explizit die Boot-Partition mit. +Falls dieses Argument fehlt, versucht \fBswriteboot\fP falls möglich die +Boot-Partition automatisch zu erkennen. Beachten Sie, daß Sie die +Boot-Partition später ebenfalls mit \fBabootconf\fP(8) setzten können. + +.nf +.SH SIEHE AUCH +.IR aboot (8) , +.IR abootconf (8) , +.IR mke2fs (8) , +.IR e2writeboot (8) +.nf +.SH AUTOREN +.nf +Bob Manson <manson@magnus.acs.ohio-state.edu> +Michael Schwingen <michael@schwingen.org> +Helge Kreutzmann <debian@helgefjell.de> (Aktualisierung der Handbuchseite) +.fi diff --git a/package/aboot/src/doc/man/e2writeboot.8 b/package/aboot/src/doc/man/e2writeboot.8 new file mode 100644 index 000000000..520b9ca90 --- /dev/null +++ b/package/aboot/src/doc/man/e2writeboot.8 @@ -0,0 +1,42 @@ +.\" e2writeboot - Write secondary SRM bootloader to ext2 filesystem. +.TH e2writeboot 8 "17 January 1995" "David Mosberger-Tang" "" +.SH NAME +e2writeboot \- Write secondary SRM bootloader to ext2 filesystem. +.SH SYNOPSIS +\fBe2writeboot\fP <ext2fs> <bootloader> +.SH DESCRIPTION + +\fBe2writeboot\fP can be used to write a secondary bootstrap loader to +an ext2 formatted filesystem (normally on a floppy disk). The loader +is written in a way that allows the SRM firmware to boot from the +filesystem (SRM is the firmware that is also used to boot +\fBHP Tru64\fP, \fBOpenVMS\fP and *BSD). Specifically, the +loader is written to occupy a physically +contiguous range of sectors and the first sector is updated such that +the SRM firmware can find the boot loader. The loader is always +stored with filename \fBlinuxboot\fP and if such a file already +exists, it will be overwritten unconditionally. This command may +fail if the filesystem is highly fragmented. If so, re-format the +filesystem with \fBmke2fs\fP(8) (this will destroy the existing contents +of the filesystem, so use this with care). + +.P +The \fI<ext2fs>\fP argument specifies the filesystem or special device +to which the \fI<bootloader>\fP file should be written to. The boot +loader file must be an ECOFF object file. A typical command to make a +floppy disk bootable with the \fIaboot\fP(8) loader is shown below: + +.I "e2writeboot /dev/fd0 aboot" + +.nf +.SH SEE ALSO +.IR aboot (8) , +.IR mke2fs (8) , +.IR swriteboot (8) +.nf +.SH AUTHORS +.nf +Jim Paradis <paradis@amt.tay1.dec.com> +Jay Estabrook <Jay.Estabrook@hp.com> +David Mosberger-Tang <David.Mosberger@acm.org> +.fi diff --git a/package/aboot/src/doc/man/isomarkboot.8 b/package/aboot/src/doc/man/isomarkboot.8 new file mode 100644 index 000000000..9d1100c30 --- /dev/null +++ b/package/aboot/src/doc/man/isomarkboot.8 @@ -0,0 +1,58 @@ +.\" This manpage has been automatically generated by docbook2man-spec +.\" from a DocBook document. docbook2man-spec can be found at: +.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "ISOMARKBOOT" "8" "17 Januar 2003" "isomarkboot" "" +.SH NAME +isomarkboot \- Create bootable CD-ROMs for Linux/Alpha systems. +.SH SYNOPSIS +.sp +\fBisomarkboot\fR \fB/dev/xxx\fR \fBpath/to/bootlx\fR [ \fBpath/to/root.bin\fR ] +.SH "COPYRIGHT" +.PP +\fBisomarkboot\fR is Copyright (C) 1996 David Mosberger-Tang +.SH "DESCRIPTIONS" +.PP + +\fBisomarkboot\fR +enables ISO images created with \fBmkisofs\fR(8) or +retrieved from the net +to be booted on Linux/Alpha systems. +.PP +First you have to prepare your ISO image and mount it loopback on +\fI/dev/xxx\fR (typically \fI/dev/loop0\fR) +(see \fBmount\fR(8) for details). +.PP +Next you need to locate the aboot-loader (called \fIbootlx\fR) +and the ram disk image containing the root file system (the latter is optional +but usually sensible to specify) which is often called +\fIroot.bin\fR within your ISO image. +.PP +Finally enable the image to be booted: +.PP +\fBisomarkboot \fI/dev/xxx path/to/bootlx path/to/root.bin\fB\fR +.PP +A typical location of \fIbootlx\fR on the disk image is +\fIboot/bootlx\fR. The path of \fIbootlx\fR +and \fIroot.bin\fR are relative to the root of the image. If +your image is not mounted you have to replace \fI/dev/xxx\fR +with the path to the image. +.PP +Finally you have to burn the CD using e.g. +\fBxcdroast\fR after unmounting the image. +.SH "BUGS" +.PP +\fBisomarkboot\fR is currently only available on +Linux/Alpha systems though it can be compiled and used with minor +modifications on other platforms as well. +.SH "NOTES" +.PP +\fBisomarkboot\fR is capable of handling symlinks +within the image. +.SH "AUTHOR" +.PP +This man page was written by Helge Kreutzmann <kreutzm@itp.uni-hannover.de> for the Debian GNU/Linux project but may be used by others. +.SH "SEE ALSO" +.PP +\fBaboot\fR(8), \fBmkisofs\fR(8) diff --git a/package/aboot/src/doc/man/isomarkboot.sgml b/package/aboot/src/doc/man/isomarkboot.sgml new file mode 100644 index 000000000..a6e394b2b --- /dev/null +++ b/package/aboot/src/doc/man/isomarkboot.sgml @@ -0,0 +1,97 @@ +<!DOCTYPE RefEntry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="isomarkboot"> + +<refmeta> +<refentrytitle>isomarkboot</refentrytitle> +<manvolnum>1</manvolnum> +<refmiscinfo>isomarkboot</refmiscinfo> +</refmeta> + +<refnamediv> +<refname>isomarkboot</refname> +<refpurpose> +Create bootable CD-ROMs for Linux/Alpha systems. +</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>isomarkboot</command> + <arg choice="plain">/dev/xxx</arg> + <arg choice="plain">path/to/bootlx</arg> + <arg choice="opt">path/to/root.bin</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>COPYRIGHT</title> +<para> +<application>isomarkboot</application> is Copyright (C) 1996 David Mosberger-Tang +</para> +</refsect1> + +<refsect1><title>DESCRIPTIONS</title> +<para> +<indexterm><primary>isomarkboot</primary></indexterm> +<application>isomarkboot</application> +enables ISO images created with <application>mkisofs</application>(8) or +retrieved from the net +to be booted on Linux/Alpha systems. +</para> + +<para> +First you have to prepare your ISO image and mount it loopback on +<filename>/dev/xxx</filename> (typically <filename>/dev/loop0</filename>) +(see <application>mount</application>(8) for details). +</para> + +<para> +Next you need to locate the aboot-loader (called <filename>bootlx</filename>) +and the RAM-disk image containing the root file system (the latter is optional +but usually sensible to specify) which is often called +<filename>root.bin</filename> within your ISO image. +</para> +<para> +Finally enable the image to be booted: +</para> +<para> +<command> +isomarkboot <parameter>/dev/xxx path/to/bootlx path/to/root.bin</parameter> +</command> +</para> +<para> +A typical location of <filename>bootlx</filename> on the disk image is +<filename>boot/bootlx</filename>. The paths of <filename>bootlx</filename> +and <filename>root.bin</filename> are relative to the root of the image. If +your image is not mounted you have to replace <filename>/dev/xxx</filename> +with the path to the image. +</para> + +<para> +Finally you have to burn the CD using e.g. +<application>xcdroast</application> after unmounting the image. +</para> + +</refsect1> +<refsect1><title>BUGS</title> +<para> +<application>isomarkboot</application> is not heavily tested on +architectures other than Linux/Alpha, though it compiles (with +slight patches). Please report bugs if you experience them. +</para> +</refsect1> +<refsect1><title>NOTES</title> +<para> +<application>isomarkboot</application> is capable of handling symlinks +within the image. +</para> +</refsect1> +<refsect1><title>AUTHOR</title> +<para> +This man page was written by Helge Kreutzmann <email>debian@helgefjell.de</email> for the Debian GNU/Linux project but may be used by others. +</para> +</refsect1> +<refsect1><title>SEE ALSO</title> +<para><application>aboot</application>(8), <application>mkisofs</application>(8) +</para> +</refsect1> +</refentry> diff --git a/package/aboot/src/doc/man/netabootwrap.sgml b/package/aboot/src/doc/man/netabootwrap.sgml new file mode 100644 index 000000000..4e96ae8f2 --- /dev/null +++ b/package/aboot/src/doc/man/netabootwrap.sgml @@ -0,0 +1,102 @@ +<!DOCTYPE RefEntry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="netabootwrap"> + +<refmeta> +<refentrytitle>netabootwrap</refentrytitle> +<manvolnum>1</manvolnum> +<refmiscinfo>netabootwrap</refmiscinfo> +</refmeta> + +<refnamediv> +<refname>netabootwrap</refname> +<refpurpose> +builds network bootable images for Linux/Alpha +</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>netabootwrap</command> + <arg choice="opt">-t netboot.img</arg> + <arg choice="opt">-k vmlinux.gz</arg> + <arg choice="opt">-i initrd.gz</arg> + <arg choice="opt">-a "some kernel parameters"</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>COPYRIGHT</title> +<para> +<application>netabootwrap</application> is (c) 2000 by Soohoon Lee +<email>soohoon.lee@api-networks.com</email> +</para> +</refsect1> + +<refsect1><title>DESCRIPTIONS</title> +<para> +<indexterm><primary>netabootwrap</primary></indexterm> +<application>netabootwrap</application> merges <filename>net_aboot</filename>, +kernel and initrd +images to build the network bootable image for Linux/Alpha systems. +<filename>net_aboot.nh</filename> will not be usable but +<application>netabootwrap</application> has all +the functions. Without options, It'll look for <filename>vmlinux.gz</filename> +and build <filename>netboot.img</filename>, which is <filename>net_aboot</filename> ++ <filename>vmlinux.gz</filename>. +</para> + +<para> +<variablelist> +<varlistentry><term>-t filename</term> +<listitem><para> +Sets the file name of the netboot image to be created, default is <filename>netboot.img</filename>. This file will be unconditionally overwritten if it exists. +</para></listitem></varlistentry> +<varlistentry><term>-k filename</term> +<listitem><para> +Sets the file name of the kernel image, default is <filename>vmlinux.gz</filename> +</para></listitem></varlistentry> +<varlistentry><term>-i filename</term> +<listitem><para> +Sets the file name of the initial RAM-disk image, default is <filename>initrd.gz</filename> +</para></listitem></varlistentry> +<varlistentry><term>-a "some kernel options"</term> +<listitem><para> +Provide additional kernel options, e.g. -a "root=/dev/sda1 single" +</variablelist> +</para> + +</refsect1> + +<!-- <refsect1><title>BUGS</title> +<para> +</para> + +</refsect1> --> + +<refsect1><title>NOTES</title> +<para> +To actually use the image, you need a <application>tftpd</application>(8) server and a +<application>dhcp</application>(8) or <application>bootpd</application>(8) +server. You can find further details in the SRM-HOWTO: +(<ULink URL="http://www.alphalinux.org/faq/srm.html"></ULink> or in +<filename>/usr/share/doc/aboot/SRM-HOWTO/</filename> on Debian GNU/Linux +systems (and possibly others)) +</para> + +</refsect1> + +<refsect1><title>AUTHOR</title> +<para> +This man page was written by Helge Kreutzmann <email>debian@helgefjell.de</email> for the Debian GNU/Linux project but may be used by others. +</para> +</refsect1> +<refsect1><title>SEE ALSO</title> +<para> +<application>tftpd</application>(8), +<application>dhcpd</application>(8), +<application>bootpd</application>(8), +<application>aboot</application>(8), +SRM-HOWTO in <filename>/usr/share/doc/aboot/SRM-HOWTO/</filename> or <ULink URL="http://www.alphalinux.org/faq/srm.html"></ULink>, +HP SRM Manual (<ULink URL="http://h18002.www1.hp.com/alphaserver/download/srm_reference.pdf"></ULink>) +</para> +</refsect1> +</refentry> diff --git a/package/aboot/src/doc/man/sdisklabel.8 b/package/aboot/src/doc/man/sdisklabel.8 new file mode 100644 index 000000000..dc2775c70 --- /dev/null +++ b/package/aboot/src/doc/man/sdisklabel.8 @@ -0,0 +1,152 @@ +.\" This manpage has been automatically generated by docbook2man-spec +.\" from a DocBook document. docbook2man-spec can be found at: +.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "SDISKLABEL" "8" "23 November 2003" "sdisklabel" "" +.SH NAME +sdisklabel \- Create/modify disklabels on Linux/Alpha systems +.SH SYNOPSIS +.sp +\fBsdisklabel\fR \fBdrive\fR [ \fB print zero sum\fR ] +.sp +\fBsdisklabel\fR \fBdrive\fR \fBsize\fR \fBpartsize\fR +.sp +\fBsdisklabel\fR \fBdrive\fR \fBpartnum\fR \fBoffset\fR \fBsize\fR \fBparttype\fR +.SH "COPYRIGHT" +.PP +\fBsdisklabel\fR is Copyright (C) by Red Hat Inc. The +author of this man page tried to track down the original author, but was +unable to do so. A final Bugzilla entry with RedHat yielded the following +reply: +``I can't track down a Bob Manson (and I cannot find any record of his association +with Red Hat in the aboot sources), but any work he did on behalf of Red Hat +would be property of Red Hat, and you can consider all our changes to be release +under the GPL the same as the rest of the aboot package.'' +.SH "DESCRIPTIONS" +.PP + +\fBsdisklabel\fR +can be used to create partitions (called disklabels) on Linux/Alpha +systems. You \fBmust\fR use disklabels instead of the +DOS type +partitioning scheme on any hard disk which you want to boot from via SRM or +which you want to share with HP Tru64. +If you instead are booting from \fBmilo\fR +then you \fBmust not\fR use disklabels on your boot hard disk. +.PP +Even if you are using disklabels, it is recommended to use +\fBfdisk\fR(8) instead +of \fBsdisklabel\fR. +.PP +\fBsdisklabel\fR also assumes +you have a SCSI disk with 512-byte sectors, +though it should work fine on an IDE drive as well. All sizes are +specified on the command line in sectors. +.PP +There are 8 partitions in total which are numbered from 0 to 7. They +correspond to BSD disklabels A to H. +Partitions have to be added sequentially, as +\fBsdisklabel\fR won't let +you leave empty partitions unlike many BSD disklabel programs. If you +want this (or if you want overlapping disk labels) +use \fBfdisk\fR(8) instead. +.PP +First off, if you have an invalid disk label (you've never run +\fBsdisklabel\fR on this disk +before) you have to issue +.PP +\fBsdisklabel \fI/dev/sda zero\fB\fR +.PP +(\fI/dev/sda\fR is the device you're partitioning, +substitute as appropriate). +.PP +This zeros out your disk label. Only do this if you really want to +zero your disk label. It just does it; it doesn't ask, or warn, or +anything. +.PP +The program also probably printed out the size of your disk in kb. If +it was wrong, you now get to use the "\fIsize xxx\fR" +option along with the +rest of these commands. The size isn't critical, it's just used to try +and make sure you don't go past the end of the disk. +.PP +Next, add your first partition. This \fBdoesn't\fR +start from 0, as you +have to leave room for the boot loader and other stuff. 256K (or 512 +sectors) will be enough. +.PP +Let's pretend that you want to make a 250000 kb partition starting +from sector offset 512: +.PP +\fBsdisklabel \fI/dev/sda 0 512 500000 8 print\fB\fR +.PP +The last number is the filesystem type, and is currently 8 for ext2fs +filesystems. (A different number would be used to specify an +Tru64 +partition, for example). +.PP +If all was successful, the program should print out the partition (the +last keyword, "print", specifies that it should print the partition +after modifying it with the previous command), and you should see +something like +.PP +.sp +.RS +.sp +.nf +---------------------------------------------------------- +I think your disk is 528870K total size. +If I'm wrong, override the size with the 'size num' option + +partition 0: type 8, starts sector 512, size 500000 +---------------------------------------------------------- +.sp +.fi +.RE +.sp +.PP +You can then add the next partition, which would be partition 1. +To add a second partition that is 200000 kb long, you'd run +.PP +\fBsdisklabel \fI/dev/sda 1 512256 400000 8 print\fB\fR +.PP +And both partitions would then be printed out. +.PP +If for some reason the size got determined incorrectly, you'd do +instead +.PP +\fBsdisklabel \fI/dev/sda size 528870 0 512 400000 8 print\fB\fR +.PP +The size option should come immediately after the device name, and the +size is the total # of sectors on the drive. +.SH "BUGS" +.PP +\fBsdisklabel\fR does not check for all errors, so +use with care. +.SH "NOTES" +.PP +If you want to share the disk with HP Tru64 +(OSF/1) it is recommended to +use the Tru64 +partitioning tools to prepare the disk. +.PP +To actually boot from the freshly labeled disk you also need to install +a boot strap as well, see +\fBaboot\fR(8) and \fBswriteboot\fR(8) +for details. +.PP +The print command may be placed before or after any other command. +.PP +In case you do want to leave empty partitions or create labels which +extend beyond the end of the disk (e.g. when you know +\fBsdisklabel\fR is reporting a wrong size) then +use can use the \fIforce\fR switch on the command line. +.SH "AUTHOR" +.PP +This man page was written by Helge Kreutzmann <kreutzm@itp.uni-hannover.de> for the Debian GNU/Linux project but may be used by others. It is +heavily based on the \fIREADME\fR provided along with the +\fBsdisklabel\fR source. +.SH "SEE ALSO" +.PP +\fBfdisk\fR(8), \fBaboot\fR(8), \fBswriteboot\fR(8) diff --git a/package/aboot/src/doc/man/sdisklabel.copyright b/package/aboot/src/doc/man/sdisklabel.copyright new file mode 100644 index 000000000..382d0a446 --- /dev/null +++ b/package/aboot/src/doc/man/sdisklabel.copyright @@ -0,0 +1,32 @@ +The author is unkown, it is not David Mosberger-Tang, Jim Paradies, Michael Schwingen +or Jay Estabrook. I could not locate Bob Manson. An entry in RedHat's bugzilla +yielded the following notice which I reproduce verbatim here: + +https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=71437 + +--- shadow/71437 Tue Aug 13 13:22:49 2002 ++++ shadow/71437.tmp.9824 Thu Aug 15 21:23:45 2002 +@@ -3,8 +3,8 @@ + Version: 7.1 + Platform: alpha + OS/Version: Linux +-Status: NEW +-Resolution: ++Status: CLOSED ++Resolution: WORKSFORME + Severity: normal + Priority: normal + Component: aboot +@@ -45,3 +45,9 @@ + + The reason is that I'd like to know the copyright and I am wrinting the + man pages (which can be included in the next RH/Alpha release as well). + ++------- Additional comments from sopwith@redhat.com 2002-08-15 21:31:59 ------- ++I can't track down a Bob Manson (and I cannot find any record of his association ++with Red Hat in the aboot sources), but any work he did on behalf of Red Hat ++would be property of Red Hat, and you can consider all our changes to be release ++under the GPL the same as the rest of the aboot package. + + +Helge Kreutzmann <debian@helgefjell.de>, September 4th 2002 diff --git a/package/aboot/src/doc/man/sdisklabel.sgml b/package/aboot/src/doc/man/sdisklabel.sgml new file mode 100644 index 000000000..959219ff2 --- /dev/null +++ b/package/aboot/src/doc/man/sdisklabel.sgml @@ -0,0 +1,246 @@ +<!DOCTYPE RefEntry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="sdisklabel"> + +<refmeta> +<refentrytitle>sdisklabel</refentrytitle> +<manvolnum>8</manvolnum> +<refmiscinfo>sdisklabel</refmiscinfo> +</refmeta> + +<refnamediv> +<refname>sdisklabel</refname> +<refpurpose> +Create/modify disklabels on Linux/Alpha systems +</refpurpose> +</refnamediv> + +<!-- This is the proper SGML way, but somehow doesn't work here --> +<refsynopsisdiv> + <cmdsynopsis> + <command>sdisklabel</command> + <arg choice="plain">device</arg> + <group choice="opt"><arg choice="plain">print</arg> + <arg choice="plain">zero</arg> + <arg choice="plain">sum</arg> + </group> + </cmdsynopsis> + <cmdsynopsis> + <command>sdisklabel</command> + <arg choice="plain">device</arg> + <arg choice="plain">size</arg> + <arg choice="plain">partsize</arg> + </cmdsynopsis> + <cmdsynopsis> + <command>sdisklabel</command> + <arg choice="plain">device</arg> + <arg choice="plain">partnum</arg> + <arg choice="plain">offset</arg> + <arg choice="plain">size</arg> + <arg choice="plain">parttype</arg> + </cmdsynopsis> +</refsynopsisdiv> +<!-- <refsect1><title>SYNOPSIS</title> +<para>sdisklabel <parameter>drive [print|zero|sum]</parameter></para> +<para>sdisklabel <parameter>drive size partsize</parameter></para> +<para>sdisklabel <parameter>drive partnum offset size parttype</parameter></para> +</refsect1> --> + +<refsect1><title>COPYRIGHT</title> +<para> +<application>sdisklabel</application> is Copyright (C) by Red Hat Inc. The +author of this man page tried to track down the original author, but was +unable to do so. A final Bugzilla entry with RedHat yielded the following +reply: +<quote> +I can't track down a Bob Manson (and I cannot find any record of his association +with Red Hat in the aboot sources), but any work he did on behalf of Red Hat +would be property of Red Hat, and you can consider all our changes to be release +under the GPL the same as the rest of the aboot package.</quote> + +</para> +</refsect1> + +<refsect1><title>DESCRIPTIONS</title> +<para> +<indexterm><primary>sdisklabel</primary></indexterm> +<application>sdisklabel</application> +can be used to create partitions (called disklabels) on Linux/Alpha +systems. You <emphasis>must</emphasis> use disklabels instead of the +<productname>DOS</productname> type +partitioning scheme on any hard disk which you want to boot from via SRM or +which you want to share with <productname>HP Tru64</productname>. +If you instead are booting from <application>milo</application> +then you <emphasis>must not</emphasis> use disklabels on your boot hard disk. +</para> + +<para> +Even if you are using disklabels, it is recommended to use +<application>fdisk</application>(8) instead +of <application>sdisklabel</application>. +</para> + +<para> +<application>sdisklabel</application> also assumes +you have a SCSI disk with 512-byte sectors, +though it should work fine on an IDE drive as well. All sizes are +specified on the command line in sectors. +</para> + +<para> +There are 8 partitions in total which are numbered from 0 to 7. They +correspond to BSD disklabels A to H. +Partitions have to be added sequentially, as +<application>sdisklabel</application> won't let +you leave empty partitions unlike many BSD disklabel programs. If you +want this (or if you want overlapping disk labels) +use <application>fdisk</application>(8) instead. +</para> + +<para> +First off, if you have an invalid disk label (you've never run +<application>sdisklabel</application> on this disk +before) you have to issue +</para> + +<para> +<command> +sdisklabel <parameter>/dev/sda zero</parameter> +</command> +</para> + +<para> +(<filename>/dev/sda</filename> is the device you're partitioning, +substitute as appropriate). +</para> + +<para> +This zeros out your disk label. Only do this if you really want to +zero your disk label. It just does it; it doesn't ask, or warn, or +anything. +</para> + +<para> +The program also probably printed out the size of your disk in kb. If +it was wrong, you now get to use the "<parameter>size xxx</parameter>" +option along with the +rest of these commands. The size isn't critical, it's just used to try +and make sure you don't go past the end of the disk. +</para> + +<para> +Next, add your first partition. This <emphasis>doesn't</emphasis> +start from 0, as you +have to leave room for the boot loader and other stuff. 256K (or 512 +sectors) will be enough. +</para> + +<para> +Let's pretend that you want to make a 250000 kb partition starting +from sector offset 512: +</para> + +<para> +<command> +sdisklabel <parameter>/dev/sda 0 512 500000 8 print</parameter> +</command> +</para> + +<para> +The last number is the filesystem type, and is currently 8 for ext2fs +filesystems. (A different number would be used to specify an +<productname>Tru64</productname> +partition, for example). +</para> + +<para> +If all was successful, the program should print out the partition (the +last keyword, "print", specifies that it should print the partition +after modifying it with the previous command), and you should see +something like +</para> + +<para> +<blockquote> +<literallayout> +---------------------------------------------------------- +I think your disk is 528870K total size. +If I'm wrong, override the size with the 'size num' option + +partition 0: type 8, starts sector 512, size 500000 +---------------------------------------------------------- +</literallayout> +</blockquote> +</para> + +<para> +You can then add the next partition, which would be partition 1. +To add a second partition that is 200000 kb long, you'd run +</para> + +<para> +<command> +sdisklabel <parameter>/dev/sda 1 512256 400000 8 print</parameter> +</command> +</para> +<para> +And both partitions would then be printed out. +</para> + +<para> +If for some reason the size got determined incorrectly, you'd do +instead +</para> +<para> +<command> +sdisklabel <parameter>/dev/sda size 528870 0 512 400000 8 print</parameter> +</command> +</para> + +<para> +The size option should come immediately after the device name, and the +size is the total # of sectors on the drive. +</para> + +</refsect1> +<refsect1><title>BUGS</title> +<para> +<application>sdisklabel</application> does not check for all errors, so +use with care. +</para> +</refsect1> +<refsect1><title>NOTES</title> +<para> +If you want to share the disk with <productname>HP Tru64</productname> +(<productname>OSF/1</productname>) it is recommended to +use the <productname>Tru64</productname> +partitioning tools to prepare the disk. +</para> +<para> +To actually boot from the freshly labeled disk you also need to install +a boot strap as well, see +<application>aboot</application>(8) and <application>swriteboot</application>(8) +for details. +</para> +<para> +The print command may be placed before or after any other command. +</para> +<para> +In case you do want to leave empty partitions or create labels which +extend beyond the end of the disk (e.g., when you know +<application>sdisklabel</application> is reporting a wrong size) then +use can use the <parameter>force</parameter> switch on the command line. +</para> +</refsect1> +<refsect1><title>AUTHOR</title> +<para> +This man page was written by Helge Kreutzmann <email>debian@helgefjell.de</email> for the Debian GNU/Linux project but may be used by others. It is +heavily based on the <filename>README</filename> provided along with the +<application>sdisklabel</application> source. +</para> +</refsect1> +<refsect1><title>SEE ALSO</title> +<para> +<application>fdisk</application>(8), <application>aboot</application>(8), <application>swriteboot</application>(8) +</para> +</refsect1> +</refentry> diff --git a/package/aboot/src/doc/man/swriteboot.8 b/package/aboot/src/doc/man/swriteboot.8 new file mode 100644 index 000000000..485c0f4a7 --- /dev/null +++ b/package/aboot/src/doc/man/swriteboot.8 @@ -0,0 +1,58 @@ +.\" sdisklabel - Write secondary SRM bootloader to harddisk +.TH swriteboot 8 "17 January 1995" "David Mosberger" "" +.SH NAME +swriteboot \- Write secondary SRM bootloader to harddisk. +.SH SYNOPSIS +\fBswriteboot\fP [-v] [-f#] <dev> <bootloader> [kernel] +.SH DESCRIPTION + +\fBswriteboot\fP can be used to write a secondary bootstrap loader +and - optionally - a kernel to +a harddisk. The loader is written in a way that allows the SRM +firmware to boot from that disk (SRM is the firmware that is also used +to boot \fBHP Tru64\fP, \fBOpenVMS\fP and *BSD). +Specifically, the loader is written to occupy +a physically contiguous range of sectors starting at sector 2 and the +first sector is updated such that the SRM firmware can find the boot +loader. \fBswriteboot\fP may fail if the bootstrap loader is too big +to fit into the sectors reserved for boot purposes. It is therefore +suggested to reserve the first 512 sectors of a harddisk for boot +purposes. This will leave 256 kB of space for a secondary bootstrap +loader which should be plenty (currently, the \fBaboot\fP(8) bootstrap +loader is about 90 kB large). Use more if you want to have a kernel in this +area, too - 2 MB should be sufficient in this case. + +.P +The \fI<dev>\fP argument specifies the special device to which the +\fI<bootloader>\fP file should be written to. The boot loader file +must be a header-less image (not an object file) containing the raw +contents of the text, data, and bss sections. A typical command to +make SCSI disk 0 bootable with the \fIaboot\fP(8) loader is shown +below: + +.I "swriteboot /dev/sda bootlx" + +.P +The \fI-v\fP option makes \fBswriteboot\fP be a bit more verbose. +.P +The \fI-f#\fP option tells \fBswriteboot\fP to ignore an overlap of the boot area with +partition \fI#\fP. +.P +The \fI-c#\fP option explicitly tells \fBswriteboot\fP the boot partition. +If this argument is missing, then \fBswriteboot\fP tries to autodetect the +boot partition if possible. Note that you can set the boot partition later +on with \fBabootconf\fP(8) as well. + +.nf +.SH SEE ALSO +.IR aboot (8) , +.IR abootconf (8) , +.IR mke2fs (8) , +.IR e2writeboot (8) +.nf +.SH AUTHORS +.nf +Bob Manson <manson@magnus.acs.ohio-state.edu> +Michael Schwingen <michael@schwingen.org> +Helge Kreutzmann <debian@helgefjell.de> (Update of man page) +.fi |