[syslinux:master] man: update syslinux.1. It is still out of date, however.
syslinux-bot for H. Peter Anvin
hpa at linux.intel.com
Mon Jul 19 15:00:22 PDT 2010
Author: H. Peter Anvin <hpa at linux.intel.com>
AuthorDate: Mon, 19 Jul 2010 14:55:16 -0700
Committer: H. Peter Anvin <hpa at linux.intel.com>
CommitDate: Mon, 19 Jul 2010 14:55:16 -0700
man: update syslinux.1. It is still out of date, however.
Signed-off-by: H. Peter Anvin <hpa at linux.intel.com>
man/syslinux.1 | 68 ++++++++++++++++++++++++++++++++++++++-----------------
1 files changed, 47 insertions(+), 21 deletions(-)
diff --git a/man/syslinux.1 b/man/syslinux.1
index 1729ddd..6babfa4 100644
@@ -1,11 +1,9 @@
-.TH SYSLINUX 1 "18 December 2007" "SYSLINUX"
+.TH SYSLINUX 1 "19 July 2010" "SYSLINUX"
syslinux \- install the \s-1SYSLINUX\s+1 bootloader on a FAT filesystem
\fBSyslinux\fP is a boot loader for the Linux operating system which
@@ -17,10 +15,11 @@ In order to create a bootable Linux floppy using \fBSyslinux\fP, prepare a
normal MS-DOS formatted floppy. Copy one or more Linux kernel files to
it, then execute the command:
-.B syslinux /dev/fd0
+.B syslinux \-\-install /dev/fd0
This will alter the boot sector on the disk and copy a file named
-LDLINUX.SYS into its root directory.
+into its root directory.
On boot time, by default, the kernel will be loaded from the image named
LINUX on the boot floppy. This default can be changed, see the section
@@ -29,52 +28,79 @@ on the \fBsyslinux\fP configuration file.
If the Shift or Alt keys are held down during boot, or the Caps or Scroll
locks are set, \fBsyslinux\fP will display a
.BR lilo (8)
--style "boot:" prompt. The user can then type a kernel file name followed by
-any kernel parameters. The \fBsyslinux\fP loader does not need to know about the
-kernel file in advance; all that is required is that it is a file located in
-the root directory on the disk.
+-style "boot:" prompt. The user can then type a kernel file name
+followed by any kernel parameters. The \s-1SYSLINUX\s+1 bootloader
+does not need to know about the kernel file in advance; all that is
+required is that it is a file located in the root directory on the
\fBSyslinux\fP supports the loading of initial ramdisks (initrd) and the
bzImage kernel format.
-Install a "safe, slow and stupid" version of \fBsyslinux\fP. This version may
-work on some very buggy BIOSes on which \fBsyslinux\fP would otherwise fail.
+Install \s-1SYSLINUX\s+1 on a new medium, overwriting any previously
+Install \s-1SYSLINUX\s+1 on a new medium if and only if a version of
+\s-1SYSLINUX\s+1 is already installed.
+Install a "safe, slow and stupid" version of \s-1SYSLINUX\s+1. This version may
+work on some very buggy BIOSes on which \s-1SYSLINUX\s+1 would otherwise fail.
If you find a machine on which the \-s option is required to make it boot
reliably, please send as much info about your machine as you can, and include
the failure mode.
Force install even if it appears unsafe.
RAID mode. If boot fails, tell the BIOS to boot the next device in
the boot sequence (usually the next hard disk) instead of stopping
with an error message. This is useful for RAID-1 booting.
+\fB\-d\fP, \fB\-\-directory\fP \fIsubdirectory\fP
Install the \s-1SYSLINUX\s+1 control files in a subdirectory with the
specified name (relative to the root directory on the device).
+\fB\-t\fP, \fB\-\-offset\fP \fIoffset\fP
Indicates that the filesystem is at an offset from the base of the
device or file.
+Declare a boot command to be tried on the first boot only.
+Clear the boot-once command.
+\fB\-H\fP, \fB\-\-heads\fP \fIhead-count\fP
+Override the detected number of heads for the geometry.
+\fB\-S\fP, \fB\-\-sectors\fP \fIsector-count\fP
+Override the detected number of sectors for the geometry.
+Assume zipdrive geometry (\fI\-\-heads 64 \-\-sectors 32).
.SS "Configuration file"
-All the configurable defaults in \fBsyslinux\fP can be changed by putting a
+All the configurable defaults in \s-1SYSLINUX\s+1 can be changed by putting a
-in the root directory of the boot floppy. This
+in the install directory of the boot disk. This
is a text file in either UNIX or DOS format, containing one or more of
the following items (case is insensitive for keywords).
+This list is out of date.
In the configuration file blank lines and comment lines beginning
with a hash mark (#) are ignored.
\fBdefault\fP \fIkernel\fP [ \fIoptions ...\fP ]
-Sets the default command line. If \fBsyslinux\fP boots automatically, it will act
-just as if the entries after "default" had been typed in at the "boot:" prompt.
+Sets the default command line. If \fBsyslinux\fP boots automatically,
+it will act just as if the entries after "default" had been typed in
+at the "boot:" prompt.
If no DEFAULT or UI statement is found, or the configuration file is missing
entirely, \s-1SYSLINUX\s+1 drops to the boot: prompt with an error message (if
More information about the Syslinux-commits