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