1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" 2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> 3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> 4 <head> 5 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> 6 <meta name="generator" content="AsciiDoc 8.6.8" /> 7 <title>syslinux.cfg(5)</title> 8 <style type="text/css"> 9 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */ 10 11 /* Default font. */ 12 body { 13 font-family: Georgia,serif; 14 } 15 16 /* Title font. */ 17 h1, h2, h3, h4, h5, h6, 18 div.title, caption.title, 19 thead, p.table.header, 20 #toctitle, 21 #author, #revnumber, #revdate, #revremark, 22 #footer { 23 font-family: Arial,Helvetica,sans-serif; 24 } 25 26 body { 27 margin: 1em 5% 1em 5%; 28 } 29 30 a { 31 color: blue; 32 text-decoration: underline; 33 } 34 a:visited { 35 color: fuchsia; 36 } 37 38 em { 39 font-style: italic; 40 color: navy; 41 } 42 43 strong { 44 font-weight: bold; 45 color: #083194; 46 } 47 48 h1, h2, h3, h4, h5, h6 { 49 color: #527bbd; 50 margin-top: 1.2em; 51 margin-bottom: 0.5em; 52 line-height: 1.3; 53 } 54 55 h1, h2, h3 { 56 border-bottom: 2px solid silver; 57 } 58 h2 { 59 padding-top: 0.5em; 60 } 61 h3 { 62 float: left; 63 } 64 h3 + * { 65 clear: left; 66 } 67 h5 { 68 font-size: 1.0em; 69 } 70 71 div.sectionbody { 72 margin-left: 0; 73 } 74 75 hr { 76 border: 1px solid silver; 77 } 78 79 p { 80 margin-top: 0.5em; 81 margin-bottom: 0.5em; 82 } 83 84 ul, ol, li > p { 85 margin-top: 0; 86 } 87 ul > li { color: #aaa; } 88 ul > li > * { color: black; } 89 90 .monospaced, code, pre { 91 font-family: "Courier New", Courier, monospace; 92 font-size: inherit; 93 color: navy; 94 padding: 0; 95 margin: 0; 96 } 97 98 99 #author { 100 color: #527bbd; 101 font-weight: bold; 102 font-size: 1.1em; 103 } 104 #email { 105 } 106 #revnumber, #revdate, #revremark { 107 } 108 109 #footer { 110 font-size: small; 111 border-top: 2px solid silver; 112 padding-top: 0.5em; 113 margin-top: 4.0em; 114 } 115 #footer-text { 116 float: left; 117 padding-bottom: 0.5em; 118 } 119 #footer-badges { 120 float: right; 121 padding-bottom: 0.5em; 122 } 123 124 #preamble { 125 margin-top: 1.5em; 126 margin-bottom: 1.5em; 127 } 128 div.imageblock, div.exampleblock, div.verseblock, 129 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, 130 div.admonitionblock { 131 margin-top: 1.0em; 132 margin-bottom: 1.5em; 133 } 134 div.admonitionblock { 135 margin-top: 2.0em; 136 margin-bottom: 2.0em; 137 margin-right: 10%; 138 color: #606060; 139 } 140 141 div.content { /* Block element content. */ 142 padding: 0; 143 } 144 145 /* Block element titles. */ 146 div.title, caption.title { 147 color: #527bbd; 148 font-weight: bold; 149 text-align: left; 150 margin-top: 1.0em; 151 margin-bottom: 0.5em; 152 } 153 div.title + * { 154 margin-top: 0; 155 } 156 157 td div.title:first-child { 158 margin-top: 0.0em; 159 } 160 div.content div.title:first-child { 161 margin-top: 0.0em; 162 } 163 div.content + div.title { 164 margin-top: 0.0em; 165 } 166 167 div.sidebarblock > div.content { 168 background: #ffffee; 169 border: 1px solid #dddddd; 170 border-left: 4px solid #f0f0f0; 171 padding: 0.5em; 172 } 173 174 div.listingblock > div.content { 175 border: 1px solid #dddddd; 176 border-left: 5px solid #f0f0f0; 177 background: #f8f8f8; 178 padding: 0.5em; 179 } 180 181 div.quoteblock, div.verseblock { 182 padding-left: 1.0em; 183 margin-left: 1.0em; 184 margin-right: 10%; 185 border-left: 5px solid #f0f0f0; 186 color: #888; 187 } 188 189 div.quoteblock > div.attribution { 190 padding-top: 0.5em; 191 text-align: right; 192 } 193 194 div.verseblock > pre.content { 195 font-family: inherit; 196 font-size: inherit; 197 } 198 div.verseblock > div.attribution { 199 padding-top: 0.75em; 200 text-align: left; 201 } 202 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */ 203 div.verseblock + div.attribution { 204 text-align: left; 205 } 206 207 div.admonitionblock .icon { 208 vertical-align: top; 209 font-size: 1.1em; 210 font-weight: bold; 211 text-decoration: underline; 212 color: #527bbd; 213 padding-right: 0.5em; 214 } 215 div.admonitionblock td.content { 216 padding-left: 0.5em; 217 border-left: 3px solid #dddddd; 218 } 219 220 div.exampleblock > div.content { 221 border-left: 3px solid #dddddd; 222 padding-left: 0.5em; 223 } 224 225 div.imageblock div.content { padding-left: 0; } 226 span.image img { border-style: none; } 227 a.image:visited { color: white; } 228 229 dl { 230 margin-top: 0.8em; 231 margin-bottom: 0.8em; 232 } 233 dt { 234 margin-top: 0.5em; 235 margin-bottom: 0; 236 font-style: normal; 237 color: navy; 238 } 239 dd > *:first-child { 240 margin-top: 0.1em; 241 } 242 243 ul, ol { 244 list-style-position: outside; 245 } 246 ol.arabic { 247 list-style-type: decimal; 248 } 249 ol.loweralpha { 250 list-style-type: lower-alpha; 251 } 252 ol.upperalpha { 253 list-style-type: upper-alpha; 254 } 255 ol.lowerroman { 256 list-style-type: lower-roman; 257 } 258 ol.upperroman { 259 list-style-type: upper-roman; 260 } 261 262 div.compact ul, div.compact ol, 263 div.compact p, div.compact p, 264 div.compact div, div.compact div { 265 margin-top: 0.1em; 266 margin-bottom: 0.1em; 267 } 268 269 tfoot { 270 font-weight: bold; 271 } 272 td > div.verse { 273 white-space: pre; 274 } 275 276 div.hdlist { 277 margin-top: 0.8em; 278 margin-bottom: 0.8em; 279 } 280 div.hdlist tr { 281 padding-bottom: 15px; 282 } 283 dt.hdlist1.strong, td.hdlist1.strong { 284 font-weight: bold; 285 } 286 td.hdlist1 { 287 vertical-align: top; 288 font-style: normal; 289 padding-right: 0.8em; 290 color: navy; 291 } 292 td.hdlist2 { 293 vertical-align: top; 294 } 295 div.hdlist.compact tr { 296 margin: 0; 297 padding-bottom: 0; 298 } 299 300 .comment { 301 background: yellow; 302 } 303 304 .footnote, .footnoteref { 305 font-size: 0.8em; 306 } 307 308 span.footnote, span.footnoteref { 309 vertical-align: super; 310 } 311 312 #footnotes { 313 margin: 20px 0 20px 0; 314 padding: 7px 0 0 0; 315 } 316 317 #footnotes div.footnote { 318 margin: 0 0 5px 0; 319 } 320 321 #footnotes hr { 322 border: none; 323 border-top: 1px solid silver; 324 height: 1px; 325 text-align: left; 326 margin-left: 0; 327 width: 20%; 328 min-width: 100px; 329 } 330 331 div.colist td { 332 padding-right: 0.5em; 333 padding-bottom: 0.3em; 334 vertical-align: top; 335 } 336 div.colist td img { 337 margin-top: 0.3em; 338 } 339 340 @media print { 341 #footer-badges { display: none; } 342 } 343 344 #toc { 345 margin-bottom: 2.5em; 346 } 347 348 #toctitle { 349 color: #527bbd; 350 font-size: 1.1em; 351 font-weight: bold; 352 margin-top: 1.0em; 353 margin-bottom: 0.1em; 354 } 355 356 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { 357 margin-top: 0; 358 margin-bottom: 0; 359 } 360 div.toclevel2 { 361 margin-left: 2em; 362 font-size: 0.9em; 363 } 364 div.toclevel3 { 365 margin-left: 4em; 366 font-size: 0.9em; 367 } 368 div.toclevel4 { 369 margin-left: 6em; 370 font-size: 0.9em; 371 } 372 373 span.aqua { color: aqua; } 374 span.black { color: black; } 375 span.blue { color: blue; } 376 span.fuchsia { color: fuchsia; } 377 span.gray { color: gray; } 378 span.green { color: green; } 379 span.lime { color: lime; } 380 span.maroon { color: maroon; } 381 span.navy { color: navy; } 382 span.olive { color: olive; } 383 span.purple { color: purple; } 384 span.red { color: red; } 385 span.silver { color: silver; } 386 span.teal { color: teal; } 387 span.white { color: white; } 388 span.yellow { color: yellow; } 389 390 span.aqua-background { background: aqua; } 391 span.black-background { background: black; } 392 span.blue-background { background: blue; } 393 span.fuchsia-background { background: fuchsia; } 394 span.gray-background { background: gray; } 395 span.green-background { background: green; } 396 span.lime-background { background: lime; } 397 span.maroon-background { background: maroon; } 398 span.navy-background { background: navy; } 399 span.olive-background { background: olive; } 400 span.purple-background { background: purple; } 401 span.red-background { background: red; } 402 span.silver-background { background: silver; } 403 span.teal-background { background: teal; } 404 span.white-background { background: white; } 405 span.yellow-background { background: yellow; } 406 407 span.big { font-size: 2em; } 408 span.small { font-size: 0.6em; } 409 410 span.underline { text-decoration: underline; } 411 span.overline { text-decoration: overline; } 412 span.line-through { text-decoration: line-through; } 413 414 div.unbreakable { page-break-inside: avoid; } 415 416 417 /* 418 * xhtml11 specific 419 * 420 * */ 421 422 div.tableblock { 423 margin-top: 1.0em; 424 margin-bottom: 1.5em; 425 } 426 div.tableblock > table { 427 border: 3px solid #527bbd; 428 } 429 thead, p.table.header { 430 font-weight: bold; 431 color: #527bbd; 432 } 433 p.table { 434 margin-top: 0; 435 } 436 /* Because the table frame attribute is overriden by CSS in most browsers. */ 437 div.tableblock > table[frame="void"] { 438 border-style: none; 439 } 440 div.tableblock > table[frame="hsides"] { 441 border-left-style: none; 442 border-right-style: none; 443 } 444 div.tableblock > table[frame="vsides"] { 445 border-top-style: none; 446 border-bottom-style: none; 447 } 448 449 450 /* 451 * html5 specific 452 * 453 * */ 454 455 table.tableblock { 456 margin-top: 1.0em; 457 margin-bottom: 1.5em; 458 } 459 thead, p.tableblock.header { 460 font-weight: bold; 461 color: #527bbd; 462 } 463 p.tableblock { 464 margin-top: 0; 465 } 466 table.tableblock { 467 border-width: 3px; 468 border-spacing: 0px; 469 border-style: solid; 470 border-color: #527bbd; 471 border-collapse: collapse; 472 } 473 th.tableblock, td.tableblock { 474 border-width: 1px; 475 padding: 4px; 476 border-style: solid; 477 border-color: #527bbd; 478 } 479 480 table.tableblock.frame-topbot { 481 border-left-style: hidden; 482 border-right-style: hidden; 483 } 484 table.tableblock.frame-sides { 485 border-top-style: hidden; 486 border-bottom-style: hidden; 487 } 488 table.tableblock.frame-none { 489 border-style: hidden; 490 } 491 492 th.tableblock.halign-left, td.tableblock.halign-left { 493 text-align: left; 494 } 495 th.tableblock.halign-center, td.tableblock.halign-center { 496 text-align: center; 497 } 498 th.tableblock.halign-right, td.tableblock.halign-right { 499 text-align: right; 500 } 501 502 th.tableblock.valign-top, td.tableblock.valign-top { 503 vertical-align: top; 504 } 505 th.tableblock.valign-middle, td.tableblock.valign-middle { 506 vertical-align: middle; 507 } 508 th.tableblock.valign-bottom, td.tableblock.valign-bottom { 509 vertical-align: bottom; 510 } 511 512 513 /* 514 * manpage specific 515 * 516 * */ 517 518 body.manpage h1 { 519 padding-top: 0.5em; 520 padding-bottom: 0.5em; 521 border-top: 2px solid silver; 522 border-bottom: 2px solid silver; 523 } 524 body.manpage h2 { 525 border-style: none; 526 } 527 body.manpage div.sectionbody { 528 margin-left: 3em; 529 } 530 531 @media print { 532 body.manpage div#toc { display: none; } 533 } 534 535 536 </style> 537 <script type="text/javascript"> 538 /*<![CDATA[*/ 539 var asciidoc = { // Namespace. 540 541 ///////////////////////////////////////////////////////////////////// 542 // Table Of Contents generator 543 ///////////////////////////////////////////////////////////////////// 544 545 /* Author: Mihai Bazon, September 2002 546 * http://students.infoiasi.ro/~mishoo 547 * 548 * Table Of Content generator 549 * Version: 0.4 550 * 551 * Feel free to use this script under the terms of the GNU General Public 552 * License, as long as you do not remove or alter this notice. 553 */ 554 555 /* modified by Troy D. Hanson, September 2006. License: GPL */ 556 /* modified by Stuart Rackham, 2006, 2009. License: GPL */ 557 558 // toclevels = 1..4. 559 toc: function (toclevels) { 560 561 function getText(el) { 562 var text = ""; 563 for (var i = el.firstChild; i != null; i = i.nextSibling) { 564 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants. 565 text += i.data; 566 else if (i.firstChild != null) 567 text += getText(i); 568 } 569 return text; 570 } 571 572 function TocEntry(el, text, toclevel) { 573 this.element = el; 574 this.text = text; 575 this.toclevel = toclevel; 576 } 577 578 function tocEntries(el, toclevels) { 579 var result = new Array; 580 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])'); 581 // Function that scans the DOM tree for header elements (the DOM2 582 // nodeIterator API would be a better technique but not supported by all 583 // browsers). 584 var iterate = function (el) { 585 for (var i = el.firstChild; i != null; i = i.nextSibling) { 586 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) { 587 var mo = re.exec(i.tagName); 588 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") { 589 result[result.length] = new TocEntry(i, getText(i), mo[1]-1); 590 } 591 iterate(i); 592 } 593 } 594 } 595 iterate(el); 596 return result; 597 } 598 599 var toc = document.getElementById("toc"); 600 if (!toc) { 601 return; 602 } 603 604 // Delete existing TOC entries in case we're reloading the TOC. 605 var tocEntriesToRemove = []; 606 var i; 607 for (i = 0; i < toc.childNodes.length; i++) { 608 var entry = toc.childNodes[i]; 609 if (entry.nodeName.toLowerCase() == 'div' 610 && entry.getAttribute("class") 611 && entry.getAttribute("class").match(/^toclevel/)) 612 tocEntriesToRemove.push(entry); 613 } 614 for (i = 0; i < tocEntriesToRemove.length; i++) { 615 toc.removeChild(tocEntriesToRemove[i]); 616 } 617 618 // Rebuild TOC entries. 619 var entries = tocEntries(document.getElementById("content"), toclevels); 620 for (var i = 0; i < entries.length; ++i) { 621 var entry = entries[i]; 622 if (entry.element.id == "") 623 entry.element.id = "_toc_" + i; 624 var a = document.createElement("a"); 625 a.href = "#" + entry.element.id; 626 a.appendChild(document.createTextNode(entry.text)); 627 var div = document.createElement("div"); 628 div.appendChild(a); 629 div.className = "toclevel" + entry.toclevel; 630 toc.appendChild(div); 631 } 632 if (entries.length == 0) 633 toc.parentNode.removeChild(toc); 634 }, 635 636 637 ///////////////////////////////////////////////////////////////////// 638 // Footnotes generator 639 ///////////////////////////////////////////////////////////////////// 640 641 /* Based on footnote generation code from: 642 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html 643 */ 644 645 footnotes: function () { 646 // Delete existing footnote entries in case we're reloading the footnodes. 647 var i; 648 var noteholder = document.getElementById("footnotes"); 649 if (!noteholder) { 650 return; 651 } 652 var entriesToRemove = []; 653 for (i = 0; i < noteholder.childNodes.length; i++) { 654 var entry = noteholder.childNodes[i]; 655 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") 656 entriesToRemove.push(entry); 657 } 658 for (i = 0; i < entriesToRemove.length; i++) { 659 noteholder.removeChild(entriesToRemove[i]); 660 } 661 662 // Rebuild footnote entries. 663 var cont = document.getElementById("content"); 664 var spans = cont.getElementsByTagName("span"); 665 var refs = {}; 666 var n = 0; 667 for (i=0; i<spans.length; i++) { 668 if (spans[i].className == "footnote") { 669 n++; 670 var note = spans[i].getAttribute("data-note"); 671 if (!note) { 672 // Use [\s\S] in place of . so multi-line matches work. 673 // Because JavaScript has no s (dotall) regex flag. 674 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; 675 spans[i].innerHTML = 676 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + 677 "' title='View footnote' class='footnote'>" + n + "</a>]"; 678 spans[i].setAttribute("data-note", note); 679 } 680 noteholder.innerHTML += 681 "<div class='footnote' id='_footnote_" + n + "'>" + 682 "<a href='#_footnoteref_" + n + "' title='Return to text'>" + 683 n + "</a>. " + note + "</div>"; 684 var id =spans[i].getAttribute("id"); 685 if (id != null) refs["#"+id] = n; 686 } 687 } 688 if (n == 0) 689 noteholder.parentNode.removeChild(noteholder); 690 else { 691 // Process footnoterefs. 692 for (i=0; i<spans.length; i++) { 693 if (spans[i].className == "footnoteref") { 694 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href"); 695 href = href.match(/#.*/)[0]; // Because IE return full URL. 696 n = refs[href]; 697 spans[i].innerHTML = 698 "[<a href='#_footnote_" + n + 699 "' title='View footnote' class='footnote'>" + n + "</a>]"; 700 } 701 } 702 } 703 }, 704 705 install: function(toclevels) { 706 var timerId; 707 708 function reinstall() { 709 asciidoc.footnotes(); 710 if (toclevels) { 711 asciidoc.toc(toclevels); 712 } 713 } 714 715 function reinstallAndRemoveTimer() { 716 clearInterval(timerId); 717 reinstall(); 718 } 719 720 timerId = setInterval(reinstall, 500); 721 if (document.addEventListener) 722 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); 723 else 724 window.onload = reinstallAndRemoveTimer; 725 } 726 727 } 728 asciidoc.install(); 729 /*]]>*/ 730 </script> 731 </head> 732 <body class="manpage"> 733 <div id="header"> 734 <h1> 735 syslinux.cfg(5) Manual Page 736 </h1> 737 <h2>NAME</h2> 738 <div class="sectionbody"> 739 <p>syslinux.cfg - 740 *Syslinux* configuration file 741 </p> 742 </div> 743 </div> 744 <div id="content"> 745 <div class="sect1"> 746 <h2 id="_description">DESCRIPTION</h2> 747 <div class="sectionbody"> 748 <div class="paragraph"><p>Configuration for the boot behavior and user experience of <strong>Syslinux</strong> 749 boot loaders, the format of display files and the boot prompt behavior.</p></div> 750 <div class="paragraph"><p>Blank lines are ignored.</p></div> 751 <div class="paragraph"><p>Note that the configuration file is not completely decoded. Syntax 752 different from the one described above may still work correctly in this 753 version of <strong>Syslinux</strong>, but may break in a future one.</p></div> 754 </div> 755 </div> 756 <div class="sect1"> 757 <h2 id="_location_name">LOCATION/NAME</h2> 758 <div class="sectionbody"> 759 <div class="paragraph"><p><strong>SYSLINUX</strong> (before 4.00) used the configuration filename of 760 syslinux.cfg. <strong>EXTLINUX</strong> (merged into <strong>SYSLINUX</strong> as of 4.00) used the 761 filename extlinux.conf. Both default to searching for the config file 762 in the installed directory (containing ldlinux.sys/extlinux.sys). As of 763 4.00, <strong>SYSLINUX</strong> will search for extlinux.conf then syslinux.cfg in each 764 directory before falling back to the next directory.</p></div> 765 <div class="paragraph"><p>As of 3.35, <strong>SYSLINUX</strong> also searches /boot/syslinux, /syslinux and /.</p></div> 766 <div class="paragraph"><p><strong>ISOLINUX</strong> (before 4.02) used the configuration filename of 767 isolinux.cfg, searching /boot/isolinux (starting 2.00), then /isolinux 768 and /. As of 4.02, <strong>ISOLINUX</strong> will search for isolinux.cfg then 769 syslinux.cfg in /boot/isolinux before searching for the same files in 770 /isolinux, /boot/syslinux, /syslinux, and /.</p></div> 771 </div> 772 </div> 773 <div class="sect1"> 774 <h2 id="_global_directives_main">GLOBAL DIRECTIVES - MAIN</h2> 775 <div class="sectionbody"> 776 <div class="dlist"><dl> 777 <dt class="hdlist1"> 778 <strong>#</strong> comment 779 </dt> 780 <dd> 781 <p> 782 A line comment. As of version 3.10, the space between the <strong>#</strong> and the 783 comment is no longer required. 784 </p> 785 </dd> 786 <dt class="hdlist1"> 787 <strong>MENU</strong> any string 788 </dt> 789 <dd> 790 <p> 791 (3.00+) A directive for the simple menu system, treated as a comment 792 outside the menu. See menu.txt. 793 </p> 794 </dd> 795 <dt class="hdlist1"> 796 <strong>INCLUDE</strong> <em>filename</em> 797 </dt> 798 <dd> 799 <p> 800 Inserts the contents of another file at this point in the configuration 801 file. Files can currently be nested up to 16 levels deep, but it is not 802 guaranteed that more than 8 levels will be supported in the future. 803 </p> 804 </dd> 805 <dt class="hdlist1"> 806 <strong>DEFAULT</strong> <em>kernel</em> <em>options…</em> 807 </dt> 808 <dd> 809 <p> 810 Sets the default command line (which often references a LABEL). If 811 <strong>Syslinux</strong> boots automatically, it will act just as if the entries after 812 <strong>DEFAULT</strong> had been typed in at the <em>boot:</em> prompt. Multiple uses will 813 result in an override. 814 </p> 815 <div class="paragraph"><p>If no configuration file is present, or no <strong>DEFAULT</strong> or <strong>UI</strong> entry is 816 present in the config file, an error message is displayed and the 817 <em>boot:</em> prompt is shown (3.85+).</p></div> 818 </dd> 819 <dt class="hdlist1"> 820 <strong>UI</strong> <em>module</em> <em>options…</em> 821 </dt> 822 <dd> 823 <p> 824 Selects a specific user interface <em>module</em> (typically menu.c32 or 825 vesamenu.c32). The command-line interface treats this as a directive 826 that overrides the <strong>DEFAULT</strong> directive to load this module instead at 827 startup, for an empty command line and at timeout and <strong>PROMPT</strong> directive 828 to not prompt (but these directives may have effects on other 829 configuration parsers). Multiple uses will result in an override. 830 </p> 831 </dd> 832 <dt class="hdlist1"> 833 <strong>LABEL</strong> <em>mylabel</em> 834 </dt> 835 <dd> 836 <p> 837 Begin a new <strong>LABEL</strong> clause. If <em>mylabel</em> is entered as the kernel to 838 boot, <strong>Syslinux</strong> should instead boot "image" (specified by a directive 839 from <strong>KERNEL-LIKE DIRECTIVES</strong>) with any specified <strong>DUAL-PURPOSE 840 DIRECTIVES</strong> being used instead of the global instance. 841 </p> 842 <div class="paragraph"><p><em>mylabel</em> must be unique. Currently the first instance is used but may 843 result in an error or undesired behavior. <em>mylabel</em> ends at the first 844 character that is not a non-white-space printable character and should 845 be restricted to non-white-space typeable characters. Prior to version 846 3.32, this would transformed to a DOS compatible format of 8.3 with a 847 restricted character set. A <strong>LABEL</strong> clause must contain exactly 1 of 848 the <strong>KERNEL-LIKE DIRECTIVES</strong> and may contain 1 each of the <strong>LABEL-ONLY 849 DIRECTIVES</strong> or <strong>DUAL-PURPOSE DIRECTIVES</strong>.</p></div> 850 <div class="paragraph"><p>Within a <strong>LABEL</strong>, using multiple <strong>KERNEL-LIKE DIRECTIVES</strong> or reuse of 851 <strong>LABEL-ONLY DIRECTIVES</strong> or <strong>DUAL-PURPOSE DIRECTIVES</strong> will result in an 852 override. Otherwise, multiple instances of the same directive will 853 result in the last being effective.</p></div> 854 </dd> 855 </dl></div> 856 </div> 857 </div> 858 <div class="sect1"> 859 <h2 id="_dual_purpose_directives">DUAL-PURPOSE DIRECTIVES</h2> 860 <div class="sectionbody"> 861 <div class="paragraph"><p>Use of any of the <strong>DUAL-PURPOSE DIRECTIVES</strong> as <strong>GLOBAL DIRECTIVES</strong> is 862 discouraged if there will be any non-Linux images loaded as <strong>ALL</strong> images 863 will get these, including those manually entered at the <em>boot:</em> prompt.</p></div> 864 <div class="dlist"><dl> 865 <dt class="hdlist1"> 866 <strong>APPEND</strong> <em>options…</em> 867 </dt> 868 <dd> 869 <p> 870 Add one or more options to the kernel command line. These are added 871 both for automatic and manual boots. The options are added at the very 872 beginning of the kernel command line, usually permitting explicitly 873 entered kernel options to override them. This is the equivalent of the 874 LILO "append" option. 875 </p> 876 <div class="paragraph"><p>Use of the parameter <em>initrd=</em> supports multiple filenames separated by 877 commas (ie <em>initrd=initrd_file1,initrd_file2</em>) within a single instance. 878 This is mostly useful for initramfs, which can be composed of multiple 879 separate cpio or cpio.gz archives.</p></div> 880 <div class="paragraph"><p>Note: all initrd files except the last one are zero-padded to a 4K page 881 boundary. This should not affect initramfs.</p></div> 882 <div class="paragraph"><p>Note: Only the last effective <em>initrd=</em> parameter is used for loading 883 initrd files.</p></div> 884 </dd> 885 <dt class="hdlist1"> 886 <strong>APPEND</strong> - 887 </dt> 888 <dd> 889 <p> 890 Append nothing. <strong>APPEND</strong> with a single hyphen as argument in a <strong>LABEL</strong> 891 section can be used to override a global <strong>APPEND</strong>. 892 </p> 893 </dd> 894 </dl></div> 895 <div class="dlist"><dl> 896 <dt class="hdlist1"> 897 <strong>SYSAPPEND</strong> <em>bitmask</em> 898 </dt> 899 <dt class="hdlist1"> 900 <strong>IPAPPEND</strong> <em>bitmask</em> 901 </dt> 902 <dd> 903 <p> 904 (<strong>SYSAPPEND</strong>: 5.10+; <strong>IPAPPEND</strong>: <strong>PXELINUX</strong> only) 905 The <strong>SYSAPPEND</strong> option was introduced in <strong>Syslinux</strong> 5.10; it is an 906 enhancement of a previous option <strong>IPAPPEND</strong> which was only available on 907 <strong>PXELINUX</strong>. <em>bitmask</em> is interpreted as decimal format unless prefixed 908 with "0x" for hexadecimal or "0" (zero) for octal. The <em>bitmask</em> is an 909 OR (sum) of the following integer options: 910 </p> 911 <div class="dlist"><dl> 912 <dt class="hdlist1"> 913 <strong>1</strong> 914 </dt> 915 <dd> 916 <p> 917 An option of the following format should be generated, based on 918 the input from the DHCP/BOOTP or PXE boot server and added to the kernel 919 command line(see note below; empty for non-PXELINUX variants): 920 </p> 921 <div class="listingblock"> 922 <div class="content"> 923 <pre><code>ip=<client-ip>:<boot-server-ip>:<gw-ip>:<netmask></code></pre> 924 </div></div> 925 <div class="admonitionblock"> 926 <table><tr> 927 <td class="icon"> 928 <div class="title">Note</div> 929 </td> 930 <td class="content">The use of option 1 is no substitute for running a DHCP client in 931 the booted system and should instead only be used to seed the client for 932 a request. Without regular renewals, the lease acquired by the PXE BIOS 933 will expire, making the IP address available for reuse by the DHCP 934 server.</td> 935 </tr></table> 936 </div> 937 </dd> 938 <dt class="hdlist1"> 939 <strong>2</strong> 940 </dt> 941 <dd> 942 <p> 943 An option of the following format should be generated, in 944 dash-separated hexadecimal with leading hardware type (same as for the 945 configuration file; see pxelinux.txt.) and added to the kernel command 946 line, allowing an initrd program to determine from which interface the 947 system booted(empty for non-PXELINUX variants): 948 </p> 949 <div class="listingblock"> 950 <div class="content"> 951 <pre><code>BOOTIF=<hardware-address-of-boot-interface></code></pre> 952 </div></div> 953 </dd> 954 <dt class="hdlist1"> 955 <strong>4</strong> 956 </dt> 957 <dd> 958 <p> 959 An option of the following format should be generated, in lower 960 case hexadecimal in the format normally used for UUIDs (same as for the 961 configuration file; see pxelinux.txt.) and added to the kernel command 962 line: 963 </p> 964 <div class="listingblock"> 965 <div class="content"> 966 <pre><code>SYSUUID=<system uuid></code></pre> 967 </div></div> 968 </dd> 969 <dt class="hdlist1"> 970 <strong>8</strong> 971 </dt> 972 <dd> 973 <p> 974 (5.10+) indicate the CPU family and certain particularly 975 significant CPU feature bits: 976 </p> 977 <div class="listingblock"> 978 <div class="content"> 979 <pre><code>CPU=<family><features></code></pre> 980 </div></div> 981 <div class="paragraph"><p>The <family> is a single digit from 3 (i386) to 6 (i686 or higher.) The 982 following CPU features are currently reported; additional flags may be 983 added in the future:</p></div> 984 <div class="literalblock"> 985 <div class="content"> 986 <pre><code>P Physical Address Extension (PAE) 987 V Intel Virtualization Technology (VT/VMX) 988 T Intel Trusted Exection Technology (TXT/SMX) 989 X Execution Disable (XD/NX) 990 L Long Mode (x86-64) 991 S AMD SMX virtualization</code></pre> 992 </div></div> 993 </dd> 994 <dt class="hdlist1"> 995 <strong>DMI</strong> 996 </dt> 997 <dd> 998 <p> 999 (5.10+) The following strings are derived from DMI/SMBIOS 1000 information if available: 1001 </p> 1002 <div class="literalblock"> 1003 <div class="content"> 1004 <pre><code>Bit String Significance 1005 ------------------------------------------------------------- 1006 0x00010 SYSVENDOR= System vendor name 1007 0x00020 SYSPRODUCT= System product name 1008 0x00040 SYSVERSION= System version 1009 0x00080 SYSSERIAL= System serial number 1010 0x00100 SYSSKU= System SKU 1011 0x00200 SYSFAMILY= System family 1012 0x00400 MBVENDOR= Motherboard vendor name 1013 0x00800 MBVERSION= Motherboard version 1014 0x01000 MBSERIAL= Motherboard serial number 1015 0x02000 MBASSET= Motherboard asset tag 1016 0x04000 BIOSVENDOR= BIOS vendor name 1017 0x08000 BIOSVERSION= BIOS version 1018 0x10000 SYSFF= System form factor</code></pre> 1019 </div></div> 1020 <div class="paragraph"><p>If these strings contain white-space characters, they are replaced with 1021 underscores (_).</p></div> 1022 <div class="paragraph"><p>The system form factor value is a number defined in the SMBIOS 1023 specification, available at <a href="http://www.dmtf.org/">http://www.dmtf.org/</a>. As of version 2.7.1 1024 of the specification, the following values are defined:</p></div> 1025 <div class="literalblock"> 1026 <div class="content"> 1027 <pre><code> 1 Other 1028 2 Unknown 1029 3 Desktop 1030 4 Low profile desktop 1031 5 Pizza box 1032 6 Mini tower 1033 7 Tower 1034 8 Portble 1035 9 Laptop 1036 10 Notebook 1037 11 Handheld 1038 12 Docking station 1039 13 All-in-one 1040 14 Subnotebook 1041 15 Space-saving 1042 16 Lunch box 1043 17 Main server chassis 1044 18 Expansion chassis 1045 19 Subchassis 1046 20 Bus expansion chassis 1047 21 Peripheral chassis 1048 22 RAID chassis 1049 23 Rack mount chasss 1050 24 Sealed-case PC 1051 25 Multi-system chassis 1052 26 Compact PCI 1053 27 Advanced TCI 1054 28 Blade 1055 29 Blade enclosure</code></pre> 1056 </div></div> 1057 </dd> 1058 </dl></div> 1059 </dd> 1060 </dl></div> 1061 </div> 1062 </div> 1063 <div class="sect1"> 1064 <h2 id="_kernel_like_directives">KERNEL-LIKE DIRECTIVES</h2> 1065 <div class="sectionbody"> 1066 <div class="dlist"><dl> 1067 <dt class="hdlist1"> 1068 <strong>KERNEL</strong> <em>image</em> 1069 </dt> 1070 <dd> 1071 <p> 1072 Load a kernel-like file <em>image</em> with automatic filetype detection based 1073 on file extension, listed under the non-auto-detecting directives, 1074 defaulting to <strong>LINUX</strong>. 1075 </p> 1076 </dd> 1077 </dl></div> 1078 <div class="paragraph"><p><strong>LINUX</strong> is used as an example] 1079 <strong>LINUX</strong> <em>image</em>:: 1080 Load <em>image</em> as a Linux-like kernel. MEMDISK is an example of a 1081 non-Linux kernel loaded in a Linux-like fashion.</p></div> 1082 <div class="dlist"><dl> 1083 <dt class="hdlist1"> 1084 <strong>BOOT</strong> <em>image</em> 1085 </dt> 1086 <dd> 1087 <p> 1088 (<strong>ISOLINUX</strong> only: .bin; <strong>SYSLINUX</strong> only: .bs) Load a boot sector. .bin 1089 is a "CD boot sector" and .bs is a regular disk boot sector. 1090 </p> 1091 </dd> 1092 <dt class="hdlist1"> 1093 <strong>BSS</strong> <em>image</em> 1094 </dt> 1095 <dd> 1096 <p> 1097 (<strong>SYSLINUX</strong> only: .bss) Load a BSS image, a .bs image with the DOS 1098 superblock patched in. 1099 </p> 1100 </dd> 1101 <dt class="hdlist1"> 1102 <strong>COMBOOT</strong> <em>image</em> 1103 </dt> 1104 <dd> 1105 <p> 1106 (.com, .cbt; Removed as of 5.00) Load a <strong>Syslinux</strong> COMBOOT image. .com 1107 images may also be runnable from DOS while .cbt images are not. See 1108 also <strong>comboot.txt</strong> 1109 </p> 1110 </dd> 1111 <dt class="hdlist1"> 1112 <strong>COM32</strong> <em>image</em> 1113 </dt> 1114 <dd> 1115 <p> 1116 (.c32) Load a <strong>Syslinux</strong> COM32 (32-bit <strong>COMBOOT</strong>) image. See also 1117 <strong>comboot.txt</strong> 1118 </p> 1119 </dd> 1120 <dt class="hdlist1"> 1121 <strong>CONFIG</strong> <em>image</em> 1122 </dt> 1123 <dd> 1124 <p> 1125 Load a new configuration file. The configuration file is read, the 1126 working directory is changed (if specified via an <strong>APPEND</strong>), then the 1127 configuration file is parsed. 1128 </p> 1129 </dd> 1130 <dt class="hdlist1"> 1131 <strong>FDIMAGE</strong> <em>image</em> 1132 </dt> 1133 <dd> 1134 <p> 1135 (Removed as of 4.05, added 1.65; <strong>ISOLINUX</strong> only: .img) Load a disk 1136 image. 1137 </p> 1138 </dd> 1139 <dt class="hdlist1"> 1140 <strong>LOCALBOOT</strong> <em>type</em> 1141 </dt> 1142 <dd> 1143 <p> 1144 (<strong>PXELINUX</strong> 1.53+; <strong>ISOLINUX</strong> ??3.10+; <strong>SYSLINUX</strong> 3.70+)Attempt a 1145 different local boot method. The special value -1 causes the boot 1146 loader to report failure to the BIOS, which, on recent BIOSes, should 1147 mean that the next boot device in the boot sequence should be activated. 1148 Values other than those documented may produce undesired results. 1149 </p> 1150 <div class="paragraph"><p>On <strong>PXELINUX</strong>, <em>type</em> 0 means perform a normal boot. <em>type</em> 4 will 1151 perform a local boot with the Universal Network Driver Interface (UNDI) 1152 driver still resident in memory. Finally, <em>type</em> 5 will perform a local 1153 boot with the entire PXE stack, including the UNDI driver, still 1154 resident in memory. All other values are undefined. If you don’t know 1155 what the UNDI or PXE stacks are, don’t worry — you don’t want them, 1156 just specify 0.</p></div> 1157 <div class="paragraph"><p>On <strong>ISOLINUX</strong>/<strong>SYSLINUX</strong>, the <em>type</em> specifies the local drive number to 1158 boot from; 0x00 is the primary floppy drive and 0x80 is the primary hard 1159 drive.</p></div> 1160 </dd> 1161 <dt class="hdlist1"> 1162 <strong>PXE</strong> <em>image</em> 1163 </dt> 1164 <dd> 1165 <p> 1166 (<strong>PXELINUX</strong> only: .0) Load a PXE NBP (Network Boot Program) image. The 1167 PXE protocol does not provide any means for specifiying or using a 1168 command line or initrd. 1169 </p> 1170 </dd> 1171 </dl></div> 1172 </div> 1173 </div> 1174 <div class="sect1"> 1175 <h2 id="_label_only_directives">LABEL-ONLY DIRECTIVES</h2> 1176 <div class="sectionbody"> 1177 <div class="dlist"><dl> 1178 <dt class="hdlist1"> 1179 <strong>INITRD</strong> <em>initrd_file</em> 1180 </dt> 1181 <dd> 1182 <p> 1183 (3.71+) An initrd can be specified in a separate statement (INITRD) 1184 instead of as part of the <strong>APPEND</strong> statement; this functionally appends 1185 "initrd=initrd_file" to the kernel command line. Like <em>initrd=</em>, this 1186 also supports multiple comma separated file names (see <strong>APPEND</strong>). 1187 </p> 1188 </dd> 1189 </dl></div> 1190 </div> 1191 </div> 1192 <div class="sect1"> 1193 <h2 id="_global_directives_secondary">GLOBAL DIRECTIVES - SECONDARY</h2> 1194 <div class="sectionbody"> 1195 <div class="paragraph"><p>These are global directives that are of lesser importance, often 1196 affecting the user experience and not the boot process.</p></div> 1197 <div class="dlist"><dl> 1198 <dt class="hdlist1"> 1199 <strong>ALLOWOPTIONS</strong> <em>flag_val</em> 1200 </dt> 1201 <dd> 1202 <p> 1203 If <em>flag_val</em> is 0, the user is not allowed to specify any arguments on 1204 the kernel command line. The only options recognized are those 1205 specified in an <strong>APPEND</strong>) statement. The default is 1. 1206 </p> 1207 </dd> 1208 <dt class="hdlist1"> 1209 <strong>IMPLICIT</strong> <em>flag_val</em> 1210 </dt> 1211 <dd> 1212 <p> 1213 If <em>flag_val</em> is 0, do not load a kernel image unless it has been 1214 explicitly named in a <strong>LABEL</strong> statement. The default is 1. 1215 </p> 1216 </dd> 1217 <dt class="hdlist1"> 1218 <strong>TIMEOUT</strong> <em>timeout</em> 1219 </dt> 1220 <dd> 1221 <p> 1222 Indicates how long to wait at the <em>boot:</em> prompt until booting 1223 automatically, in units of 1/10 s. The timeout is cancelled as soon as 1224 the user types anything on the keyboard, the assumption being that the 1225 user will complete the command line already begun. The timer is reset 1226 to 0 upon return from an unsuccessful attempt to boot or from a module. 1227 A timeout of zero (the default) will disable the timeout completely. 1228 </p> 1229 </dd> 1230 <dt class="hdlist1"> 1231 <strong>TOTALTIMEOUT</strong> <em>timeout</em> 1232 </dt> 1233 <dd> 1234 <p> 1235 Indicates how long to wait until booting automatically, in units of 1236 1/10 s. This timeout is <strong>not</strong> cancelled by user input, and can thus be 1237 used to deal with serial port glitches or "the user walked away" type 1238 situations. A timeout of zero (the default) will disable the timeout 1239 completely. 1240 </p> 1241 <div class="paragraph"><p>Both <strong>TIMEOUT</strong> and <strong>TOTALTIMEOUT</strong> can be used together, for example:</p></div> 1242 <div class="listingblock"> 1243 <div class="content"> 1244 <pre><code># Wait 5 seconds unless the user types something, but 1245 # always boot after 15 minutes. 1246 TIMEOUT 50 1247 TOTALTIMEOUT 9000</code></pre> 1248 </div></div> 1249 </dd> 1250 </dl></div> 1251 <div class="dlist"><dl> 1252 <dt class="hdlist1"> 1253 <strong>ONTIMEOUT</strong> <em>kernel options…</em> 1254 </dt> 1255 <dd> 1256 <p> 1257 Sets the command line invoked on a timeout (which often references a 1258 LABEL). If not specified, <em>UI</em> (if used) or 'DEFAULT is used. 1259 </p> 1260 </dd> 1261 <dt class="hdlist1"> 1262 <strong>ONERROR</strong> <em>kernel options…</em> 1263 </dt> 1264 <dd> 1265 <p> 1266 If a kernel image is not found (either due to it not existing, or 1267 because <strong>IMPLICIT</strong> is set), run the specified command. The faulty 1268 command line is appended to the specified options, so if the <strong>ONERROR</strong> 1269 directive reads as: 1270 </p> 1271 <div class="listingblock"> 1272 <div class="content"> 1273 <pre><code>ONERROR xyzzy plugh</code></pre> 1274 </div></div> 1275 <div class="paragraph"><p>and the command line as entered by the user is:</p></div> 1276 <div class="listingblock"> 1277 <div class="content"> 1278 <pre><code>foo bar baz</code></pre> 1279 </div></div> 1280 <div class="paragraph"><p><strong>Syslinux</strong> will execute the following as if entered by the user:</p></div> 1281 <div class="listingblock"> 1282 <div class="content"> 1283 <pre><code>xyzzy plugh foo bar baz</code></pre> 1284 </div></div> 1285 </dd> 1286 <dt class="hdlist1"> 1287 <strong>SERIAL</strong> <em>port [baudrate [flowcontrol]]</em> 1288 </dt> 1289 <dd> 1290 <p> 1291 Enables a serial port to act as the console. <em>port</em> is a number (0 = 1292 /dev/ttyS0 = COM1, etc.) or an I/O port address (e.g. 0x3F8); if 1293 <em>baudrate</em> is omitted, the baud rate defaults to 9600 bps. The serial 1294 parameters are hardcoded to be 8 bits, no parity, 1 stop bit. 1295 </p> 1296 <div class="paragraph"><p><em>flowcontrol</em> is a combination of the following bits:</p></div> 1297 <div class="literalblock"> 1298 <div class="content"> 1299 <pre><code>0x001 - Assert DTR 1300 0x002 - Assert RTS 1301 0x008 - Enable interrupts 1302 0x010 - Wait for CTS assertion 1303 0x020 - Wait for DSR assertion 1304 0x040 - Wait for RI assertion 1305 0x080 - Wait for DCD assertion 1306 0x100 - Ignore input unless CTS asserted 1307 0x200 - Ignore input unless DSR asserted 1308 0x400 - Ignore input unless RI asserted 1309 0x800 - Ignore input unless DCD asserted</code></pre> 1310 </div></div> 1311 <div class="paragraph"><p>All other bits are reserved.</p></div> 1312 <div class="paragraph"><p>Typical values are:</p></div> 1313 <div class="literalblock"> 1314 <div class="content"> 1315 <pre><code> 0 - No flow control (default) 1316 0x303 - Null modem cable detect 1317 0x013 - RTS/CTS flow control 1318 0x813 - RTS/CTS flow control, modem input 1319 0x023 - DTR/DSR flow control 1320 0x083 - DTR/DCD flow control</code></pre> 1321 </div></div> 1322 <div class="paragraph"><p>For the <strong>SERIAL</strong> directive to be guaranteed to work properly, it should 1323 be the first directive in the configuration file.</p></div> 1324 <div class="admonitionblock"> 1325 <table><tr> 1326 <td class="icon"> 1327 <div class="title">Note</div> 1328 </td> 1329 <td class="content"><em>port</em> values from 0 to 3 means the first four serial ports 1330 detected by the BIOS. They may or may not correspond to the legacy port 1331 values 0x3F8, 0x2F8, 0x3E8, 0x2E8.</td> 1332 </tr></table> 1333 </div> 1334 <div class="paragraph"><p>Enabling interrupts (setting the 0x008 bit) may give better 1335 responsiveness without setting the <strong>NOHALT</strong> option, but could 1336 potentially cause problems with buggy BIOSes.</p></div> 1337 <div class="paragraph"><p>This option is "sticky" and is not automatically reset when loading a 1338 new configuration file with the CONFIG command.</p></div> 1339 </dd> 1340 <dt class="hdlist1"> 1341 <strong>NOHALT</strong> <em>flag_val</em> 1342 </dt> 1343 <dd> 1344 <p> 1345 If <em>flag_val</em> is 1, don’t halt the processor while idle. Halting the 1346 processor while idle significantly reduces the power consumption, but 1347 can cause poor responsiveness to the serial console, especially when 1348 using scripts to drive the serial console, as opposed to human 1349 interaction. 1350 </p> 1351 </dd> 1352 <dt class="hdlist1"> 1353 <strong>CONSOLE</strong> <em>flag_val</em> 1354 </dt> 1355 <dd> 1356 <p> 1357 If <em>flag_val</em> is 0, disable output to the normal video console. If 1358 <em>flag_val</em> is 1, enable output to the video console (this is the 1359 default.) 1360 </p> 1361 <div class="paragraph"><p>Some BIOSes try to forward this to the serial console and sometimes make 1362 a total mess thereof, so this option lets you disable the video console 1363 on these systems.</p></div> 1364 </dd> 1365 <dt class="hdlist1"> 1366 <strong>FONT</strong> <em>filename</em> 1367 </dt> 1368 <dd> 1369 <p> 1370 Load a font in .psf format before displaying any output (except the 1371 copyright line, which is output as ldlinux.sys itself is loaded.) 1372 <strong>Syslinux</strong> only loads the font onto the video card; if the .psf file 1373 contains a Unicode table it is ignored. This only works on EGA and VGA 1374 cards; hopefully it should do nothing on others. 1375 </p> 1376 </dd> 1377 <dt class="hdlist1"> 1378 <strong>KBDMAP</strong> <em>keymap</em> 1379 </dt> 1380 <dd> 1381 <p> 1382 Install a simple keyboard map. The keyboard remapper used is <strong>very</strong> 1383 simplistic (it simply remaps the keycodes received from the BIOS, which 1384 means that only the key combinations relevant in the default layout — usually U.S. English — can be mapped) but should at least help people 1385 with AZERTY keyboard layout and the locations of = and , (two special 1386 characters used heavily on the Linux kernel command line.) 1387 </p> 1388 <div class="paragraph"><p>The included program keytab-lilo.pl from the LILO distribution can be 1389 used to create such keymaps. The file keytab-lilo.txt contains the 1390 documentation for this program.</p></div> 1391 </dd> 1392 <dt class="hdlist1"> 1393 <strong>DISPLAY</strong> <em>filename</em> 1394 </dt> 1395 <dd> 1396 <p> 1397 Displays the indicated file on the screen at boot time (before the boot: 1398 prompt, if displayed). Please see the section below on <strong>DISPLAY</strong> files. 1399 </p> 1400 <div class="admonitionblock"> 1401 <table><tr> 1402 <td class="icon"> 1403 <div class="title">Note</div> 1404 </td> 1405 <td class="content">If the file is missing, this option is simply ignored.</td> 1406 </tr></table> 1407 </div> 1408 </dd> 1409 <dt class="hdlist1"> 1410 <strong>SAY</strong> <em>message</em> 1411 </dt> 1412 <dd> 1413 <p> 1414 Prints the message on the screen. 1415 </p> 1416 </dd> 1417 <dt class="hdlist1"> 1418 <strong>PROMPT</strong> <em>flag_val</em> 1419 </dt> 1420 <dd> 1421 <p> 1422 If <em>flag_val</em> is 0, display the boot: prompt only if the Shift or Alt 1423 key is pressed, or Caps Lock or Scroll lock is set (this is the 1424 default). If <em>flag_val</em> is 1, always display the boot: prompt. 1425 </p> 1426 </dd> 1427 <dt class="hdlist1"> 1428 <strong>NOESCAPE</strong> <em>flag_val</em> 1429 </dt> 1430 <dd> 1431 <p> 1432 If <em>flag_val</em> is set to 1, ignore the Shift/Alt/Caps Lock/Scroll Lock 1433 escapes. Use this (together with PROMPT 0) to force the default boot 1434 alternative. 1435 </p> 1436 </dd> 1437 <dt class="hdlist1"> 1438 <strong>NOCOMPLETE</strong> <em>flag_val</em> 1439 </dt> 1440 <dd> 1441 <p> 1442 If <em>flag_val</em> is set to 1, the Tab key does not display labels at the 1443 boot: prompt. 1444 </p> 1445 </dd> 1446 </dl></div> 1447 <div class="dlist"><dl> 1448 <dt class="hdlist1"> 1449 <strong>F1</strong> <em>filename</em> 1450 </dt> 1451 <dt class="hdlist1"> 1452 <strong>F2</strong> <em>filename</em> 1453 </dt> 1454 <dt class="hdlist1"> 1455 <strong>F3</strong> <em>filename</em> 1456 </dt> 1457 <dt class="hdlist1"> 1458 <strong>F4</strong> <em>filename</em> 1459 </dt> 1460 <dt class="hdlist1"> 1461 <strong>F5</strong> <em>filename</em> 1462 </dt> 1463 <dt class="hdlist1"> 1464 <strong>F6</strong> <em>filename</em> 1465 </dt> 1466 <dt class="hdlist1"> 1467 <strong>F7</strong> <em>filename</em> 1468 </dt> 1469 <dt class="hdlist1"> 1470 <strong>F8</strong> <em>filename</em> 1471 </dt> 1472 <dt class="hdlist1"> 1473 <strong>F9</strong> <em>filename</em> 1474 </dt> 1475 <dt class="hdlist1"> 1476 <strong>F10</strong> <em>filename</em> 1477 </dt> 1478 <dt class="hdlist1"> 1479 <strong>F11</strong> <em>filename</em> 1480 </dt> 1481 <dt class="hdlist1"> 1482 <strong>F12</strong> <em>filename</em> 1483 </dt> 1484 <dd> 1485 <p> 1486 Displays the indicated file on the screen when a function key is pressed 1487 at the boot: prompt. This can be used to implement pre-boot online help 1488 (presumably for the kernel command line options.) Please see the 1489 section below on DISPLAY files. 1490 </p> 1491 <div class="paragraph"><p>When using the serial console, press <Ctrl-F><digit> to get to the help 1492 screens, e.g. <Ctrl-F><2> to get to the F2 screen. For F10-F12, hit 1493 <Ctrl-F><A>, <Ctrl-F>B, <Ctrl-F>C. For compatibility with earlier 1494 versions, F10 can also be entered as <Ctrl-F>0.</p></div> 1495 </dd> 1496 <dt class="hdlist1"> 1497 <strong>PATH</strong> <em>path</em> 1498 </dt> 1499 <dd> 1500 <p> 1501 (5.00+) Specify a space-separated (' <em>; 5.00-5.10 was a colon ':</em>) list 1502 of directories to search when attempting to load modules. This directive 1503 is useful for specifying the directories containing the lib*.c32 library 1504 files as other modules may be dependent on these files, but may not 1505 reside in the same directory. Multiple instances will append additional 1506 paths. 1507 </p> 1508 </dd> 1509 <dt class="hdlist1"> 1510 <strong>SENDCOOKIES</strong> <em>bitmask</em> 1511 </dt> 1512 <dd> 1513 <p> 1514 (<strong>PXELINUX</strong> 5.10+) When downloading files over http, the SYSAPPEND 1515 strings are prepended with <em>Syslinux</em> and sent to the server as cookies. 1516 The cookies are URL-encoded; whitespace is <strong>not</strong> replaced with 1517 underscores. 1518 </p> 1519 <div class="paragraph"><p>This command limits the cookies send; 0 means no cookies. The default 1520 is -1, meaning send all cookies.</p></div> 1521 <div class="paragraph"><p>This option is "sticky" and is not automatically reset when loading a 1522 new configuration file with the CONFIG command.</p></div> 1523 </dd> 1524 </dl></div> 1525 </div> 1526 </div> 1527 <div class="sect1"> 1528 <h2 id="_display_file_format">DISPLAY FILE FORMAT</h2> 1529 <div class="sectionbody"> 1530 <div class="paragraph"><p>DISPLAY and function-key help files are text files in either DOS or UNIX 1531 format (with or without <CR>). In addition, the following special codes 1532 are interpreted:</p></div> 1533 <div class="paragraph"><p>identical to #3</p></div> 1534 <div class="dlist"><dl> 1535 <dt class="hdlist1"> 1536 <strong><FF></strong> 1537 </dt> 1538 <dd> 1539 <p> 1540                                  = <Ctrl-L> = ASCII 12<br /> 1541 Clear the screen, home the cursor. Note that the screen is filled with 1542 the current display color. 1543 </p> 1544 </dd> 1545 <dt class="hdlist1"> 1546 <strong><FF></strong> 1547 </dt> 1548 <dd> 1549 <p> 1550 = <Ctrl-L> = ASCII 12; Clear the screen, home the cursor. Note that the 1551 screen is filled with the current display color. 1552 </p> 1553 </dd> 1554 <dt class="hdlist1"> 1555 <strong><FF></strong> 1556 </dt> 1557 <dd> 1558 <p> 1559 <FF> = <Ctrl-L> = ASCII 12 1560 </p> 1561 <div class="paragraph"><p>Clear the screen, home the cursor. Note that the screen is filled with 1562 the current display color.</p></div> 1563 </dd> 1564 <dt class="hdlist1"> 1565 <strong><FF></strong> 1566 </dt> 1567 <dd> 1568 <p> 1569 <FF> = <Ctrl-L> = ASCII 12<br /> 1570 Clear the screen, home the cursor. Note that the screen is filled with 1571 the current display color. 1572 </p> 1573 </dd> 1574 <dt class="hdlist1"> 1575 <strong><SI></strong><em><bg><fg></em> 1576 </dt> 1577 <dd> 1578 <p> 1579 <SI> = <Ctrl-O> = ASCII 15 1580 </p> 1581 <div class="paragraph"><p>Set the display colors to the specified background and foreground 1582 colors, where <bg> and <fg> are the 2 hex digits representing 1 byte, 1583 corresponding to the standard PC display attributes:</p></div> 1584 <div class="literalblock"> 1585 <div class="content"> 1586 <pre><code>0 = black 8 = dark grey 1587 1 = dark blue 9 = bright blue 1588 2 = dark green a = bright green 1589 3 = dark cyan b = bright cyan 1590 4 = dark red c = bright red 1591 5 = dark purple d = bright purple 1592 6 = brown e = yellow 1593 7 = light grey f = white</code></pre> 1594 </div></div> 1595 <div class="paragraph"><p>Picking a bright color (8-f) for the background results in the 1596 corresponding dark color (0-7), with the foreground flashing.</p></div> 1597 <div class="paragraph"><p>Colors are not visible over the serial console.</p></div> 1598 </dd> 1599 <dt class="hdlist1"> 1600 <strong><CAN></strong><em>filename<newline></em> 1601 </dt> 1602 <dd> 1603 <p> 1604 <CAN> = <Ctrl-X> = ASCII 24 1605 </p> 1606 <div class="paragraph"><p>If a VGA display is present, enter graphics mode and display the graphic 1607 included in the specified file. The file format is an ad hoc format 1608 called LSS16; the included Perl program "ppmtolss16" can be used to 1609 produce these images. This Perl program also includes the file format 1610 specification.</p></div> 1611 <div class="paragraph"><p>The image is displayed in 640x480 16-color mode. Once in graphics mode, 1612 the display attributes (set by <SI> code sequences) work slightly 1613 differently: the background color is ignored, and the foreground colors 1614 are the 16 colors specified in the image file. For that reason, 1615 ppmtolss16 allows you to specify that certain colors should be assigned 1616 to specific color indicies.</p></div> 1617 <div class="paragraph"><p>Color indicies 0 and 7, in particular, should be chosen with care: 0 is 1618 the background color, and 7 is the color used for the text printed by 1619 <strong>Syslinux</strong> itself.</p></div> 1620 </dd> 1621 <dt class="hdlist1"> 1622 <strong><EM></strong> 1623 </dt> 1624 <dd> 1625 <p> 1626 <EM> = <Ctrl-Y> = ASCII 25<br /> 1627 If we are currently in graphics mode, return to text mode. 1628 </p> 1629 </dd> 1630 <dt class="hdlist1"> 1631 <strong><DLE></strong>..<strong><ETB></strong> 1632 </dt> 1633 <dd> 1634 <p> 1635 <Ctrl-P>..<Ctrl-W> = ASCII 16-23 1636 </p> 1637 <div class="paragraph"><p>These codes can be used to select which modes to print a certain part of 1638 the message file in. Each of these control characters select a specific 1639 set of modes (text screen, graphics screen, serial port) for which the 1640 output is actually displayed:</p></div> 1641 <div class="literalblock"> 1642 <div class="content"> 1643 <pre><code>Character Text Graph Serial 1644 ------------------------------------------------------ 1645 <DLE> = <Ctrl-P> = ASCII 16 No No No 1646 <DC1> = <Ctrl-Q> = ASCII 17 Yes No No 1647 <DC2> = <Ctrl-R> = ASCII 18 No Yes No 1648 <DC3> = <Ctrl-S> = ASCII 19 Yes Yes No 1649 <DC4> = <Ctrl-T> = ASCII 20 No No Yes 1650 <NAK> = <Ctrl-U> = ASCII 21 Yes No Yes 1651 <SYN> = <Ctrl-V> = ASCII 22 No Yes Yes 1652 <ETB> = <Ctrl-W> = ASCII 23 Yes Yes Yes</code></pre> 1653 </div></div> 1654 <div class="paragraph"><p>For example, the following will actually print out which mode the 1655 console is in:</p></div> 1656 <div class="literalblock"> 1657 <div class="content"> 1658 <pre><code><DC1>Text mode<DC2>Graphics mode<DC4>Serial port<ETB></code></pre> 1659 </div></div> 1660 </dd> 1661 <dt class="hdlist1"> 1662 <strong><SUB></strong> 1663 </dt> 1664 <dd> 1665 <p> 1666 <SUB> = <Ctrl-Z> = ASCII 26 1667 </p> 1668 <div class="paragraph"><p>End of file (DOS convention).</p></div> 1669 </dd> 1670 <dt class="hdlist1"> 1671 <strong><BEL></strong> 1672 </dt> 1673 <dd> 1674 <p> 1675 <BEL> = <Ctrl-G> = ASCII 7<br /> 1676 Beep the speaker. 1677 </p> 1678 </dd> 1679 </dl></div> 1680 </div> 1681 </div> 1682 <div class="sect1"> 1683 <h2 id="_boot_loader_ids_used">BOOT LOADER IDS USED</h2> 1684 <div class="sectionbody"> 1685 <div class="paragraph"><p>The Linux boot protocol supports a "boot loader ID", a single byte where 1686 the upper nybble specifies a boot loader family (3 = <strong>Syslinux</strong>) and the 1687 lower nybble is version or, in the case of <strong>Syslinux</strong>, media:</p></div> 1688 <div class="literalblock"> 1689 <div class="content"> 1690 <pre><code>0x31 (49) = SYSLINUX 1691 0x32 (50) = PXELINUX 1692 0x33 (51) = ISOLINUX 1693 0x34 (52) = EXTLINUX</code></pre> 1694 </div></div> 1695 <div class="paragraph"><p>In recent versions of Linux, this ID is available as 1696 /proc/sys/kernel/bootloader_type.</p></div> 1697 </div> 1698 </div> 1699 <div class="sect1"> 1700 <h2 id="_novice_protection">NOVICE PROTECTION</h2> 1701 <div class="sectionbody"> 1702 <div class="paragraph"><p><strong>Syslinux</strong> will attempt to detect booting on a machine with too little 1703 memory, which means the Linux boot sequence cannot complete. If so, a 1704 message is displayed and the boot sequence aborted. Holding down the 1705 Ctrl key while booting disables this feature.</p></div> 1706 <div class="paragraph"><p>Any file that <strong>Syslinux</strong> uses can be marked hidden, system or readonly 1707 if so is convenient; <strong>Syslinux</strong> ignores all file attributes. The 1708 <strong>SYSLINUX</strong> installer automatically sets the readonly/hidden/system 1709 attributes on LDLINUX.SYS.</p></div> 1710 </div> 1711 </div> 1712 <div class="sect1"> 1713 <h2 id="_example">EXAMPLE</h2> 1714 <div class="sectionbody"> 1715 <div class="paragraph"><p>Here are some sample config files:</p></div> 1716 <div class="listingblock"> 1717 <div class="content"> 1718 <pre><code># SERIAL 0 115200 1719 DEFAULT linux 1720 PROMPT 1 1721 TIMEOUT 600 1722 1723 LABEL linux 1724 LINUX vmlinuz 1725 APPEND initrd=initrd1.gz,initrd2.gz 1726 1727 LABEL m 1728 COM32 menu.c32</code></pre> 1729 </div></div> 1730 <div class="paragraph"><p>In this example, serial port use is disabled but can be enabled by 1731 uncommenting the first line and utilize serial port 0 at 115200 bps. If 1732 <em>linux</em> is typed on the command line, the kernel-like file <em>vmlinuz</em> is 1733 executed as a Linux kernel, initrd files initrd1.gz and initrd2.gz are 1734 loaded as initial ramdisk files (like cpio.gz files for initramfs). If 1735 <em>m</em> is typed on the command line, the COM32 module <em>menu.c32</em> is 1736 executed to launch a menu system.</p></div> 1737 </div> 1738 </div> 1739 <div class="sect1"> 1740 <h2 id="_known_bugs">KNOWN BUGS</h2> 1741 <div class="sectionbody"> 1742 <div class="paragraph"><p>Several known bugs/common problems are listed at 1743 <a href="http://www.syslinux.org/wiki/index.php/Common_Problems">http://www.syslinux.org/wiki/index.php/Common_Problems</a> and known 1744 hardware compatibility issues are listed at 1745 <a href="http://www.syslinux.org/wiki/index.php/Hardware_Compatibility">http://www.syslinux.org/wiki/index.php/Hardware_Compatibility</a> with 1746 filename translation difficulty and early PXE stacks being some of the 1747 most common. Reporting of other encountered issues is welcome and 1748 appreciated.</p></div> 1749 </div> 1750 </div> 1751 <div class="sect1"> 1752 <h2 id="_bug_reports">BUG REPORTS</h2> 1753 <div class="sectionbody"> 1754 <div class="paragraph"><p>I would appreciate hearing of any problems you have with Syslinux. I 1755 would also like to hear from you if you have successfully used Syslinux, 1756 <strong>especially</strong> if you are using it for a distribution.</p></div> 1757 <div class="paragraph"><p>If you are reporting problems, please include all possible information 1758 about your system and your BIOS; the vast majority of all problems 1759 reported turn out to be BIOS or hardware bugs, and I need as much 1760 information as possible in order to diagnose the problems.</p></div> 1761 <div class="paragraph"><p>There is a mailing list for discussion among Syslinux users and for 1762 announcements of new and test versions. To join, or to browse the 1763 archive, go to:</p></div> 1764 <div class="paragraph"><p><a href="http://www.zytor.com/mailman/listinfo/syslinux">http://www.zytor.com/mailman/listinfo/syslinux</a></p></div> 1765 <div class="paragraph"><p>Please DO NOT send HTML messages or attachments to the mailing list 1766 (including multipart/alternative or similar.) All such messages will be 1767 bounced.</p></div> 1768 </div> 1769 </div> 1770 <div class="sect1"> 1771 <h2 id="_author">AUTHOR</h2> 1772 <div class="sectionbody"> 1773 <div class="paragraph"><p>This AsciiDoc derived document is a modified version of the original 1774 <strong>SYSLINUX</strong> documentation by H. Peter Anvin <<a href="mailto:hpa (a] zytor.com">hpa (a] zytor.com</a>>. The conversion 1775 to an AsciiDoc was made by Gene Cumm <<a href="mailto:gene.cumm (a] gmail.com">gene.cumm (a] gmail.com</a>></p></div> 1776 </div> 1777 </div> 1778 </div> 1779 <div id="footnotes"><hr /></div> 1780 <div id="footer"> 1781 <div id="footer-text"> 1782 Last updated 2014-01-17 16:09:56 PST 1783 </div> 1784 </div> 1785 </body> 1786 </html> 1787