summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMatt Fleming <matt.fleming@intel.com>2013-02-25 15:25:16 +0000
committerMatt Fleming <matt.fleming@intel.com>2013-02-26 11:29:04 +0000
commit76da2ae050d72a31fd47c2fb53f7081781de62ff (patch)
tree6da146b5f19ca17ff24d4e74940f14264d38f914 /doc
parent41c29c26d70fde563d7c255872bbadad87a39dfa (diff)
parent79312306de0150ef64213ef9fbc5aa8580544f03 (diff)
downloadsyslinux-76da2ae050d72a31fd47c2fb53f7081781de62ff.tar.gz
Merge branch 'lwip' into elflink
Welcome to Syslinux 5.10. Conflicts: NEWS com32/lib/Makefile com32/lib/sys/open.c com32/lib/syslinux/ipappend.c com32/modules/Makefile com32/modules/prdhcp.c core/Makefile core/cmdline.inc core/com32.inc core/comboot.inc core/configinit.inc core/fs/chdir.c core/fs/fs.c core/fs/pxe/dnsresolv.c core/fs/pxe/pxe.c core/fs/pxe/pxe.h core/idle.c core/include/ctype.h core/init.inc core/mem/init.c core/parseconfig.inc core/runkernel.inc core/syslinux.ld core/ui.inc doc/comboot.txt version
Diffstat (limited to 'doc')
-rw-r--r--doc/cptime.txt50
-rw-r--r--doc/pxelinux.txt41
-rw-r--r--doc/syslinux.txt111
3 files changed, 182 insertions, 20 deletions
diff --git a/doc/cptime.txt b/doc/cptime.txt
new file mode 100644
index 00000000..982dbf7c
--- /dev/null
+++ b/doc/cptime.txt
@@ -0,0 +1,50 @@
+= cptime.c32(1) =
+:doctype: manpage
+:author: Gene Cumm
+:email: gene.cumm@gmail.com
+:revdate: 2011-12-17
+
+
+== NAME ==
+cptime.c32 - times the copy off (read) of a file
+
+
+== SYNOPSIS ==
+*cptime.c32* ['OPTIONS'] 'FILE'...
+
+
+== DESCRIPTION ==
+Times the copy off (read) of a file, optionally computes/displays
+transfer rates(on by default) with an adjustable transfer size and
+maximum transfer length.
+
+
+== OPTIONS ==
+*-b* 'SIZE'::
+ use 'SIZE' for transfer size; defaults to 2048 for COM32
+
+*-l*::
+ long output mode; default; reverses *-s*
+
+*-n* 'LEN'::
+ maximum length to fetch; defaults to whole file
+
+*-q*::
+ quiet (normal/non-verbose) mode; default; reverses *-v*
+
+*-s*::
+ simple output mode
+
+*-v*::
+ verbose mode
+
+The same mode is used for all files.
+
+
+== AUTHOR ==
+{author} <{email}>
+
+== COPYRIGHT ==
+Copyright \(C) 2011 {author}. Free use of this software is granted under
+the terms of the GNU General Public License (GPL).
+
diff --git a/doc/pxelinux.txt b/doc/pxelinux.txt
index 69c1a645..4dbb152e 100644
--- a/doc/pxelinux.txt
+++ b/doc/pxelinux.txt
@@ -3,12 +3,16 @@
A bootloader for Linux using the PXE network booting protocol
Copyright 1994-2008 H. Peter Anvin - All Rights Reserved
+ Copyright 2009-2011 Intel Corporation; author: H. Peter Anvin
This program is provided under the terms of the GNU General Public
License, version 2 or, at your option, any later version. There is no
warranty, neither expressed nor implied, to the function of this
program. Please see the included file COPYING for details.
+This documentation file is slightly out of date; please check the NEWS
+file for changes.
+
----------------------------------------------------------------------
PXELINUX is a Syslinux derivative, for booting Linux off a network
@@ -99,25 +103,22 @@ boot, if you have such a setup. MTFTP server setup is beyond the
scope of this document.
- ++++ gPXE-ENHANCED VARIANTS ++++
+ ++++ HTTP AND FTP DOWNLOADS ++++
-gPXE can be used to enhance PXELINUX's functionality to also include
-HTTP transfers, greatly increasing load speed and allowing for standard
-HTTP scripts to present PXELINUX's configuration file. pxelinux.0 is
-the plain variant. gpxelinux.0 (included as of 3.70) is gPXE's
-undionly.kkpxe, pxelinux.0 and a script to run pxelinux.0. gpxelinuxk.0
-(included as of 4.04) is gPXE's undionly.kpxe, pxelinux.0 and a script
-to run pxelinux.0. gpxelinuxk.0 should only be used with systems that
-are incompatible with gpxelinux.0 as it prevents certain functionality
-from working (LOCALBOOT with a type not equal to -1) and is incompatible
-with certain hardware, PXE stacks and network setups.
+Since version 5.10, native pxelinux.0 can support HTTP and FTP
+transfers, greatly increasing load speed and allowing for standard
+HTTP scripts to present PXELINUX's configuration file. To use http or
+ftp, use standard URL syntax as filename; use the DHCP options below
+to transmit a suitable URL prefix to the client, or use the
+"pxelinux-options" tool provided in the utils directory to program it
+directly into the pxelinux.0 file.
++++ SETTING UP THE TFTP SERVER ++++
-PXELINUX currently requires that the boot server has a TFTP server
-which supports the "tsize" TFTP option (RFC 1784/RFC 2349). The
-"tftp-hpa" TFTP server, which support options, is available at:
+For best results, use a TFTP server which supports the "tsize" TFTP
+option (RFC 1784/RFC 2349). The "tftp-hpa" TFTP server, which support
+options, is available at:
http://www.kernel.org/pub/software/network/tftp/
ftp://www.kernel.org/pub/software/network/tftp/
@@ -343,7 +344,15 @@ If you used this from a client whose Ethernet address was
"/tftpboot/pxelinux.cfg/1:58:fa:84:cf:55:e".
- ++++ ALTERNATE TFTP SERVERS ++++
+ ++++ HARDCODED OPTIONS ++++
+
+Since version 3.83, the program "pxelinux-options" can be used to
+hard-code DHCP options into the pxelinux.0 image file; this is
+sometimes useful when the DHCP server is under different
+administrative control.
+
+
+ ++++ ALTERNATE TFTP SERVERS AND URL SYNTAX ++++
PXELINUX supports the following special pathname conventions:
@@ -365,6 +374,8 @@ usage. However, if you happen to have an environment for which the
special treatment of :: is a problem, please contact the Syslinux
mailing list.
+Since version 4.00, PXELINUX also supports standard URL syntax.
+
++++ SOME NOTES ++++
diff --git a/doc/syslinux.txt b/doc/syslinux.txt
index caf3a06c..a4b201fd 100644
--- a/doc/syslinux.txt
+++ b/doc/syslinux.txt
@@ -153,9 +153,12 @@ APPEND options...
usually permitting explicitly entered kernel options to override
them. This is the equivalent of the LILO "append" option.
-IPAPPEND flag_val [PXELINUX only]
- The IPAPPEND option is available only on PXELINUX. The
- flag_val is an OR of the following options:
+SYSAPPEND bitmask
+IPAPPEND bitmask
+
+ The SYSAPPEND option was introduced in Syslinux 5.10; it is an
+ enhancement of a previous option IPAPPEND which was only
+ available on PXELINUX.
1: indicates that an option of the following format
should be generated and added to the kernel command line:
@@ -169,6 +172,8 @@ IPAPPEND flag_val [PXELINUX only]
the lease acquired by the PXE BIOS will expire, making the
IP address available for reuse by the DHCP server.
+ This option is empty for non-PXELINUX.
+
2: indicates that an option of the following format
should be generated and added to the kernel command line:
@@ -180,6 +185,8 @@ IPAPPEND flag_val [PXELINUX only]
This allows an initrd program to determine from which
interface the system booted.
+ This option is empty for non-PXELINUX.
+
4: indicates that an option of the following format
should be generated and added to the kernel command line:
@@ -187,14 +194,105 @@ IPAPPEND flag_val [PXELINUX only]
... in lower case hexadecimal in the format normally used for
UUIDs (same as for the configuration file; see pxelinux.txt.)
+ This may not be available if no valid UUID is found on the
+ system.
+
+ 8: indicate the CPU family and certain particularly
+ significant CPU feature bits:
+
+ CPU=<family><features>
+
+ The <family> is a single digit from 3 (i386) to 6 (i686 or
+ higher.) The following CPU feature are currently reported;
+ additional flags may be added in the future:
+
+ P Physical Address Extension (PAE)
+ V Intel Virtualization Technology (VT/VMX)
+ T Intel Trusted Exection Technology (TXT/SMX)
+ X Execution Disable (XD/NX)
+ L Long Mode (x86-64)
+ S AMD SMX virtualization
+
+ This was added in 5.10.
+
+ The following strings are derived from DMI/SMBIOS information
+ if available; these are all new in version 5.10:
+
+ Bit String Significance
+ -------------------------------------------------------------
+ 0x00010 SYSVENDOR= System vendor name
+ 0x00020 SYSPRODUCT= System product name
+ 0x00040 SYSVERSION= System version
+ 0x00080 SYSSERIAL= System serial number
+ 0x00100 SYSSKU= System SKU
+ 0x00200 SYSFAMILY= System family
+ 0x00400 MBVENDOR= Motherboard vendor name
+ 0x00800 MBVERSION= Motherboard version
+ 0x01000 MBSERIAL= Motherboard serial number
+ 0x02000 MBASSET= Motherboard asset tag
+ 0x04000 BIOSVENDOR= BIOS vendor name
+ 0x08000 BIOSVERSION= BIOS version
+ 0x10000 SYSFF= System form factor
+
+ If these strings contain whitespace they it is replaced with
+ underscores (_).
+
+ The system form factor value is a number defined in the SMBIOS
+ specification, available at http://www.dmtf.org/. As of
+ version 2.7.1 of the specification, the following values are
+ defined:
+
+ 1 Other
+ 2 Unknown
+ 3 Desktop
+ 4 Low profile desktop
+ 5 Pizza box
+ 6 Mini tower
+ 7 Tower
+ 8 Portble
+ 9 Laptop
+ 10 Notebook
+ 11 Handheld
+ 12 Docking station
+ 13 All-in-one
+ 14 Subnotebook
+ 15 Space-saving
+ 16 Lunch box
+ 17 Main server chassis
+ 18 Expansion chassis
+ 19 Subchassis
+ 20 Bus expansion chassis
+ 21 Peripheral chassis
+ 22 RAID chassis
+ 23 Rack mount chasss
+ 24 Sealed-case PC
+ 25 Multi-system chassis
+ 26 Compact PCI
+ 27 Advanced TCI
+ 28 Blade
+ 29 Blade enclosure
+
+SENDCOOKIES bitmask [PXELINUX only]
+
+ When downloading files over http, the SYSAPPEND strings are
+ prepended with _Syslinux_ and sent to the server as cookies.
+ The cookies are URL-encoded; whitespace is *not* replaced with
+ underscores.
+
+ This command limits the cookies send; 0 means no cookies. The
+ default is -1, meaning send all cookies.
+
+ This option is "sticky" and is not automatically reset when
+ loading a new configuration file with the CONFIG command.
LABEL label
KERNEL image
APPEND options...
- IPAPPEND flag_val [PXELINUX only]
+ SYSAPPEND flag_val [5.10+]
+ IPAPPEND flag_val [5.10+ or PXELINUX only]
Indicates that if "label" is entered as the kernel to boot,
Syslinux should instead boot "image", and the specified APPEND
- and IPAPPEND options should be used instead of the ones
+ and SYSAPPEND options should be used instead of the ones
specified in the global section of the file (before the first
LABEL command.) The default for "image" is the same as
"label", and if no APPEND is given the default is to use the
@@ -370,6 +468,9 @@ SERIAL port [[baudrate] flowcontrol]
responsiveness without setting the NOHALT option, but could
potentially cause problems with buggy BIOSes.
+ This option is "sticky" and is not automatically reset when
+ loading a new configuration file with the CONFIG command.
+
NOHALT flag_val
If flag_val is 1, don't halt the processor while idle.
Halting the processor while idle significantly reduces the