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 ARM-README
  11         - information for using Linux on the ARM architecture.
  12 BUG-HUNTING
  13         - brute force method of doing binary search of patches to find bug.
  14 Changes
  15         - list of changes that break older software packages.
  16 CodingStyle
  17         - how the boss likes the C code in the kernel to look.
  18 Configure.help
  19         - text file that is used for help when you run "make config"
  20 IO-APIC.txt
  21         - info on using the enhanced interrupt hardware on SMP boards.
  22 IO-mapping.txt
  23         - how to access I/O mapped memory from within device drivers.
  24 SMP.txt
  25         - notes, and "To Fix" list for multi-processor Linux. (see smp.tex)
  26 VGA-softcursor.txt
  27         - how to change your VGA cursor from a blinking underscore.
  28 binfmt_misc.txt
  29         - info on the kernel support for extra binary formats.
  30 cdrom/
  31         - directory with information on the CD-ROM drivers that Linux has.
  32 devices.tex
  33         - TeX source listing of all the nodes in /dev/ with major minor #'s
  34 devices.txt
  35         - plain ASCII listing of all the nodes in /dev/ with major minor #'s
  36 digiboard.txt
  37         - info on the Digiboard PC/X{i,e,eve} multiport boards.
  38 digiepca.txt
  39         - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
  40 exception.txt
  41         - how Linux v2.2 handles exceptions without verify_area etc.
  42 filesystems/
  43         - directory with info on the various filesystems that Linux supports.
  44 ftape.txt
  45         - notes about the floppy tape device driver
  46 hayes-esp.txt
  47         - info on using the Hayes ESP serial driver.
  48 ide.txt
  49         - important info for users of ATA devices (IDE/EIDE disks and CD-ROMS)
  50 initrd.txt
  51         - how to use the RAM disk as an initial/temporary root filesystem.
  52 ioctl-number.txt
  53         - how to implement and register device/driver ioctl calls.
  54 isdn/
  55         - directory with info on the Linux ISDN support, and supported cards.
  56 java.txt
  57         - info on the in-kernel binary support for Java(tm)
  58 joystick.txt
  59         - info on using joystick devices (and driver) with Linux.
  60 kbuild/
  61         - directory with info about the kernel build process
  62 kmod.txt
  63         - - info on the kernel module loader/unloader (kerneld replacement)
  64 locks.txt
  65         - info on file locking implementations, flock() vs. fcntl(), etc.
  66 logo.gif
  67         - Full colour GIF image of Linux logo (penguin)
  68 logo.txt
  69         - Info on creator of above logo & site to get additional images from.
  70 m68k/
  71         - directory with info about Linux on Motorola 68k architecture.
  72 magic-number.txt
  73         - list of magic numbers used to mark/protect kernel data structures.
  74 mandatory.txt
  75         - info on the Linux implementation of Sys V mandatory file locking.
  76 mca.txt
  77         - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
  78 md.txt
  79         - info on boot arguments for the multiple devices driver
  80 memory.txt
  81         - info on typical Linux memory problems.
  82 modules.txt
  83         - short guide on how to make kernel parts into loadable modules
  84 mtrr.txt
  85         - how to use PPro Memory Type Range Registers to increase performance
  86 nbd.txt
  87         - info on a TCP implementation of a network block device.
  88 networking/
  89         - directory with info on various aspects of networking with Linux.
  90 nfsroot.txt
  91         - short guide on setting up a diskless box with NFS root filesystem
  92 oops-tracing.txt
  93         - how to decode those nasty internal kernel error dump messages.
  94 paride.txt
  95         - information about the parallel port IDE subsystem.
  96 parport.txt
  97         - how to use the parallel-port driver.
  98 pci.txt
  99         - info on the PCI subsystem for device driver authors
 100 pcwd-watchdog.txt
 101         - info and sample code for using with the PC Watchdog reset card.
 102 powerpc/
 103         - directory with info on using Linux with the PowerPC.
 104 ramdisk.txt
 105         - short guide on how to set up and use the RAM disk.
 106 riscom8.txt
 107         - notes on using the RISCom/8 multi-port serial driver.
 108 rtc.txt
 109         - notes on how to use the Real Time Clock (aka CMOS clock) driver.
 110 scsi.txt
 111         - short blurb on using SCSI support as a module.
 112 serial-console.txt
 113         - how to set up Linux with a serial line console as the default.
 114 smart-config.txt
 115         - description of the Smart Config makefile feature.
 116 smp.tex
 117         - TeX document describing implementation of Multiprocessor Linux
 118 smp.txt
 119         - a few more notes on symmetric multi-processing
 120 sound/
 121         - directory with info on sound card support
 122 specialix.txt
 123         - info on hardware/driver for specialix IO8+ multiport serial card.
 124 spinlocks.txt
 125         - info on using spinlocks to provide exclusive access in kernel.
 126 stallion.txt
 127         - info on using the Stallion multiport serial driver.
 128 svga.txt
 129         - short guide on selecting video modes at boot via VGA BIOS.
 130 sysctl/
 131         - directory with info on the /proc/sys/* files
 132 sysrq.txt
 133         - info on the magic SysRq key
 134 transname.txt
 135         - how to use name translation to ease use of diskless systems.
 136 unicode.txt
 137         - info on the Unicode character/font mapping used in Linux.
 138 watchdog.txt
 139         - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
 140 xterm-linux.xpm
 141         - XPM image of penguin logo (see logo.txt) sitting on an xterm.
 142
 143