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