1This is a brief list of all the files in ./linux/Documentation and what 2they contain. If you add a documentation file, please list it here in 3alphabetical order as well, or risk being hunted down like a rabid dog. 4Note that subdirectories have their own index files too. Please try and 5keep the descriptions small enough to fit on one line. 6 Thanks -- Paul G. 7 800-INDEX 9 - this file. 10ARM-README 11 - information for using Linux on the ARM architecture. 12BUG-HUNTING 13 - brute force method of doing binary search of patches to find bug. 14Changes 15 - list of changes that break older software packages. 16CodingStyle 17 - how the boss likes the C code in the kernel to look. 18Configure.help 19 - text file that is used for help when you run "make config" 20IO-APIC.txt 21 - info on using the enhanced interrupt hardware on SMP boards. 22IO-mapping.txt 23 - how to access I/O mapped memory from within device drivers. 24SMP.txt 25 - notes, and "To Fix" list for multi-processor Linux. (see smp.tex) 26VGA-softcursor.txt 27 - how to change your VGA cursor from a blinking underscore. 28arm/ 29 - directory with info about Linux on the ARM architecture. 30binfmt_misc.txt 31 - info on the kernel support for extra binary formats. 32cdrom/ 33 - directory with information on the CD-ROM drivers that Linux has. 34cpqarray.txt 35 - info on using Compaq's SMART2 Intelligent Disk Array Controllers. 36devices.tex 37 - TeX source listing of all the nodes in /dev/ with major minor #'s 38devices.txt 39 - plain ASCII listing of all the nodes in /dev/ with major minor #'s 40digiboard.txt 41 - info on the Digiboard PC/X{i,e,eve} multiport boards. 42digiepca.txt 43 - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards. 44exception.txt 45 - how Linux v2.2 handles exceptions without verify_area etc. 46fb/ 47 - directory with info on the frame buffer graphics abstraction layer. 48filesystems/ 49 - directory with info on the various filesystems that Linux supports. 50ftape.txt 51 - notes about the floppy tape device driver 52hayes-esp.txt 53 - info on using the Hayes ESP serial driver. 54i386/ 55 - directory with info about Linux on the intel ix86 architecture. 56ide.txt 57 - important info for users of ATA devices (IDE/EIDE disks and CD-ROMS) 58initrd.txt 59 - how to use the RAM disk as an initial/temporary root filesystem. 60ioctl-number.txt 61 - how to implement and register device/driver ioctl calls. 62isdn/ 63 - directory with info on the Linux ISDN support, and supported cards. 64java.txt 65 - info on the in-kernel binary support for Java(tm) 66joystick.txt 67 - info on using joystick devices (and driver) with Linux. 68joystick-api.txt 69 - API specification for applications that will be using the joystick. 70joystick-parport.txt 71 - info on how to hook joysticks/gamepads to the parallel port. 72kbuild/ 73 - directory with info about the kernel build process 74kernel-docs.txt 75 - listing of various WWW + books that document kernel internals. 76kernel-parameters.txt 77 - summary listing of command line / boot prompt args for the kernel. 78kmod.txt 79 - info on the kernel module loader/unloader (kerneld replacement). 80locks.txt 81 - info on file locking implementations, flock() vs. fcntl(), etc. 82logo.gif 83 - Full colour GIF image of Linux logo (penguin) 84logo.txt 85 - Info on creator of above logo & site to get additional images from. 86m68k/ 87 - directory with info about Linux on Motorola 68k architecture. 88magic-number.txt 89 - list of magic numbers used to mark/protect kernel data structures. 90mandatory.txt 91 - info on the Linux implementation of Sys V mandatory file locking. 92mca.txt 93 - info on supporting Micro Channel Architecture (e.g. PS/2) systems. 94md.txt 95 - info on boot arguments for the multiple devices driver 96memory.txt 97 - info on typical Linux memory problems. 98mkdev.ida 99 - script to make /dev entries for Intelligent Disk Array Controllers. 100modules.txt 101 - short guide on how to make kernel parts into loadable modules 102mtrr.txt 103 - how to use PPro Memory Type Range Registers to increase performance 104nbd.txt 105 - info on a TCP implementation of a network block device. 106networking/ 107 - directory with info on various aspects of networking with Linux. 108nfsroot.txt 109 - short guide on setting up a diskless box with NFS root filesystem 110oops-tracing.txt 111 - how to decode those nasty internal kernel error dump messages. 112paride.txt 113 - information about the parallel port IDE subsystem. 114parport.txt 115 - how to use the parallel-port driver. 116pci.txt 117 - info on the PCI subsystem for device driver authors 118pcwd-watchdog.txt 119 - info and sample code for using with the PC Watchdog reset card. 120powerpc/ 121 - directory with info on using Linux with the PowerPC. 122proc.txt 123 - detailed info on Linux's /proc filesystem. 124ramdisk.txt 125 - short guide on how to set up and use the RAM disk. 126riscom8.txt 127 - notes on using the RISCom/8 multi-port serial driver. 128rtc.txt 129 - notes on how to use the Real Time Clock (aka CMOS clock) driver. 130scsi-generic.txt 131 - info on the sg driver for generic (non-disk/CD/tape) SCSI devices. 132scsi.txt 133 - short blurb on using SCSI support as a module. 134serial-console.txt 135 - how to set up Linux with a serial line console as the default. 136sgi-visws.txt 137 - short blurb on the SGI Visual Workstations. 138smart-config.txt 139 - description of the Smart Config makefile feature. 140smp.tex 141 - TeX document describing implementation of Multiprocessor Linux 142smp.txt 143 - a few more notes on symmetric multi-processing 144sound/ 145 - directory with info on sound card support 146specialix.txt 147 - info on hardware/driver for specialix IO8+ multiport serial card. 148spinlocks.txt 149 - info on using spinlocks to provide exclusive access in kernel. 150stallion.txt 151 - info on using the Stallion multiport serial driver. 152svga.txt 153 - short guide on selecting video modes at boot via VGA BIOS. 154sx.txt 155 - info on the Specialix SX/SI multiport serial driver. 156sysctl/ 157 - directory with info on the /proc/sys/* files 158sysrq.txt 159 - info on the magic SysRq key 160transname.txt 161 - how to use name translation to ease use of diskless systems. 162unicode.txt 163 - info on the Unicode character/font mapping used in Linux. 164video4linux/ 165 - directory with info regarding video/TV/radio cards and linux. 166watchdog.txt 167 - how to auto-reboot Linux if it has "fallen and can't get up". ;-) 168xterm-linux.xpm 169 - XPM image of penguin logo (see logo.txt) sitting on an xterm. 170 171 172