On Wed, Dec 08, 1999 at 12:21:50PM -0600, Gordon Matzigkeit wrote:
> >> `Linux swap' is not a filesystem that GRUB supports. What would
> >> you like printed instead of `unknown'? Maybe `unsupported' would
> >> be better?
>
> JR> Yes, or print "swap", or not print it at all. It says "possible
> JR> partitions", one might even get an impression that GRUB can boot
> JR> from it (or do anything else with it).
>
> GRUB *can* boot from it, though. You just have to use the blocklist
> notation. ;)
:)
Anyway, I've made some changes to the documentation - although I never
touched a .texi file before, it was quite easy :)
The first thing I noticed was that the menus don't appear in the info file
as they are in the main .texi file. So I managed to change that, and to do
some corrections and updates to the first two sections of the tutorial
(which, for some reason, wasn't included by default before... my info viewer
is the ordinary `info' program, so that might be the reason).
The patches to grub.texi and tutorial.texi are attached to this message.
Please tell me what do you think, what's wrong, and should I send in more
of it. TIA.
Ah, yes, two more things - the Debian maintainer scripts have an error in
invocation of 'case' (that doesn't work with my bash 2.03), so the FHS
compatibility symlinks weren't made. Patches for that, too, are attached to
this message. Second - please rename "README.debian" to "README.Debian",
that's more common, and looks better :)
--
enJoy -*/\*- don't even try to pronounce my first name
Index: grub.texi
===================================================================
RCS file: /home/cvs/grub/docs/grub.texi,v
retrieving revision 1.36
diff -u -r1.36 grub.texi
--- grub.texi 1999/11/18 06:00:23 1.36
+++ grub.texi 1999/12/08 20:06:25
@@ -3,28 +3,32 @@
@c %**start of header
@setfilename grub.info
@settitle GRUB Manual
-@c %**end of header
-
@include version.texi
@c Unify all our little indices for now.
-@syncodeindex fn cp
+@c @syncodeindex fn cp
@syncodeindex vr cp
-@syncodeindex ky cp
+@c @syncodeindex ky cp
@syncodeindex pg cp
-@syncodeindex tp cp
+@c @syncodeindex tp cp
+
+@footnotestyle separate
+@paragraphindent 3
+@finalout
-@dircategory Kernel
+@c %**end of header
+
+@dircategory Disk Management
@direntry
-* GRUB: (grub). The GRand Unified Bootloader
+* GRUB: (grub) The GRand Unified Bootloader
@end direntry
-@dircategory Kernel
+@dircategory Disk Management
@direntry
* grub-install: (grub)Invoking grub-install. Install GRUB on your drive
@end direntry
-@dircategory Kernel
+@dircategory Disk Management
@direntry
* mbchk: (grub)Invoking mbchk. Check for the format of a Multiboot kernel
@end direntry
@@ -58,13 +62,14 @@
@titlepage
@sp 10
-@title The GRUB Manual
+@title GRUB Manual
+@subtitle The GRand Unified Bootloader, version @value{VERSION}, @value{UPDATED}.
@author Gordon Matzigkeit
@author OKUJI Yoshinori
@c The following two commands start the copyright page.
@page
@vskip 0pt plus 1filll
-@vskip 0pt plus 1filll
+@comment why again? @vskip 0pt plus 1filll
Copyright @copyright{} 1996 Erich Boleyn
Copyright @copyright{} 1999 Free Software Foundation, Inc.
@@ -88,16 +93,18 @@
@ifnottex
@node Top
@top GRUB
+
+This is the documentation of GNU GRUB, the GRand Unified Bootloader,
+a flexible and powerful boot loader program for @sc{pc}s.
-This file documents GNU GRUB, the Grand Unified Bootloader. This
-edition documents version @value{VERSION}.
+This edition documents version @value{VERSION}.
@end ifnottex
@menu
Part I: The Tutorial Manual
-* Overview:: Starting to use GRUB
-* Filename:: How to write filenames
+* Overview:: What exactly GRUB is and how to use it
+* Naming convention:: Names of your drives in GRUB
* Installation:: How to install GRUB on your drive
* Boot:: How to boot your operating systems
* Configuration:: Writing your configuration file
@@ -109,7 +116,7 @@
* Interface:: The menu and the command-line
* Command:: The list of available builtin commands
* Troubleshooting:: Error messages produced by GRUB
-* Invoking the grub shell:: How to use the grub shell
+* Invoking the grub shell:: How to use the GRUB shell
* Invoking grub-install:: How to use the GRUB installer
* Invoking mbchk:: How to use the Multiboot checker
Index: tutorial.texi
===================================================================
RCS file: /home/cvs/grub/docs/tutorial.texi,v
retrieving revision 1.8
diff -u -r1.8 tutorial.texi
--- tutorial.texi 1999/11/03 17:14:57 1.8
+++ tutorial.texi 1999/12/08 20:08:54
@@ -1,31 +1,37 @@
@node Overview
@chapter Overview
+@c @cindex Overview
+@c @cindex GRUB overview
-Briefly, a @dfn{boot loader} is the first software program that runs when
-a computer starts. It is responsible for loading and transferring
-control to the operating system @dfn{kernel} software (such as the Linux
-or GNU Hurd kernel). The kernel, in turn, initializes the rest of the
-operating system (usually GNU).
-GRUB can load a wide variety of free operating systems as well as
+Basically, a @dfn{boot loader} is the first software program (loaded from a
+disk drive) that runs when a computer starts. It is responsible for loading
+and transferring control to the operating system @dfn{kernel} software (such
+as Linux, GNU Hurd, or any other kernel). The kernel, in turn, initializes
+the rest of the operating system (e.g. a GNU system, or any other OS).
+
+GRUB can load a wide variety of free operating systems, as well as
chain-loading@footnote{@dfn{chain-load} is the mechanism for loading
-unsupported operating systems by loading another boot loader.}
-proprietary operating systems. The important feature in GRUB
-is flexibility; GRUB can understand filesystems and kernel executable
-formats, so you can load an arbitrary operating system as you like
-without recording the position of your kernel on the disk.
-
-Therefore, you have to specify the drive/partition where your kernel
-resides and the filename at hand. If you don't want to type the
-drive and the filename every time, the menu interface (@pxref{Menu})
-will help you. GRUB loads a configuration file (@pxref{Configuration})
-if found and provides the menu so that you can select which OS is booted
-at ease. Of course, you can enter the command-line interface
-(@pxref{Command line}) whenever you like.
-
-In the following chapters, we teach you how to specify a
-drive/partition and a filename (@pxref{Filename}), how to install GRUB
-on your drive (@pxref{Installation}), and how to boot your OSes
+unsupported operating systems by loading another boot loader. It is
+typically used for loading DOS or Windows.}
+proprietary operating systems.
+The important feature in GRUB is flexibility; GRUB can understand several
+filesystems and kernel executable formats, so you can load an arbitrary
+operating system the way you like, without recording the physical position
+of your kernel on the disk.
+
+Therefore, you have to specify the drive and the partition where your kernel
+resides and the filename at hand. If you don't want to type in the drive and
+the filename every time, you can set it up in a simple configuration file
+(@pxref{Configuration}). GRUB will locate and load it, and provide a nice
+menu interface (@pxref{Menu}) through which you can easily select which OS
+it boots. Of course, you can enter the command-line interface
+(@pxref{Command line}) whenever you like, or you can edit specific menu
+entries prior to using them.
+
+In the following chapters, you will learn how to specify a drive or a
+partition, and a file name (@pxref{Naming convention}) to GRUB, how to
+install GRUB on your drive (@pxref{Installation}), and how to boot your OSes
(@pxref{Boot}), step by step.
@@ -35,77 +41,82 @@
@c I'm going to include Bill White's documentation here, once his
@c copyright problem will be solved.
+
+@node Naming convention
+@chapter Naming convention
-@node Filename
-@chapter Filename
+The device syntax used in GRUB is a wee bit different from what you may
+have seen before in your operating system(s), and you need to know it so
+that you can specify a drive/partition.
-Now is the time when you should learn the device syntax used in GRUB, so
-that you can specify a drive/partition. See this example:
+Look at the following examples and explanations:
@example
(fd0)
@end example
-This means the first floppy disk drive. GRUB requires that the device
-name is enclosed with @samp{(} and @samp{)}. The number @samp{0} is the
-drive number, which is counted from @emph{zero}. In this case, GRUB uses
-the whole floppy disk.
+First of all, GRUB requires that the device name is enclosed with @samp{(}
+and @samp{)}. The `fd' part means that it is a floppy disk. The number
+@samp{0} is the drive number, which is counted from @emph{zero}. This
+expression means that GRUB will use the whole floppy disk.
@example
(hd0,1)
@end example
-This means the second partition of the first hard disk drive. The first
-integer @samp{0} indicates the drive number, that is, the first hard
-disk, while the second integer @samp{1} indicates the partition number
-(or the @sc{pc} slice number in the BSD terminology). Note that the
-partition numbers are counted from @emph{zero} but not from one. In this
-case, GRUB uses the partition of the disk instead of the whole
-disk.
+Here, @samp{hd} means it is a hard disk drive. The first integer @samp{0}
+indicates the drive number, that is, the first hard disk, while the second
+integer, @samp{1}, indicates the partition number (or the @sc{pc} slice
+number in the BSD terminology). Once again, please note that the partition
+numbers are counted from @emph{zero}, not from one. This expression means
+the second partition of the first hard disk drive. In this case, GRUB uses
+one partition of the disk, instead of the whole disk.
@example
(hd0,4)
@end example
This specifies the first @dfn{extended partition} of the first hard disk
-drive. Note that the partition numbers for extended partitions are
-counted from @samp{4}, whether your disks has four primary partitions or
-less.
+drive. Note that the partition numbers for extended partitions are counted
+from @samp{4}, regardless of the actual number of primary partitions on your
+hard disk.
@example
(hd1,a)
@end example
-This means the BSD @samp{a} partition of the second hard disk. If you
-need to specify which @sc{pc} slice number should be used, use a device
-like @samp{(hd1,0,a)}. If the @sc{pc} slice number is omitted, GRUB
-searches for the first @sc{pc} slice which has a BSD @samp{a} partition.
-
-Note that GRUB does @emph{not} distinguish IDE from SCSI; just count the
-drive numbers from zero. Normally, any IDE drive number is less than any
-SCSI drive number, but this is not true if you exchange the boot
-sequence between IDE and SCSI in your BIOS. But do not worry. In the
-GRUB command-line (@pxref{Command line}), you can always use the
-@key{TAB} completion which displays the list of drives, the list of the
-partitions of a drive, or the list of the filenames on a partition,
-depending on where you push the @key{TAB} key in the command-line. So it
-should be possible to determine which drive and which partition are what
-you seek for.
+This means the BSD @samp{a} partition of the second hard disk. If you need
+to specify which @sc{pc} slice number should be used, use something like
+this: @samp{(hd1,0,a)}. If the @sc{pc} slice number is omitted, GRUB
+searches for the first PC slice which has a BSD @samp{a} partition.
+
+Of course, to actually access the disks or partitions with GRUB, you need
+to use the device specification in a command, like @samp{root (fd0)} or
+@samp{unhide (hd0,6)}. To help you find out which number is a partition you
+want, the GRUB command-line (@pxref{Command line}) options have argument
+completion. That means that e.g. you only need to type @samp{root (},
+followed by a @key{TAB}, and GRUB will display the list of drives,
+partitions, or filenames, so it should be quite easy to determine the name
+of your target partition, even with minimal knowledge of the syntax.
+
+Note that GRUB does @emph{not} distinguish IDE from SCSI - it simply counts
+the drive numbers from zero, regardless of their type. Normally, any IDE
+drive number is less than any SCSI drive number, although that is not true
+if you change the boot sequence by swapping IDE and SCSI drives in your
+BIOS.
-Now the question is how to specify a file. Again, see this example:
+Now the question is, how to specify a file? Again, see this example:
@example
(hd0,0)/vmlinuz
@end example
-This specifies the file whose name is @samp{vmlinuz} on the first
-partition of the first hard disk drive. Isn't that easy? All you should
-do is type the absolute filename. If you are tired of typing the
-whole filename, press the @key{TAB} key. @kbd{@key{TAB}}
-completes the filename if it is unique. Otherwise, it displays the list
-of the candidates.
+This specifies the file named @samp{vmlinuz}, found on the first partition,
+of the first hard disk drive. Note that the argument completion works with
+file names, too.
-OK, the next chapter introduces how to install GRUB on your drive.
+That was easy, admit it :-) Do read the next chapter, to find out how to
+actually install GRUB on your drive.
@node Installation
Index: postinst
===================================================================
RCS file: /home/cvs/grub/debian/postinst,v
retrieving revision 1.2
diff -u -r1.2 postinst
--- postinst 1999/11/08 17:19:28 1.2
+++ postinst 1999/12/08 20:18:53
@@ -1,20 +1,12 @@
#! /bin/sh
set -e
+if [ "$1" = "configure" -o "$1" = "upgrade" ]; then
# Provide a backward-compatibility symlink to the doc directory.
-package=grub
-case "$1" in
-install | upgrade)
- if [ -d /usr/doc ]; then
- if [ ! -e /usr/doc/$package -a -d /usr/share/doc/$package ]; then
- ln -s /usr/share/doc/$package /usr/doc/$package
- fi
+ if [ -d /usr/doc ! -e /usr/doc/grub -a -d /usr/share/doc/grub ]; then
+ ln -sf ../share/doc/grub /usr/doc/grub
fi
- ;;
-esac
-
# Install our info pages.
-install-info --quiet --section Kernel Kernel \
- /usr/share/info/grub.info.gz
-install-info --quiet --section Kernel Kernel \
- /usr/share/info/multiboot.info.gz
+ install-info --quiet /usr/share/info/grub.info
+ install-info --quiet /usr/share/info/multiboot.info
+fi
Index: prerm
===================================================================
RCS file: /home/cvs/grub/debian/prerm,v
retrieving revision 1.2
diff -u -r1.2 prerm
--- prerm 1999/11/08 17:19:29 1.2
+++ prerm 1999/12/08 20:20:39
@@ -1,16 +1,14 @@
#! /bin/sh
set -e
+if [ "$1" = "remove" -o "$1" = "upgrade" ]; then
# Delete our backward-compatibility symlink.
package=grub
-case "$1" in
-remove | upgrade)
if [ -d /usr/doc -a -L /usr/doc/$package ]; then
rm -f /usr/doc/$package
fi
- ;;
-esac
-# Install our info pages.
-install-info --quiet --remove /usr/share/info/grub.info.gz
-install-info --quiet --remove /usr/share/info/multiboot.info.gz
+# Remove our info pages.
+ install-info --remove --quiet /usr/share/info/grub.info
+ install-info --remove --quiet /usr/share/info/multiboot.info
+fi
