1 2This is a brief list of all the files in ./linux/Documentation and what 3they contain. If you add a documentation file, please list it here in 4alphabetical order as well, or risk being hunted down like a rabid dog. 5Please try and keep the descriptions small enough to fit on one line. 6 Thanks -- Paul G. 7 8Following translations are available on the WWW: 9 10 - Japanese, maintained by the JF Project (JF@linux.or.jp), at 11 http://www.linux.or.jp/JF/ 12 1300-INDEX 14 - this file. 15BK-usage/ 16 - directory with info on BitKeeper. 17BUG-HUNTING 18 - brute force method of doing binary search of patches to find bug. 19Changes 20 - list of changes that break older software packages. 21CodingStyle 22 - how the boss likes the C code in the kernel to look. 23DMA-mapping.txt 24 - info for PCI drivers using DMA portably across all platforms. 25DocBook/ 26 - directory with DocBook templates etc. for kernel documentation. 27IO-mapping.txt 28 - how to access I/O mapped memory from within device drivers. 29IRQ-affinity.txt 30 - how to select which CPU(s) handle which interrupt events on SMP. 31README.DAC960 32 - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux 33README.moxa 34 - release notes for Moxa mutiport serial card. 35SAK.txt 36 - info on Secure Attention Keys. 37SubmittingDrivers 38 - procedure to get a new driver source included into the kernel tree. 39SubmittingPatches 40 - procedure to get a source patch included into the kernel tree. 41VGA-softcursor.txt 42 - how to change your VGA cursor from a blinking underscore. 43arm/ 44 - directory with info about Linux on the ARM architecture. 45binfmt_misc.txt 46 - info on the kernel support for extra binary formats. 47block/ 48 - info on the Block I/O (BIO) layer. 49cachetlb.txt 50 - describes the cache/TLB flushing interfaces Linux uses. 51cciss.txt 52 - info, major/minor #'s for Compaq's SMART Array Controllers. 53cdrom/ 54 - directory with information on the CD-ROM drivers that Linux has. 55computone.txt 56 - info on Computone Intelliport II/Plus Multiport Serial Driver 57cpqarray.txt 58 - info on using Compaq's SMART2 Intelligent Disk Array Controllers. 59cpufreq/ 60 - info on CPU frequency and voltage scaling 61cris/ 62 - directory with info about Linux on CRIS architecture. 63devices.txt 64 - plain ASCII listing of all the nodes in /dev/ with major minor #'s 65digiboard.txt 66 - info on the Digiboard PC/X{i,e,eve} multiport boards. 67digiepca.txt 68 - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards. 69dnotify.txt 70 - info about directory notification in Linux. 71driver-model.txt 72 - info about Linux driver model. 73early-userspace/ 74 - info about initramfs, klibc, and userspace early during boot. 75exception.txt 76 - how Linux v2.2 handles exceptions without verify_area etc. 77fb/ 78 - directory with info on the frame buffer graphics abstraction layer. 79filesystems/ 80 - directory with info on the various filesystems that Linux supports. 81floppy.txt 82 - notes and driver options for the floppy disk driver. 83ftape.txt 84 - notes about the floppy tape device driver 85hayes-esp.txt 86 - info on using the Hayes ESP serial driver. 87highuid.txt 88 - notes on the change from 16 bit to 32 bit user/group IDs. 89i2c/ 90 - directory with info about the I2C bus/protocol (2 wire, kHz speed) 91i386/ 92 - directory with info about Linux on intel 32 bit architecture. 93i810_rng.txt 94 - info on Linux support for random number generator in i8xx chipsets. 95ia64/ 96 - directory with info about Linux on intel 64 bit architecture. 97ide.txt 98 - important info for users of ATA devices (IDE/EIDE disks and CD-ROMS) 99initrd.txt 100 - how to use the RAM disk as an initial/temporary root filesystem. 101input/ 102 - info on Linux input device support. 103ioctl-number.txt 104 - how to implement and register device/driver ioctl calls. 105isapnp.txt 106 - info on Linux ISA Plug & Play support 107isdn/ 108 - directory with info on the Linux ISDN support, and supported cards. 109java.txt 110 - info on the in-kernel binary support for Java(tm) 111kbuild/ 112 - directory with info about the kernel build process 113kernel-doc-nano-HOWTO.txt 114 - mini HowTo on generation and location of kernel documentation files. 115kernel-docs.txt 116 - listing of various WWW + books that document kernel internals. 117kernel-parameters.txt 118 - summary listing of command line / boot prompt args for the kernel. 119ldm.txt 120 - a brief description of LDM (Windows Dynamic Disks). 121locks.txt 122 - info on file locking implementations, flock() vs. fcntl(), etc. 123logo.gif 124 - Full colour GIF image of Linux logo (penguin) 125logo.txt 126 - Info on creator of above logo & site to get additional images from. 127m68k/ 128 - directory with info about Linux on Motorola 68k architecture. 129magic-number.txt 130 - list of magic numbers used to mark/protect kernel data structures. 131mandatory.txt 132 - info on the Linux implementation of Sys V mandatory file locking. 133mca.txt 134 - info on supporting Micro Channel Architecture (e.g. PS/2) systems. 135md.txt 136 - info on boot arguments for the multiple devices driver 137memory.txt 138 - info on typical Linux memory problems. 139mips/ 140 - directory with info about Linux on MIPS architecture. 141mkdev.cciss 142 - script to make /dev entries for SMART controllers (see cciss.txt) 143mkdev.ida 144 - script to make /dev entries for Intelligent Disk Array Controllers. 145moxa-smartio 146 - info on installing/using Moxa multiport serial driver. 147mtrr.txt 148 - how to use PPro Memory Type Range Registers to increase performance 149nbd.txt 150 - info on a TCP implementation of a network block device. 151networking/ 152 - directory with info on various aspects of networking with Linux. 153nfsroot.txt 154 - short guide on setting up a diskless box with NFS root filesystem 155nmi_watchdog.txt 156 - info on NMI watchdog for SMP systems 157oops-tracing.txt 158 - how to decode those nasty internal kernel error dump messages. 159paride.txt 160 - information about the parallel port IDE subsystem. 161parisc/ 162 - directory with info on using Linux on PA-RISC architecture. 163parport.txt 164 - how to use the parallel-port driver. 165parport-lowlevel.txt 166 - description and usage of the low level parallel port functions. 167pci.txt 168 - info on the PCI subsystem for device driver authors 169pcwd-watchdog.txt 170 - info and sample code for using with the PC Watchdog reset card. 171pm.txt 172 - info on Linux power management support. 173power/ 174 - directory with info on Linux PCI power management. 175powerpc/ 176 - directory with info on using Linux with the PowerPC. 177preempt-locking.txt 178 - info on locking under a preemptive kernel. 179ramdisk.txt 180 - short guide on how to set up and use the RAM disk. 181riscom8.txt 182 - notes on using the RISCom/8 multi-port serial driver. 183rocket.txt 184 - info on installing/using the Comtrol RocketPort multiport serial driver 185rtc.txt 186 - notes on how to use the Real Time Clock (aka CMOS clock) driver. 187s390/ 188 - directory with info on using Linux on the IBM S390. 189sh/ 190 - directory with info on porting Linux to a new architecture. 191scsi/ 192 - directory with info on Linux scsi support. 193serial-console.txt 194 - how to set up Linux with a serial line console as the default. 195sgi-visws.txt 196 - short blurb on the SGI Visual Workstations. 197smart-config.txt 198 - description of the Smart Config makefile feature. 199smp.tex 200 - LaTeX document describing implementation of Multiprocessor Linux 201smp.txt 202 - a few more notes on symmetric multi-processing 203sonypi.txt 204 - info on Linux Sony Programmable I/O Device support. 205sound/ 206 - directory with info on sound card support 207sparc/ 208 - directory with info on using Linux on Sparc architecture. 209specialix.txt 210 - info on hardware/driver for specialix IO8+ multiport serial card. 211spinlocks.txt 212 - info on using spinlocks to provide exclusive access in kernel. 213stallion.txt 214 - info on using the Stallion multiport serial driver. 215svga.txt 216 - short guide on selecting video modes at boot via VGA BIOS. 217sx.txt 218 - info on the Specialix SX/SI multiport serial driver. 219sysctl/ 220 - directory with info on the /proc/sys/* files 221sysrq.txt 222 - info on the magic SysRq key 223telephony/ 224 - directory with info on telephony (e.g. voice over IP) support. 225unicode.txt 226 - info on the Unicode character/font mapping used in Linux. 227usb/ 228 - directory with info regarding the Universal Serial Bus. 229video4linux/ 230 - directory with info regarding video/TV/radio cards and linux. 231vm/ 232 - directory with info on the Linux vm code. 233watchdog.txt 234 - how to auto-reboot Linux if it has "fallen and can't get up". ;-) 235x86_64/ 236 - directory with info on Linux support for AMD x86-64 (Hammer) machines. 237xterm-linux.xpm 238 - XPM image of penguin logo (see logo.txt) sitting on an xterm. 239zorro.txt 240 - info on writing drivers for Zorro bus devices found on Amigas. 241 242