Documentation/00-INDEX

   1 This is a brief list of all the files in ./linux/Documentation and what
   2 they contain. If you add a documentation file, please list it here in
   3 alphabetical order as well, or risk being hunted down like a rabid dog.
   4 Note that subdirectories have their own index files too. Please try and
   5 keep the descriptions small enough to fit on one line.
   6                                                          Thanks -- Paul G.
   7
   8 00-INDEX
   9         - this file.
  10 BUG-HUNTING
  11         - brute force method of doing binary search of patches to find bug.
  12 Changes
  13         - list of changes that break older software packages.
  14 CodingStyle
  15         - how the boss likes the C code in the kernel to look.
  16 Configure.help
  17         - text file that is used for help when you run "make config"
  18 IO-APIC.txt
  19         - info on using the enhanced interrupt hardware on SMP boards.
  20 IO-mapping.txt
  21         - how to access I/O mapped memory from within device drivers.
  22 README.DAC960
  23         - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux
  24 VGA-softcursor.txt
  25         - how to change your VGA cursor from a blinking underscore.
  26 arm/
  27         - directory with info about Linux on the ARM architecture.
  28 atm.txt
  29         - info on Linux ATM support
  30 binfmt_misc.txt
  31         - info on the kernel support for extra binary formats.
  32 cdrom/
  33         - directory with information on the CD-ROM drivers that Linux has.
  34 computone.txt
  35         - info on Computone Intelliport II/Plus Multiport Serial Driver
  36 cpqarray.txt
  37         - info on using Compaq's SMART2 Intelligent Disk Array Controllers.
  38 devices.tex
  39         - LaTeX source listing of all the nodes in /dev/ with major minor #'s
  40 devices.txt
  41         - plain ASCII listing of all the nodes in /dev/ with major minor #'s
  42 digiboard.txt
  43         - info on the Digiboard PC/X{i,e,eve} multiport boards.
  44 digiepca.txt
  45         - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
  46 dnotify.txt
  47         - info about directory notification in Linux.
  48 exception.txt
  49         - how Linux v2.2 handles exceptions without verify_area etc.
  50 fb/
  51         - directory with info on the frame buffer graphics abstraction layer.
  52 filesystems/
  53         - directory with info on the various filesystems that Linux supports.
  54 ftape.txt
  55         - notes about the floppy tape device driver
  56 hayes-esp.txt
  57         - info on using the Hayes ESP serial driver.
  58 i386/
  59         - directory with info about Linux on the intel ix86 architecture.
  60 ide.txt
  61         - important info for users of ATA devices (IDE/EIDE disks and CD-ROMS)
  62 initrd.txt
  63         - how to use the RAM disk as an initial/temporary root filesystem.
  64 ioctl-number.txt
  65         - how to implement and register device/driver ioctl calls.
  66 isapnp.txt
  67         - info on Linux ISA Plug & Play support
  68 isdn/
  69         - directory with info on the Linux ISDN support, and supported cards.
  70 java.txt
  71         - info on the in-kernel binary support for Java(tm)
  72 joystick-api.txt
  73         - API specification for applications that will be using the joystick.
  74 joystick-parport.txt
  75         - info on how to hook joysticks/gamepads to the parallel port.
  76 joystick.txt
  77         - info on using joystick devices (and driver) with Linux.
  78 kbuild/
  79         - directory with info about the kernel build process
  80 kernel-docs.txt
  81         - listing of various WWW + books that document kernel internals.
  82 kernel-parameters.txt
  83         - summary listing of command line / boot prompt args for the kernel.
  84 kmod.txt
  85         - info on the kernel module loader/unloader (kerneld replacement).
  86 locks.txt
  87         - info on file locking implementations, flock() vs. fcntl(), etc.
  88 logo.gif
  89         - Full colour GIF image of Linux logo (penguin)
  90 logo.txt
  91         - Info on creator of above logo & site to get additional images from.
  92 m68k/
  93         - directory with info about Linux on Motorola 68k architecture.
  94 magic-number.txt
  95         - list of magic numbers used to mark/protect kernel data structures.
  96 mandatory.txt
  97         - info on the Linux implementation of Sys V mandatory file locking.
  98 mca.txt
  99         - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
 100 md.txt
 101         - info on boot arguments for the multiple devices driver
 102 memory.txt
 103         - info on typical Linux memory problems.
 104 mkdev.ida
 105         - script to make /dev entries for Intelligent Disk Array Controllers.
 106 modules.txt
 107         - short guide on how to make kernel parts into loadable modules
 108 mtrr.txt
 109         - how to use PPro Memory Type Range Registers to increase performance
 110 nbd.txt
 111         - info on a TCP implementation of a network block device.
 112 networking/
 113         - directory with info on various aspects of networking with Linux.
 114 nfsroot.txt
 115         - short guide on setting up a diskless box with NFS root filesystem
 116 nmi_watchdog.txt
 117         - info on NMI watchdog for SMP systems
 118 oops-tracing.txt
 119         - how to decode those nasty internal kernel error dump messages.
 120 paride.txt
 121         - information about the parallel port IDE subsystem.
 122 parport.txt
 123         - how to use the parallel-port driver.
 124 pci.txt
 125         - info on the PCI subsystem for device driver authors
 126 pcwd-watchdog.txt
 127         - info and sample code for using with the PC Watchdog reset card.
 128 pm.txt
 129         - info on Linux power management support
 130 powerpc/
 131         - directory with info on using Linux with the PowerPC.
 132 proc_usb_info.txt
 133         - info on /proc/bus/usb direcory generated for USB devices
 134 ramdisk.txt
 135         - short guide on how to set up and use the RAM disk.
 136 riscom8.txt
 137         - notes on using the RISCom/8 multi-port serial driver.
 138 rtc.txt
 139         - notes on how to use the Real Time Clock (aka CMOS clock) driver.
 140 scsi-generic.txt
 141         - info on the sg driver for generic (non-disk/CD/tape) SCSI devices.
 142 scsi.txt
 143         - short blurb on using SCSI support as a module.
 144 serial-console.txt
 145         - how to set up Linux with a serial line console as the default.
 146 sgi-visws.txt
 147         - short blurb on the SGI Visual Workstations.
 148 smart-config.txt
 149         - description of the Smart Config makefile feature.
 150 smp.tex
 151         - LaTeX document describing implementation of Multiprocessor Linux
 152 smp.txt
 153         - a few more notes on symmetric multi-processing
 154 sound/
 155         - directory with info on sound card support
 156 specialix.txt
 157         - info on hardware/driver for specialix IO8+ multiport serial card.
 158 spinlocks.txt
 159         - info on using spinlocks to provide exclusive access in kernel.
 160 stallion.txt
 161         - info on using the Stallion multiport serial driver.
 162 svga.txt
 163         - short guide on selecting video modes at boot via VGA BIOS.
 164 sx.txt
 165         - info on the Specialix SX/SI multiport serial driver.
 166 sysctl/
 167         - directory with info on the /proc/sys/* files
 168 sysrq.txt
 169         - info on the magic SysRq key
 170 unicode.txt
 171         - info on the Unicode character/font mapping used in Linux.
 172 video4linux/
 173         - directory with info regarding video/TV/radio cards and linux.
 174 vm/
 175         - directory with info on the Linux vm code.
 176 watchdog.txt
 177         - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
 178 xterm-linux.xpm
 179         - XPM image of penguin logo (see logo.txt) sitting on an xterm.
 180