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. 15BUG-HUNTING 16 - brute force method of doing binary search of patches to find bug. 17Changes 18 - list of changes that break older software packages. 19CodingStyle 20 - how the boss likes the C code in the kernel to look. 21Configure.help 22 - text file that is used for help when you run "make config" 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. 31LVM-HOWTO 32 - info on setting up logical volume management (virtual disks etc.) 33README.DAC960 34 - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux 35README.moxa 36 - release notes for Moxa mutiport serial card. 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. 47cachetlb.txt 48 - describes the cache/TLB flushing interfaces Linux uses. 49cciss.txt 50 - info, major/minor #'s for Compaq's SMART Array Controllers. 51cdrom/ 52 - directory with information on the CD-ROM drivers that Linux has. 53computone.txt 54 - info on Computone Intelliport II/Plus Multiport Serial Driver 55cpqarray.txt 56 - info on using Compaq's SMART2 Intelligent Disk Array Controllers. 57devices.txt 58 - plain ASCII listing of all the nodes in /dev/ with major minor #'s 59digiboard.txt 60 - info on the Digiboard PC/X{i,e,eve} multiport boards. 61digiepca.txt 62 - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards. 63dnotify.txt 64 - info about directory notification in Linux. 65exception.txt 66 - how Linux v2.2 handles exceptions without verify_area etc. 67fb/ 68 - directory with info on the frame buffer graphics abstraction layer. 69filesystems/ 70 - directory with info on the various filesystems that Linux supports. 71floppy.txt 72 - notes and driver options for the floppy disk driver. 73ftape.txt 74 - notes about the floppy tape device driver 75hayes-esp.txt 76 - info on using the Hayes ESP serial driver. 77highuid.txt 78 - notes on the change from 16 bit to 32 bit user/group IDs. 79i2c/ 80 - directory with info about the I2C bus/protocol (2 wire, kHz speed) 81i386/ 82 - directory with info about Linux on intel 32 bit architecture. 83ia64/ 84 - directory with info about Linux on intel 64 bit architecture. 85ide.txt 86 - important info for users of ATA devices (IDE/EIDE disks and CD-ROMS) 87initrd.txt 88 - how to use the RAM disk as an initial/temporary root filesystem. 89ioctl-number.txt 90 - how to implement and register device/driver ioctl calls. 91isapnp.txt 92 - info on Linux ISA Plug & Play support 93isdn/ 94 - directory with info on the Linux ISDN support, and supported cards. 95java.txt 96 - info on the in-kernel binary support for Java(tm) 97joystick-api.txt 98 - API specification for applications that will be using the joystick. 99joystick-parport.txt 100 - info on how to hook joysticks/gamepads to the parallel port. 101joystick.txt 102 - info on using joystick devices (and driver) with Linux. 103kbuild/ 104 - directory with info about the kernel build process 105kernel-doc-nano-HOWTO.txt 106 - mini HowTo on generation and location of kernel documentation files. 107kernel-docs.txt 108 - listing of various WWW + books that document kernel internals. 109kernel-parameters.txt 110 - summary listing of command line / boot prompt args for the kernel. 111kmod.txt 112 - info on the kernel module loader/unloader (kerneld replacement). 113locks.txt 114 - info on file locking implementations, flock() vs. fcntl(), etc. 115logo.gif 116 - Full colour GIF image of Linux logo (penguin) 117logo.txt 118 - Info on creator of above logo & site to get additional images from. 119m68k/ 120 - directory with info about Linux on Motorola 68k architecture. 121magic-number.txt 122 - list of magic numbers used to mark/protect kernel data structures. 123mandatory.txt 124 - info on the Linux implementation of Sys V mandatory file locking. 125mca.txt 126 - info on supporting Micro Channel Architecture (e.g. PS/2) systems. 127md.txt 128 - info on boot arguments for the multiple devices driver 129memory.txt 130 - info on typical Linux memory problems. 131mkdev.cciss 132 - script to make /dev entries for SMART controllers (see cciss.txt) 133mkdev.ida 134 - script to make /dev entries for Intelligent Disk Array Controllers. 135modules.txt 136 - short guide on how to make kernel parts into loadable modules 137moxa-smartio 138 - info on installing/using Moxa multiport serial driver. 139mtrr.txt 140 - how to use PPro Memory Type Range Registers to increase performance 141nbd.txt 142 - info on a TCP implementation of a network block device. 143networking/ 144 - directory with info on various aspects of networking with Linux. 145nfsroot.txt 146 - short guide on setting up a diskless box with NFS root filesystem 147nmi_watchdog.txt 148 - info on NMI watchdog for SMP systems 149oops-tracing.txt 150 - how to decode those nasty internal kernel error dump messages. 151paride.txt 152 - information about the parallel port IDE subsystem. 153parisc/ 154 - directory with info on using Linux on PA-RISC architecture. 155parport.txt 156 - how to use the parallel-port driver. 157parport-lowlevel.txt 158 - description and usage of the low level parallel port functions. 159pci.txt 160 - info on the PCI subsystem for device driver authors 161pcwd-watchdog.txt 162 - info and sample code for using with the PC Watchdog reset card. 163pm.txt 164 - info on Linux power management support 165powerpc/ 166 - directory with info on using Linux with the PowerPC. 167ramdisk.txt 168 - short guide on how to set up and use the RAM disk. 169riscom8.txt 170 - notes on using the RISCom/8 multi-port serial driver. 171rtc.txt 172 - notes on how to use the Real Time Clock (aka CMOS clock) driver. 173s390/ 174 - directory with info on using Linux on the IBM S390. 175scsi-generic.txt 176 - info on the sg driver for generic (non-disk/CD/tape) SCSI devices. 177scsi.txt 178 - short blurb on using SCSI support as a module. 179serial-console.txt 180 - how to set up Linux with a serial line console as the default. 181sgi-visws.txt 182 - short blurb on the SGI Visual Workstations. 183smart-config.txt 184 - description of the Smart Config makefile feature. 185smp.tex 186 - LaTeX document describing implementation of Multiprocessor Linux 187smp.txt 188 - a few more notes on symmetric multi-processing 189sound/ 190 - directory with info on sound card support 191sparc/ 192 - directory with info on using Linux on Sparc architecture. 193specialix.txt 194 - info on hardware/driver for specialix IO8+ multiport serial card. 195spinlocks.txt 196 - info on using spinlocks to provide exclusive access in kernel. 197stallion.txt 198 - info on using the Stallion multiport serial driver. 199svga.txt 200 - short guide on selecting video modes at boot via VGA BIOS. 201sx.txt 202 - info on the Specialix SX/SI multiport serial driver. 203sysctl/ 204 - directory with info on the /proc/sys/* files 205sysrq.txt 206 - info on the magic SysRq key 207telephony/ 208 - directory with info on telephony (e.g. voice over IP) support. 209unicode.txt 210 - info on the Unicode character/font mapping used in Linux. 211usb/ 212 - directory with info regarding the Universal Serial Bus. 213video4linux/ 214 - directory with info regarding video/TV/radio cards and linux. 215vm/ 216 - directory with info on the Linux vm code. 217watchdog.txt 218 - how to auto-reboot Linux if it has "fallen and can't get up". ;-) 219xterm-linux.xpm 220 - XPM image of penguin logo (see logo.txt) sitting on an xterm. 221zorro.txt 222 - info on writing drivers for Zorro bus devices found on Amigas. 223 224