path: root/Documentation/00-INDEX

This is a brief list of all the files in ./linux/Documentation and what
they contain. If you add a documentation file, please list it here in 
alphabetical order as well, or risk being hunted down like a rabid dog. 
Note that subdirectories have their own index files too. Please try and
keep the descriptions small enough to fit on one line.
							 Thanks -- Paul G.

00-INDEX
	- this file.
ARM-README
	- information for using Linux on the ARM architecture.
BUG-HUNTING
	- brute force method of doing binary search of patches to find bug.
Changes
	- list of changes that break older software packages.
CodingStyle
	- how the boss likes the C code in the kernel to look.
Configure.help
	- text file that is used for help when you run "make config"
IO-APIC.txt
	- info on using the enhanced interrupt hardware on SMP boards.
IO-mapping.txt
	- how to access I/O mapped memory from within device drivers.
SMP.txt
	- notes, and "To Fix" list for multi-processor Linux. (see smp.tex)
VGA-softcursor.txt
	- how to change your VGA cursor from a blinking underscore.
arm/
	- directory with info about Linux on the ARM architecture.
binfmt_misc.txt
	- info on the kernel support for extra binary formats.
cdrom/
	- directory with information on the CD-ROM drivers that Linux has.
cpqarray.txt
	- info on using Compaq's SMART2 Intelligent Disk Array Controllers.
devices.tex
	- LaTeX source listing of all the nodes in /dev/ with major minor #'s
devices.txt
	- plain ASCII listing of all the nodes in /dev/ with major minor #'s
digiboard.txt
	- info on the Digiboard PC/X{i,e,eve} multiport boards.
digiepca.txt
	- info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
exception.txt
	- how Linux v2.2 handles exceptions without verify_area etc.
fb/
	- directory with info on the frame buffer graphics abstraction layer.
filesystems/
	- directory with info on the various filesystems that Linux supports.
ftape.txt
	- notes about the floppy tape device driver
hayes-esp.txt
	- info on using the Hayes ESP serial driver.
i386/
	- directory with info about Linux on the intel ix86 architecture.
ide.txt
	- important info for users of ATA devices (IDE/EIDE disks and CD-ROMS)
initrd.txt
	- how to use the RAM disk as an initial/temporary root filesystem.
ioctl-number.txt
	- how to implement and register device/driver ioctl calls.
isdn/
	- directory with info on the Linux ISDN support, and supported cards.
java.txt
	- info on the in-kernel binary support for Java(tm)
joystick.txt
	- info on using joystick devices (and driver) with Linux.
joystick-api.txt
	- API specification for applications that will be using the joystick.
joystick-parport.txt 
	- info on how to hook joysticks/gamepads to the parallel port.
kbuild/
	- directory with info about the kernel build process
kernel-docs.txt
	- listing of various WWW + books that document kernel internals.
kernel-parameters.txt
	- summary listing of command line / boot prompt args for the kernel.
kmod.txt
	- info on the kernel module loader/unloader (kerneld replacement).
locks.txt
	- info on file locking implementations, flock() vs. fcntl(), etc.
logo.gif
	- Full colour GIF image of Linux logo (penguin)
logo.txt
	- Info on creator of above logo & site to get additional images from.
m68k/
	- directory with info about Linux on Motorola 68k architecture.
magic-number.txt
	- list of magic numbers used to mark/protect kernel data structures.
mandatory.txt
	- info on the Linux implementation of Sys V mandatory file locking.
mca.txt
	- info on supporting Micro Channel Architecture (e.g. PS/2) systems.
md.txt
	- info on boot arguments for the multiple devices driver
memory.txt
	- info on typical Linux memory problems.
mkdev.ida
	- script to make /dev entries for Intelligent Disk Array Controllers.
modules.txt
	- short guide on how to make kernel parts into loadable modules
mtrr.txt
	- how to use PPro Memory Type Range Registers to increase performance
nbd.txt
	- info on a TCP implementation of a network block device.
networking/
	- directory with info on various aspects of networking with Linux.
nfsroot.txt
	- short guide on setting up a diskless box with NFS root filesystem
oops-tracing.txt
	- how to decode those nasty internal kernel error dump messages.
paride.txt
	- information about the parallel port IDE subsystem.
parport.txt
	- how to use the parallel-port driver.
pci.txt
	- info on the PCI subsystem for device driver authors
pcwd-watchdog.txt
	- info and sample code for using with the PC Watchdog reset card.
powerpc/
	- directory with info on using Linux with the PowerPC.
proc.txt
	- detailed info on Linux's /proc filesystem.
ramdisk.txt
	- short guide on how to set up and use the RAM disk.
riscom8.txt
	- notes on using the RISCom/8 multi-port serial driver.
rtc.txt
	- notes on how to use the Real Time Clock (aka CMOS clock) driver.
scsi-generic.txt
	- info on the sg driver for generic (non-disk/CD/tape) SCSI devices.
scsi.txt
	- short blurb on using SCSI support as a module.
serial-console.txt
	- how to set up Linux with a serial line console as the default.
sgi-visws.txt
	- short blurb on the SGI Visual Workstations.
smart-config.txt
	- description of the Smart Config makefile feature.
smp.tex
	- LaTeX document describing implementation of Multiprocessor Linux
smp.txt
	- a few more notes on symmetric multi-processing
sound/
	- directory with info on sound card support
specialix.txt
	- info on hardware/driver for specialix IO8+ multiport serial card.
spinlocks.txt
	- info on using spinlocks to provide exclusive access in kernel.
stallion.txt
	- info on using the Stallion multiport serial driver.
svga.txt
	- short guide on selecting video modes at boot via VGA BIOS.
sx.txt
	- info on the Specialix SX/SI multiport serial driver.
sysctl/
	- directory with info on the /proc/sys/* files
sysrq.txt
	- info on the magic SysRq key
transname.txt
	- how to use name translation to ease use of diskless systems.
unicode.txt
	- info on the Unicode character/font mapping used in Linux.
video4linux/
	- directory with info regarding video/TV/radio cards and linux.
watchdog.txt
	- how to auto-reboot Linux if it has "fallen and can't get up". ;-)
xterm-linux.xpm
	- XPM image of penguin logo (see logo.txt) sitting on an xterm.