From be4cdf334ddc9bdf71e92b8a0f16a910ded7ae28 Mon Sep 17 00:00:00 2001 From: "H. Peter Anvin" Date: Fri, 29 Feb 2008 12:02:36 -0800 Subject: [PATCH] Document the file renaming from .doc -> .txt --- NEWS | 3 ++- README | 20 ++++++++++---------- doc/comboot.txt | 4 ++-- doc/isolinux.txt | 2 +- doc/pxelinux.txt | 6 +++--- doc/syslinux.doc | 16 ++++++++-------- 6 files changed, 26 insertions(+), 25 deletions(-) diff --git a/NEWS b/NEWS index d57ca1f..d21fe77 100644 --- a/NEWS +++ b/NEWS @@ -17,12 +17,13 @@ Changes in 3.62: low memory. * Get rid of 4096-entry limit in the simple menu system. * New hierarchial submenu support: see MENU BEGIN, MENU END, - MENU GOTO in doc/menu.doc. + MENU GOTO in doc/menu.txt. * MENU QUIT allows creating a menu entry for returning to the command line. * ISOLINUX: Work around bug in certain Adaptec BIOSes, patch by Bruce Robson. * pngtopnm dependency removed from samples/ directory. + * Text documentation files (in doc/) renamed *.doc -> *.txt. Changes in 3.61: * EXTLINUX: fix crash when accessing an empty file. diff --git a/README b/README index 72c5611..0e92ea2 100644 --- a/README +++ b/README @@ -1,14 +1,14 @@ See the files in the doc directory for documentation about SYSLINUX: - syslinux.doc - Usage instructions; manual. - distrib.doc - For creators of Linux distributions. - pxelinux.doc - Documentation specific to PXELINUX. - isolinux.doc - Documentation specific to ISOLINUX. - extlinux.doc - Documentation specific to EXTLINUX. - menu.doc - About the menu systems. - usbkey.doc - About using SYSLINUX on USB keys. - comboot.doc - About the extension API. - memdisk.doc - Documentation about MEMDISK. + syslinux.txt - Usage instructions; manual. + distrib.txt - For creators of Linux distributions. + pxelinux.txt - Documentation specific to PXELINUX. + isolinux.txt - Documentation specific to ISOLINUX. + extlinux.txt - Documentation specific to EXTLINUX. + menu.txt - About the menu systems. + usbkey.txt - About using SYSLINUX on USB keys. + comboot.txt - About the extension API. + memdisk.txt - Documentation about MEMDISK. Also see the files: @@ -20,7 +20,7 @@ SYSLINUX now builds in a Linux environment, using nasm. You need nasm version 0.98.39 or later to build SYSLINUX from source. See http://nasm.sf.net/ for information about nasm. -There is now a mailing list for SYSLINUX. See the end of syslinux.doc +There is now a mailing list for SYSLINUX. See the end of syslinux.txt for details. SYSLINUX is: diff --git a/doc/comboot.txt b/doc/comboot.txt index 46afc64..c4b0f07 100644 --- a/doc/comboot.txt +++ b/doc/comboot.txt @@ -452,7 +452,7 @@ AX=000Bh [2.00] Get Serial Console Configuration Input: AX 000Bh Output: DX serial port I/O base (e.g. 3F8h = COM1...) CX baud rate divisor (1 = 115200 bps, 2 = 57600 bps...) - BX flow control configuration bits (see syslinux.doc) + BX flow control configuration bits (see syslinux.txt) -> bit 15 is set if the video console is disabled If no serial port is configured, DX will be set to 0 and the @@ -647,7 +647,7 @@ AX=0014h [3.10] Local boot [PXELINUX, ISOLINUX] configuration file option. The parameter in DX is the same parameter as would be entered after "localboot" in the configuration file; this parameter is derivative-specific -- - see syslinux.doc for the definition. + see syslinux.txt for the definition. AX=0015h [3.10] Get feature flags diff --git a/doc/isolinux.txt b/doc/isolinux.txt index 630ce1d..95d24a3 100644 --- a/doc/isolinux.txt +++ b/doc/isolinux.txt @@ -26,7 +26,7 @@ well (not tested.) To create an image, create a directory called "isolinux" (or, if you prefer, "boot/isolinux") underneath the root directory of your ISO image master file tree. Copy isolinux.bin, a config file called -"isolinux.cfg" (see syslinux.doc for details on the configuration +"isolinux.cfg" (see syslinux.txt for details on the configuration file), and all necessary files (kernels, initrd, display files, etc.) into this directory, then use the following command to create your ISO image (add additional options as appropriate, such as -J or -R): diff --git a/doc/pxelinux.txt b/doc/pxelinux.txt index e8c1ed0..6658fa5 100644 --- a/doc/pxelinux.txt +++ b/doc/pxelinux.txt @@ -23,7 +23,7 @@ PROM for many network cards. ++++ HOW TO CONFIGURE PXELINUX ++++ PXELINUX operates in many ways like SYSLINUX. If you are not familiar -with SYSLINUX, read syslinux.doc first, since this documentation only +with SYSLINUX, read syslinux.txt first, since this documentation only explains the differences. On the TFTP server, create the directory "/tftpboot", and copy the @@ -34,7 +34,7 @@ following files to it: any kernel or initrd images you want to boot Finally, create the directory "/tftpboot/pxelinux.cfg". The -configuration file (equivalent of syslinux.cfg -- see syslinux.doc for +configuration file (equivalent of syslinux.cfg -- see syslinux.txt for the options here) will live in this directory. Because more than one system may be booted from the same server, the configuration file name depends on the IP address of the booting machine. PXELINUX will @@ -413,4 +413,4 @@ The following problems are known with PXELINUX, so far: + Boot sectors/disk images are not supported yet. If you have additional problems, please contact the SYSLINUX mailing -list (see syslinux.doc for the address.) +list (see syslinux.txt for the address.) diff --git a/doc/syslinux.doc b/doc/syslinux.doc index 14efacb..dc82f2a 100644 --- a/doc/syslinux.doc +++ b/doc/syslinux.doc @@ -24,8 +24,8 @@ The SYSLINUX suite contains the following boot loaders EXTLINUX - Linux ext2/ext3 filesystem For historical reasons, some of the sections in this document applies -to the FAT loader only; see pxelinux.doc, isolinux.doc and -extlinux.doc for what differs in these versions. +to the FAT loader only; see pxelinux.txt, isolinux.txt and +extlinux.txt for what differs in these versions. Help with cleaning up the docs would be greatly appreciated. @@ -118,7 +118,7 @@ relative to that same directory, unless preceded with a slash or backslash. All options here applies to PXELINUX, ISOLINUX and EXTLINUX as well as -SYSLINUX unless otherwise noted. See the respective .doc files. +SYSLINUX unless otherwise noted. See the respective .txt files. # comment A comment line. The whitespace after the hash mark is mandatory. @@ -173,7 +173,7 @@ IPAPPEND flag_val [PXELINUX only] BOOTIF= ... in dash-separated hexadecimal with leading hardware type - (same as for the configuration file; see pxelinux.doc.) + (same as for the configuration file; see pxelinux.txt.) This allows an initrd program to determine from which interface the system booted. @@ -371,7 +371,7 @@ KBDMAP keymap used heavily on the Linux kernel command line.) The included program keytab-lilo.pl from the LILO distribution - can be used to create such keymaps. The file keytab-lilo.doc + can be used to create such keymaps. The file keytab-lilo.txt contains the documentation for this program. DISPLAY filename @@ -553,7 +553,7 @@ considered to be the one specified regardless of the filename. ++++ BOOTING DOS (OR OTHER SIMILAR OPERATING SYSTEMS) ++++ This section applies to SYSLINUX only, not to PXELINUX or ISOLINUX. -See isolinux.doc for an equivalent procedure for ISOLINUX. +See isolinux.txt for an equivalent procedure for ISOLINUX. This is the recommended procedure for creating a SYSLINUX disk that can boot either DOS or Linux. This example assumes the drive is A: in @@ -633,7 +633,7 @@ similar to DOS ".com" files. A 32-bit version, called COM32, is also provided. A simple API provides access to a limited set of filesystem and console functions. -See the file comboot.doc for more information on COMBOOT and COM32 +See the file comboot.txt for more information on COMBOOT and COM32 programs. @@ -665,7 +665,7 @@ that is bootable on the largest possible number of machines: A CD-ROM is so much faster than a floppy that the -s option shouldn't matter from a speed perspective. -Of course, you probably want to use ISOLINUX instead. See isolinux.doc. +Of course, you probably want to use ISOLINUX instead. See isolinux.txt. ++++ BOOTING FROM A FAT FILESYSTEM PARTITION ON A HARD DISK ++++ -- 2.7.4