Adding manpage from Brian Pellin <bpellin@gmail.com> for extlinux.
[profile/ivi/syslinux.git] / man / syslinux.1
1 .TH SYSLINUX 1 "18 December 2007" "SYSLINUX"
2 .SH NAME
3 syslinux \- install the \s-1SYSLINUX\s+1 bootloader on a FAT filesystem
4 .SH SYNOPSIS
5 .B syslinux
6 [\fB\-sfr\fP]
7 [\fB\-d\fP \fIdirectory\fP]
8 [\fB\-o\fP \fIoffset\fP]
9 .I device
10 .SH DESCRIPTION
11 \fBSyslinux\fP is a boot loader for the Linux operating system which
12 operates off an MS-DOS/Windows FAT filesystem. It is intended to
13 simplify first-time installation of Linux, and for creation of rescue
14 and other special-purpose boot disks.
15 .PP
16 In order to create a bootable Linux floppy using \fBSyslinux\fP, prepare a
17 normal MS-DOS formatted floppy. Copy one or more Linux kernel files to
18 it, then execute the command:
19 .IP
20 .B syslinux /dev/fd0
21 .PP
22 This will alter the boot sector on the disk and copy a file named
23 LDLINUX.SYS into its root directory.
24 .PP
25 On boot time, by default, the kernel will be loaded from the image named
26 LINUX on the boot floppy.  This default can be changed, see the section
27 on the \fBsyslinux\fP configuration file.
28 .PP
29 If the Shift or Alt keys are held down during boot, or the Caps or Scroll
30 locks are set, \fBsyslinux\fP will display a
31 .BR lilo (8)
32 -style "boot:" prompt. The user can then type a kernel file name followed by
33 any kernel parameters. The \fBsyslinux\fP loader does not need to know about the
34 kernel file in advance; all that is required is that it is a file located in
35 the root directory on the disk.
36 .PP
37 \fBSyslinux\fP supports the loading of initial ramdisks (initrd) and the
38 bzImage kernel format.
39 .SH OPTIONS
40 .TP
41 .B \-s
42 Install a "safe, slow and stupid" version of \fBsyslinux\fP. This version may
43 work on some very buggy BIOSes on which \fBsyslinux\fP would otherwise fail.
44 If you find a machine on which the \-s option is required to make it boot
45 reliably, please send as much info about your machine as you can, and include
46 the failure mode.
47 .TP
48 .B \-f
49 Force install even if it appears unsafe.
50 .TP
51 .B \-r
52 RAID mode.  If boot fails, tell the BIOS to boot the next device in
53 the boot sequence (usually the next hard disk) instead of stopping
54 with an error message.  This is useful for RAID-1 booting.
55 .TP
56 \fB\-d\fP \fIsubdirectory\fP
57 Install the \s-1SYSLINUX\s+1 control files in a subdirectory with the
58 specified name (relative to the root directory on the device).
59 .TP
60 \fB\-o\fP \fIoffset\fP
61 Indicates that the filesystem is at an offset from the base of the
62 device or file.
63 .SH FILES
64 .SS "Configuration file"
65 All the configurable defaults in \fBsyslinux\fP can be changed by putting a
66 file called
67 .B syslinux.cfg
68 in the root directory of the boot floppy. This
69 is a text file in either UNIX or DOS format, containing one or more of
70 the following items (case is insensitive for keywords).
71 .PP
72 In the configuration file blank lines and comment lines beginning
73 with a hash mark (#) are ignored.
74 .TP
75 \fBdefault\fP \fIkernel\fP [ \fIoptions ...\fP ]
76 Sets the default command line. If \fBsyslinux\fP boots automatically, it will act
77 just as if the entries after "default" had been typed in at the "boot:" prompt.
78 .IP
79 If no configuration file is present, or no "default" entry is present in the
80 configuration file, the default is "linux auto".
81 .TP
82 NOTE: Earlier versions of \s-1SYSLINUX\s+1 used to automatically
83 append the string "auto" to whatever the user specified using
84 the DEFAULT command.  As of version 1.54, this is no longer
85 true, as it caused problems when using a shell as a substitute
86 for "init."  You may want to include this option manually.
87 .TP
88 .BI append " options ..."
89 Add one or more \fIoptions\fP to the kernel command line. These are added both
90 for automatic and manual boots. The options are added at the very beginning of
91 the kernel command line, usually permitting explicitly entered kernel options
92 to override them. This is the equivalent of the
93 .BR lilo (8)
94  "append" option.
95 .PP
96 .nf
97 .BI label\  label
98 .RS 2
99 .BI kernel\  image
100 .BI append\  options\ ...
101 .RE
102 .fi
103 .RS
104 Indicates that if \fIlabel\fP is entered as the kernel to boot, \fBsyslinux\fP should
105 instead boot \fIimage\fP, and the specified "append" options should be used
106 instead of the ones specified in the global section of the file (before the
107 first "label" command.) The default for \fIimage\fP is the same as \fIlabel\fP,
108 and if no "append" is given the default is to use the global entry (if any).
109 Use "append -" to use no options at all.  Up to 128 "label" entries are
110 permitted.
111 .TP
112 .B Notes:
113 Labels are mangled as if they were DOS filenames, and must be unique after
114 mangling.  For example, two labels "v2.1.30" and "v2.1.31" will not be
115 distinguishable.
116 .IP
117 The "image" doesn't have to be a Linux kernel; it can be a boot sector or a
118 COMBOOT file (see below.)
119 .RE
120 .TP
121 .BI implicit\  flag_val
122 If \fIflag_val\fP is 0, do not load a kernel image unless it has been
123 explicitly named in a "label" statement.  The default is 1.
124 .TP
125 .BI timeout\  timeout
126 Indicates how long to wait at the "boot:" prompt until booting automatically, in
127 units of 1/10 s. The timeout is cancelled as soon as the user types anything
128 on the keyboard, the assumption being that the user will complete the command
129 line already begun. A timeout of zero will disable the timeout completely,
130 this is also the default. The maximum possible timeout value is 35996;
131 corresponding to just below one hour.
132 .TP
133 \fBserial\fP \fIport\fP [ \fIbaudrate\fP ]
134 Enables a serial port to act as the console. "port" is a number (0 = /dev/ttyS0
135 = COM1, etc.); if "baudrate" is omitted, the baud rate defaults to 9600 bps.
136 The serial parameters are hardcoded to be 8 bits, no parity, 1 stop bit.
137 .IP
138 For this directive to be guaranteed to work properly, it
139 should be the first directive in the configuration file.
140 .TP
141 .BI font\  filename
142 Load a font in .psf format before displaying any output (except the copyright
143 line, which is output as ldlinux.sys itself is loaded.) \fBsyslinux\fP only loads
144 the font onto the video card; if the .psf file contains a Unicode table it is
145 ignored.  This only works on EGA and VGA cards; hopefully it should do nothing
146 on others.
147 .TP
148 .BI kbdmap\  keymap
149 Install a simple keyboard map. The keyboard remapper used is \fIvery\fP
150 simplistic (it simply remaps the keycodes received from the BIOS, which means
151 that only the key combinations relevant in the default layout \- usually U.S.
152 English \- can be mapped) but should at least help people with AZERTY keyboard
153 layout and the locations of = and , (two special characters used heavily on the
154 Linux kernel command line.)
155 .IP
156 The included program
157 .BR keytab-lilo.pl (8)
158 from the
159 .BR lilo (8)
160  distribution can be used to create such keymaps.
161 .TP
162 .BI display\  filename
163 Displays the indicated file on the screen at boot time (before the boot:
164 prompt, if displayed). Please see the section below on DISPLAY files. If the
165 file is missing, this option is simply ignored.
166 .TP
167 .BI prompt\  flag_val
168 If \fIflag_val\fP is 0, display the "boot:" prompt only if the Shift or Alt key
169 is pressed, or Caps Lock or Scroll lock is set (this is the default).  If
170 \fIflag_val\fP is 1, always display the "boot:" prompt.
171 .PP
172 .nf
173 .BI f1\  filename
174 .BI f2\  filename
175 .I ...
176 .BI f9\  filename
177 .BI f10\  filename
178 .BI f11\  filename
179 .BI f12\  filename
180 .fi
181 .RS
182 Displays the indicated file on the screen when a function key is pressed at the
183 "boot:" prompt. This can be used to implement pre-boot online help (presumably
184 for the kernel command line options.)
185 .RE
186 .IP
187 When using the serial console, press \fI<Ctrl-F><digit>\fP to get to
188 the help screens, e.g. \fI<Ctrl-F>2\fP to get to the f2 screen.  For
189 f10-f12, hit \fI<Ctrl-F>A\fP, \fI<Ctrl-F>B\fP, \fI<Ctrl-F>C\fP.  For
190 compatiblity with earlier versions, f10 can also be entered as
191 \fI<Ctrl-F>0\fP.
192 .SS "Display file format"
193 DISPLAY and function-key help files are text files in either DOS or UNIX
194 format (with or without \fI<CR>\fP). In addition, the following special codes
195 are interpreted:
196 .TP
197 \fI<FF>\fP = \fI<Ctrl-L>\fP = ASCII 12
198 Clear the screen, home the cursor.  Note that the screen is
199 filled with the current display color.
200 .TP
201 \fI<SI><bg><fg>\fP, \fI<SI>\fP = \fI<Ctrl-O>\fP = ASCII 15
202 Set the display colors to the specified background and foreground colors, where
203 \fI<bg>\fP and \fI<fg>\fP are hex digits, corresponding to the standard PC
204 display attributes:
205 .IP
206 .nf
207 .ta \w'5 = dark purple    'u
208 0 = black       8 = dark grey
209 1 = dark blue   9 = bright blue
210 2 = dark green  a = bright green
211 3 = dark cyan   b = bright cyan
212 4 = dark red    c = bright red
213 5 = dark purple d = bright purple
214 6 = brown       e = yellow
215 7 = light grey  f = white
216 .fi
217 .IP
218 Picking a bright color (8-f) for the background results in the
219 corresponding dark color (0-7), with the foreground flashing.
220 .IP
221 colors are not visible over the serial console.
222 .TP
223 \fI<CAN>\fPfilename\fI<newline>\fP, \fI<CAN>\fP = \fI<Ctrl-X>\fP = ASCII 24
224 If a VGA display is present, enter graphics mode and display
225 the graphic included in the specified file.  The file format
226 is an ad hoc format called LSS16; the included Perl program
227 "ppmtolss16" can be used to produce these images.  This Perl
228 program also includes the file format specification.
229 .IP
230 The image is displayed in 640x480 16-color mode.  Once in
231 graphics mode, the display attributes (set by \fI<SI>\fP code
232 sequences) work slightly differently: the background color is
233 ignored, and the foreground colors are the 16 colors specified
234 in the image file.  For that reason, ppmtolss16 allows you to
235 specify that certain colors should be assigned to specific
236 color indicies.
237 .IP
238 Color indicies 0 and 7, in particular, should be chosen with
239 care: 0 is the background color, and 7 is the color used for
240 the text printed by \s-1SYSLINUX\s+1 itself.
241 .TP
242 \fI<EM>\fP, \fI<EM>\fP = \fI<Ctrl-U>\fP = ASCII 25
243 If we are currently in graphics mode, return to text mode.
244 .TP
245 \fI<DLE>\fP..\fI<ETB>\fB, \fI<Ctrl-P>\fP..\fI<Ctrl-W>\fP = ASCII 16-23
246 These codes can be used to select which modes to print a
247 certain part of the message file in.  Each of these control
248 characters select a specific set of modes (text screen,
249 graphics screen, serial port) for which the output is actually
250 displayed:
251 .IP
252 .nf
253 Character                       Text    Graph   Serial
254 ------------------------------------------------------
255 <DLE> = <Ctrl-P> = ASCII 16     No      No      No
256 <DC1> = <Ctrl-Q> = ASCII 17     Yes     No      No
257 <DC2> = <Ctrl-R> = ASCII 18     No      Yes     No
258 <DC3> = <Ctrl-S> = ASCII 19     Yes     Yes     No
259 <DC4> = <Ctrl-T> = ASCII 20     No      No      Yes
260 <NAK> = <Ctrl-U> = ASCII 21     Yes     No      Yes
261 <SYN> = <Ctrl-V> = ASCII 22     No      Yes     Yes
262 <ETB> = <Ctrl-W> = ASCII 23     Yes     Yes     Yes
263 .fi
264 .IP
265 For example:
266 .nf
267 <DC1>Text mode<DC2>Graphics mode<DC4>Serial port<ETB>
268 .fi
269  ... will actually print out which mode the console is in!
270 .TP
271 \fI<SUB>\fP = \fI<Ctrl-Z>\fP = ASCII 26
272 End of file (DOS convention).
273 .SS Comboot Images and other operating systems
274 This version of \fBsyslinux\fP supports chain loading of other operating
275 systems (such as MS-DOS and its derivatives, including Windows 95/98),
276 as well as COMBOOT-style standalone executables (a subset of DOS .COM
277 files; see separate section below.)
278 .PP
279 Chain loading requires the boot sector of the foreign operating system
280 to be stored in a file in the root directory of the filesystem.
281 Because neither Linux kernels, boot sector images, nor COMBOOT files
282 have reliable magic numbers, \fBsyslinux\fP will look at the file
283 extension. The following extensions are recognised:
284 .PP
285 .nf
286 .ta \w'none or other    'u
287 none or other   Linux kernel image
288 CBT     COMBOOT image (not runnable from DOS)
289 BSS     Boot sector (DOS superblock will be patched in)
290 BS      Boot sector
291 COM     COMBOOT image (runnable from DOS)
292 .fi
293 .PP
294 For filenames given on the command line, \fBsyslinux\fP will search for the
295 file by adding extensions in the order listed above if the plain
296 filename is not found. Filenames in KERNEL statements must be fully
297 qualified.
298 .PP
299 A COMBOOT file is a standalone executable in DOS .COM format. They
300 can, among other things, be produced by the Etherboot package by
301 Markus Gutschke and Ken Yap. The following requirements apply for
302 these files to be sufficiently "standalone" for \fBsyslinux\fP to be able to
303 load and run them:
304 .IP \(bu
305 The program must not execute any DOS calls (since there is no
306 DOS), although it may call the BIOS. The only exception is that
307 the program may execute INT 20h (Terminate Program) to return to
308 the \fBsyslinux\fP prompt. Note especially that INT 21h AH=4Ch, INT 21h
309 AH=31h or INT 27h are not supported.
310 .IP \(bu
311 Only the fields pspInt20 at offset 00h, pspNextParagraph at offset 02h and
312 pspCommandTail at offset 80h (contains the arguments from the \fBsyslinux\fP command
313 line) in the PSP are supported. All other fields will contain zero.
314 .IP \(bu
315 The program must not modify any main memory outside its 64K segment if it
316 returns to \fBsyslinux\fP via INT 20h.
317 .PP
318 \fBSyslinux\fP currently doesn't provide any form of API for the use of
319 COMBOOT files.  If there is need, a future version may contain an INT
320 interface to some \fBsyslinux\fP functions; please contact me if you have a
321 need or ideas for such an API.
322 .SS Novice protection
323 \fBSyslinux\fP will attempt to detect if the user is trying to boot on a 286
324 or lower class machine, or a machine with less than 608K of low ("DOS")
325 RAM (which means the Linux boot sequence cannot complete).  If so, a
326 message is displayed and the boot sequence aborted.  Holding down the
327 Ctrl key while booting disables this feature.
328 .PP
329 The compile time and date of a specific \fBsyslinux\fP version can be obtained
330 by the DOS command "type ldlinux.sys". This is also used as the
331 signature for the LDLINUX.SYS file, which must match the boot sector
332 .PP
333 Any file that \fBsyslinux\fP uses can be marked hidden, system or readonly if
334 so is convenient; \fBsyslinux\fP ignores all file attributes.  The \s-1SYSLINUX\s+1
335 installed automatically sets the readonly attribute on LDLINUX.SYS.
336 .SS Bootable CD-ROMs
337 \s-1SYSLINUX\s+1 can be used to create bootdisk images for El
338 Torito-compatible bootable CD-ROMs. However, it appears that many
339 BIOSes are very buggy when it comes to booting CD-ROMs. Some users
340 have reported that the following steps are helpful in making a CD-ROM
341 that is bootable on the largest possible number of machines:
342 .IP \(bu
343 Use the -s (safe, slow and stupid) option to \s-1SYSLINUX\s+1
344 .IP \(bu
345 Put the boot image as close to the beginning of the
346 ISO 9660 filesystem as possible.
347 .PP
348 A CD-ROM is so much faster than a floppy that the -s option shouldn't
349 matter from a speed perspective.
350 .PP
351 Of course, you probably want to use ISOLINUX instead.  See the
352 documentation file
353 .BR isolinux.doc .
354 .SS Booting from a FAT partition on a hard disk
355 \s-1SYSLINUX\s+1 can boot from a FAT filesystem partition on a hard
356 disk (including FAT32). The installation procedure is identical to the
357 procedure for installing it on a floppy, and should work under either
358 DOS or Linux. To boot from a partition, \s-1SYSLINUX\s+1 needs to be
359 launched from a Master Boot Record or another boot loader, just like
360 DOS itself would. A sample master boot sector (\fBmbr.bin\fP) is
361 included with \s-1SYSLINUX\s+1.
362 .SH BUGS
363 I would appreciate hearing of any problems you have with \s-1SYSLINUX\s+1.  I
364 would also like to hear from you if you have successfully used \s-1SYSLINUX\s+1,
365 especially if you are using it for a distribution.
366 .PP
367 If you are reporting problems, please include all possible information
368 about your system and your BIOS; the vast majority of all problems
369 reported turn out to be BIOS or hardware bugs, and I need as much
370 information as possible in order to diagnose the problems.
371 .PP
372 There is a mailing list for discussion among \s-1SYSLINUX\s+1 users and for
373 announcements of new and test versions. To join, send a message to
374 majordomo@linux.kernel.org with the line:
375 .PP
376 .B subscribe syslinux
377 .PP
378 in the body of the message. The submission address is syslinux@linux.kernel.org.
379 .SH SEE ALSO
380 .BR lilo (8),
381 .BR keytab-lilo.pl (8),
382 .BR fdisk (8),
383 .BR mkfs (8),
384 .BR superformat (1).
385 .SH AUTHOR
386 This manual page is a modified version of the original \fBsyslinux\fP
387 documentation by H. Peter Anvin <hpa@zytor.com>. The conversion to a manpage
388 was made by Arthur Korn <arthur@korn.ch>.