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.
   5                                                          Thanks -- Paul G.
   6
   7 00-INDEX
   8         - this file.
   9 BUG-HUNTING
  10         - brute force method of doing binary search of patches to find bug.
  11 Changes
  12         - list of changes that break older software packages.
  13 CodingStyle
  14         - how the boss likes the C code in the kernel to look.
  15 Configure.help
  16         - text file that is used for help when you run "make config"
  17 IO-mapping.txt
  18         - how to access I/O mapped memory from within device drivers.
  19 SMP.txt
  20         - notes, and "To Fix" list for multi-processor Linux. (see smp.tex)
  21 binfmt_misc.txt
  22         - info on the kernel support for extra binary formats.
  23 cdrom/
  24         - directory with information on the CD-ROM drivers that Linux has.
  25 devices.tex
  26         - TeX source listing of all the nodes in /dev/ with major minor #'s
  27 devices.txt
  28         - plain ASCII listing of all the nodes in /dev/ with major minor #'s
  29 digiboard.txt
  30         - info on the Digiboard PC/X{i,e,eve} multiport boards.
  31 digiepca.txt
  32         - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
  33 exception.txt
  34         - how linux v2.1 handles exceptions without verify_area etc.
  35 filesystems/
  36         - directory with info on the various filesystems that Linux supports.
  37 ftape.txt
  38         - notes about the floppy tape device driver
  39 ide.txt
  40         - important info for users of ATA devices (IDE/EIDE disks and CD-ROMS)
  41 initrd.txt
  42         - how to use the RAM disk as an initial/temporary root filesystem.
  43 ioctl-number.txt
  44         - how to implement and register device/driver ioctl calls.
  45 isdn/
  46         - directory with info on the linux ISDN support, and supported cards.
  47 java.txt
  48         - info on the in-kernel binary support for Java(tm)
  49 locks.txt
  50         - info on file locking implementations, flock() vs. fcntl(), etc.
  51 logo.gif
  52         - Full colour GIF image of Linux logo (penguin)
  53 logo.txt
  54         - Info on creator of above logo & site to get additional images from.
  55 magic-number.txt
  56         - list of magic numbers used to mark/protect kernel data structures.
  57 mandatory.txt
  58         - info on the linux implementation of Sys V mandatory file locking.
  59 memory.txt
  60         - info on typical Linux memory problems.
  61 mca.txt
  62         - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
  63 modules.txt
  64         - short guide on how to make kernel parts into loadable modules
  65 networking/
  66         - directory with info on various linux networking aspects.
  67 nfsroot.txt
  68         - short guide on setting up a diskless box with NFS root filesystem
  69 oops-tracing.txt
  70         - how to decode those nasty internal kernel error dump messages.
  71 paride.txt
  72         - information about the parallel port IDE subsystem.
  73 parport.txt
  74         - how to use the parallel-port driver.
  75 ramdisk.txt
  76         - short guide on how to set up and use the RAM disk.
  77 riscom8.txt
  78         - notes on using the RISCom/8 multi-port serial driver.
  79 rtc.txt
  80         - notes on how to use the Real Time Clock (aka CMOS clock) driver.
  81 scsi.txt
  82         - short blurb on using SCSI support as a module.
  83 smart-config.txt
  84         - description of the Smart Config makefile feature.
  85 smp.tex
  86         - TeX document describing implementation of Multiprocessor Linux
  87 svga.txt
  88         - short guide on selecting video modes at boot via VGA BIOS.
  89 unicode.txt
  90         - info on the Unicode character/font mapping used in Linux.
  91 watchdog.txt
  92         - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
  93 xterm-linux.xpm
  94         - XPM image of penguin logo (see logo.txt) sitting on an xterm.
  95
  96