kernel/linux/Documentation/00-INDEX

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