i386/linux/linux-2.3.21/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 arm/
  29         - directory with info about Linux on the ARM architecture.
  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 cpqarray.txt
  35         - info on using Compaq's SMART2 Intelligent Disk Array Controllers.
  36 devices.tex
  37         - LaTeX source listing of all the nodes in /dev/ with major minor #'s
  38 devices.txt
  39         - plain ASCII listing of all the nodes in /dev/ with major minor #'s
  40 digiboard.txt
  41         - info on the Digiboard PC/X{i,e,eve} multiport boards.
  42 digiepca.txt
  43         - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
  44 exception.txt
  45         - how Linux v2.2 handles exceptions without verify_area etc.
  46 fb/
  47         - directory with info on the frame buffer graphics abstraction layer.
  48 filesystems/
  49         - directory with info on the various filesystems that Linux supports.
  50 ftape.txt
  51         - notes about the floppy tape device driver
  52 hayes-esp.txt
  53         - info on using the Hayes ESP serial driver.
  54 i386/
  55         - directory with info about Linux on the intel ix86 architecture.
  56 ide.txt
  57         - important info for users of ATA devices (IDE/EIDE disks and CD-ROMS)
  58 initrd.txt
  59         - how to use the RAM disk as an initial/temporary root filesystem.
  60 ioctl-number.txt
  61         - how to implement and register device/driver ioctl calls.
  62 isdn/
  63         - directory with info on the Linux ISDN support, and supported cards.
  64 java.txt
  65         - info on the in-kernel binary support for Java(tm)
  66 joystick.txt
  67         - info on using joystick devices (and driver) with Linux.
  68 joystick-api.txt
  69         - API specification for applications that will be using the joystick.
  70 joystick-parport.txt
  71         - info on how to hook joysticks/gamepads to the parallel port.
  72 kbuild/
  73         - directory with info about the kernel build process
  74 kernel-docs.txt
  75         - listing of various WWW + books that document kernel internals.
  76 kernel-parameters.txt
  77         - summary listing of command line / boot prompt args for the kernel.
  78 kmod.txt
  79         - info on the kernel module loader/unloader (kerneld replacement).
  80 locks.txt
  81         - info on file locking implementations, flock() vs. fcntl(), etc.
  82 logo.gif
  83         - Full colour GIF image of Linux logo (penguin)
  84 logo.txt
  85         - Info on creator of above logo & site to get additional images from.
  86 m68k/
  87         - directory with info about Linux on Motorola 68k architecture.
  88 magic-number.txt
  89         - list of magic numbers used to mark/protect kernel data structures.
  90 mandatory.txt
  91         - info on the Linux implementation of Sys V mandatory file locking.
  92 mca.txt
  93         - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
  94 md.txt
  95         - info on boot arguments for the multiple devices driver
  96 memory.txt
  97         - info on typical Linux memory problems.
  98 mkdev.ida
  99         - script to make /dev entries for Intelligent Disk Array Controllers.
 100 modules.txt
 101         - short guide on how to make kernel parts into loadable modules
 102 mtrr.txt
 103         - how to use PPro Memory Type Range Registers to increase performance
 104 nbd.txt
 105         - info on a TCP implementation of a network block device.
 106 networking/
 107         - directory with info on various aspects of networking with Linux.
 108 nfsroot.txt
 109         - short guide on setting up a diskless box with NFS root filesystem
 110 oops-tracing.txt
 111         - how to decode those nasty internal kernel error dump messages.
 112 paride.txt
 113         - information about the parallel port IDE subsystem.
 114 parport.txt
 115         - how to use the parallel-port driver.
 116 pci.txt
 117         - info on the PCI subsystem for device driver authors
 118 pcwd-watchdog.txt
 119         - info and sample code for using with the PC Watchdog reset card.
 120 powerpc/
 121         - directory with info on using Linux with the PowerPC.
 122 proc.txt
 123         - detailed info on Linux's /proc filesystem.
 124 ramdisk.txt
 125         - short guide on how to set up and use the RAM disk.
 126 riscom8.txt
 127         - notes on using the RISCom/8 multi-port serial driver.
 128 rtc.txt
 129         - notes on how to use the Real Time Clock (aka CMOS clock) driver.
 130 scsi-generic.txt
 131         - info on the sg driver for generic (non-disk/CD/tape) SCSI devices.
 132 scsi.txt
 133         - short blurb on using SCSI support as a module.
 134 serial-console.txt
 135         - how to set up Linux with a serial line console as the default.
 136 sgi-visws.txt
 137         - short blurb on the SGI Visual Workstations.
 138 smart-config.txt
 139         - description of the Smart Config makefile feature.
 140 smp.tex
 141         - LaTeX document describing implementation of Multiprocessor Linux
 142 smp.txt
 143         - a few more notes on symmetric multi-processing
 144 sound/
 145         - directory with info on sound card support
 146 specialix.txt
 147         - info on hardware/driver for specialix IO8+ multiport serial card.
 148 spinlocks.txt
 149         - info on using spinlocks to provide exclusive access in kernel.
 150 stallion.txt
 151         - info on using the Stallion multiport serial driver.
 152 svga.txt
 153         - short guide on selecting video modes at boot via VGA BIOS.
 154 sx.txt
 155         - info on the Specialix SX/SI multiport serial driver.
 156 sysctl/
 157         - directory with info on the /proc/sys/* files
 158 sysrq.txt
 159         - info on the magic SysRq key
 160 transname.txt
 161         - how to use name translation to ease use of diskless systems.
 162 unicode.txt
 163         - info on the Unicode character/font mapping used in Linux.
 164 video4linux/
 165         - directory with info regarding video/TV/radio cards and linux.
 166 watchdog.txt
 167         - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
 168 xterm-linux.xpm
 169         - XPM image of penguin logo (see logo.txt) sitting on an xterm.
 170
 171