00-INDEX 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302
  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. Please try and keep the descriptions small enough to fit on one line.
  5. Thanks -- Paul G.
  6. Following translations are available on the WWW:
  7. - Japanese, maintained by the JF Project (JF@linux.or.jp), at
  8. http://www.linux.or.jp/JF/
  9. 00-INDEX
  10. - this file.
  11. BUG-HUNTING
  12. - brute force method of doing binary search of patches to find bug.
  13. Changes
  14. - list of changes that break older software packages.
  15. CodingStyle
  16. - how the boss likes the C code in the kernel to look.
  17. DMA-API.txt
  18. - DMA API, pci_ API & extensions for non-consistent memory machines.
  19. DMA-mapping.txt
  20. - info for PCI drivers using DMA portably across all platforms.
  21. DocBook/
  22. - directory with DocBook templates etc. for kernel documentation.
  23. HOWTO
  24. - The process and procedures of how to do Linux kernel development.
  25. IO-mapping.txt
  26. - how to access I/O mapped memory from within device drivers.
  27. IPMI.txt
  28. - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
  29. IRQ-affinity.txt
  30. - how to select which CPU(s) handle which interrupt events on SMP.
  31. ManagementStyle
  32. - how to (attempt to) manage kernel hackers.
  33. MSI-HOWTO.txt
  34. - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ.
  35. RCU/
  36. - directory with info on RCU (read-copy update).
  37. README.DAC960
  38. - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux.
  39. SAK.txt
  40. - info on Secure Attention Keys.
  41. SubmittingDrivers
  42. - procedure to get a new driver source included into the kernel tree.
  43. SubmittingPatches
  44. - procedure to get a source patch included into the kernel tree.
  45. VGA-softcursor.txt
  46. - how to change your VGA cursor from a blinking underscore.
  47. applying-patches.txt
  48. - description of various trees and how to apply their patches.
  49. arm/
  50. - directory with info about Linux on the ARM architecture.
  51. basic_profiling.txt
  52. - basic instructions for those who wants to profile Linux kernel.
  53. binfmt_misc.txt
  54. - info on the kernel support for extra binary formats.
  55. block/
  56. - info on the Block I/O (BIO) layer.
  57. cachetlb.txt
  58. - describes the cache/TLB flushing interfaces Linux uses.
  59. cciss.txt
  60. - info, major/minor #'s for Compaq's SMART Array Controllers.
  61. cdrom/
  62. - directory with information on the CD-ROM drivers that Linux has.
  63. cli-sti-removal.txt
  64. - cli()/sti() removal guide.
  65. computone.txt
  66. - info on Computone Intelliport II/Plus Multiport Serial Driver.
  67. cpqarray.txt
  68. - info on using Compaq's SMART2 Intelligent Disk Array Controllers.
  69. cpu-freq/
  70. - info on CPU frequency and voltage scaling.
  71. cris/
  72. - directory with info about Linux on CRIS architecture.
  73. crypto/
  74. - directory with info on the Crypto API.
  75. debugging-modules.txt
  76. - some notes on debugging modules after Linux 2.6.3.
  77. device-mapper/
  78. - directory with info on Device Mapper.
  79. devices.txt
  80. - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
  81. digiepca.txt
  82. - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
  83. dnotify.txt
  84. - info about directory notification in Linux.
  85. driver-model/
  86. - directory with info about Linux driver model.
  87. dvb/
  88. - info on Linux Digital Video Broadcast (DVB) subsystem.
  89. early-userspace/
  90. - info about initramfs, klibc, and userspace early during boot.
  91. eisa.txt
  92. - info on EISA bus support.
  93. exception.txt
  94. - how Linux v2.2 handles exceptions without verify_area etc.
  95. fb/
  96. - directory with info on the frame buffer graphics abstraction layer.
  97. filesystems/
  98. - directory with info on the various filesystems that Linux supports.
  99. firmware_class/
  100. - request_firmware() hotplug interface info.
  101. floppy.txt
  102. - notes and driver options for the floppy disk driver.
  103. hayes-esp.txt
  104. - info on using the Hayes ESP serial driver.
  105. highuid.txt
  106. - notes on the change from 16 bit to 32 bit user/group IDs.
  107. hpet.txt
  108. - High Precision Event Timer Driver for Linux.
  109. hw_random.txt
  110. - info on Linux support for random number generator in i8xx chipsets.
  111. i2c/
  112. - directory with info about the I2C bus/protocol (2 wire, kHz speed).
  113. i2o/
  114. - directory with info about the Linux I2O subsystem.
  115. i386/
  116. - directory with info about Linux on Intel 32 bit architecture.
  117. ia64/
  118. - directory with info about Linux on Intel 64 bit architecture.
  119. ide.txt
  120. - important info for users of ATA devices (IDE/EIDE disks and CD-ROMS).
  121. initrd.txt
  122. - how to use the RAM disk as an initial/temporary root filesystem.
  123. input/
  124. - info on Linux input device support.
  125. io_ordering.txt
  126. - info on ordering I/O writes to memory-mapped addresses.
  127. ioctl-number.txt
  128. - how to implement and register device/driver ioctl calls.
  129. iostats.txt
  130. - info on I/O statistics Linux kernel provides.
  131. isapnp.txt
  132. - info on Linux ISA Plug & Play support.
  133. isdn/
  134. - directory with info on the Linux ISDN support, and supported cards.
  135. java.txt
  136. - info on the in-kernel binary support for Java(tm).
  137. kbuild/
  138. - directory with info about the kernel build process.
  139. kdumpt.txt
  140. - mini HowTo on getting the crash dump code to work.
  141. kernel-doc-nano-HOWTO.txt
  142. - mini HowTo on generation and location of kernel documentation files.
  143. kernel-docs.txt
  144. - listing of various WWW + books that document kernel internals.
  145. kernel-parameters.txt
  146. - summary listing of command line / boot prompt args for the kernel.
  147. kobject.txt
  148. - info of the kobject infrastructure of the Linux kernel.
  149. laptop-mode.txt
  150. - How to conserve battery power using laptop-mode.
  151. ldm.txt
  152. - a brief description of LDM (Windows Dynamic Disks).
  153. locks.txt
  154. - info on file locking implementations, flock() vs. fcntl(), etc.
  155. logo.gif
  156. - Full colour GIF image of Linux logo (penguin).
  157. logo.txt
  158. - Info on creator of above logo & site to get additional images from.
  159. m68k/
  160. - directory with info about Linux on Motorola 68k architecture.
  161. magic-number.txt
  162. - list of magic numbers used to mark/protect kernel data structures.
  163. mandatory.txt
  164. - info on the Linux implementation of Sys V mandatory file locking.
  165. mca.txt
  166. - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
  167. md.txt
  168. - info on boot arguments for the multiple devices driver.
  169. memory.txt
  170. - info on typical Linux memory problems.
  171. mips/
  172. - directory with info about Linux on MIPS architecture.
  173. mono.txt
  174. - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
  175. moxa-smartio
  176. - info on installing/using Moxa multiport serial driver.
  177. mtrr.txt
  178. - how to use PPro Memory Type Range Registers to increase performance.
  179. nbd.txt
  180. - info on a TCP implementation of a network block device.
  181. netlabel/
  182. - directory with information on the NetLabel subsystem.
  183. networking/
  184. - directory with info on various aspects of networking with Linux.
  185. nfsroot.txt
  186. - short guide on setting up a diskless box with NFS root filesystem.
  187. nmi_watchdog.txt
  188. - info on NMI watchdog for SMP systems.
  189. numastat.txt
  190. - info on how to read Numa policy hit/miss statistics in sysfs.
  191. oops-tracing.txt
  192. - how to decode those nasty internal kernel error dump messages.
  193. paride.txt
  194. - information about the parallel port IDE subsystem.
  195. parisc/
  196. - directory with info on using Linux on PA-RISC architecture.
  197. parport.txt
  198. - how to use the parallel-port driver.
  199. parport-lowlevel.txt
  200. - description and usage of the low level parallel port functions.
  201. pci.txt
  202. - info on the PCI subsystem for device driver authors.
  203. pm.txt
  204. - info on Linux power management support.
  205. pnp.txt
  206. - Linux Plug and Play documentation.
  207. power/
  208. - directory with info on Linux PCI power management.
  209. powerpc/
  210. - directory with info on using Linux with the PowerPC.
  211. preempt-locking.txt
  212. - info on locking under a preemptive kernel.
  213. ramdisk.txt
  214. - short guide on how to set up and use the RAM disk.
  215. riscom8.txt
  216. - notes on using the RISCom/8 multi-port serial driver.
  217. rocket.txt
  218. - info on the Comtrol RocketPort multiport serial driver.
  219. rpc-cache.txt
  220. - introduction to the caching mechanisms in the sunrpc layer.
  221. rtc.txt
  222. - notes on how to use the Real Time Clock (aka CMOS clock) driver.
  223. s390/
  224. - directory with info on using Linux on the IBM S390.
  225. sched-coding.txt
  226. - reference for various scheduler-related methods in the O(1) scheduler.
  227. sched-design.txt
  228. - goals, design and implementation of the Linux O(1) scheduler.
  229. sched-domains.txt
  230. - information on scheduling domains.
  231. sched-stats.txt
  232. - information on schedstats (Linux Scheduler Statistics).
  233. scsi/
  234. - directory with info on Linux scsi support.
  235. serial/
  236. - directory with info on the low level serial API.
  237. serial-console.txt
  238. - how to set up Linux with a serial line console as the default.
  239. sgi-visws.txt
  240. - short blurb on the SGI Visual Workstations.
  241. sh/
  242. - directory with info on porting Linux to a new architecture.
  243. smart-config.txt
  244. - description of the Smart Config makefile feature.
  245. smp.txt
  246. - a few notes on symmetric multi-processing.
  247. sonypi.txt
  248. - info on Linux Sony Programmable I/O Device support.
  249. sound/
  250. - directory with info on sound card support.
  251. sparc/
  252. - directory with info on using Linux on Sparc architecture.
  253. specialix.txt
  254. - info on hardware/driver for specialix IO8+ multiport serial card.
  255. spinlocks.txt
  256. - info on using spinlocks to provide exclusive access in kernel.
  257. stable_api_nonsense.txt
  258. - info on why the kernel does not have a stable in-kernel api or abi.
  259. stable_kernel_rules.txt
  260. - rules and procedures for the -stable kernel releases.
  261. stallion.txt
  262. - info on using the Stallion multiport serial driver.
  263. svga.txt
  264. - short guide on selecting video modes at boot via VGA BIOS.
  265. sx.txt
  266. - info on the Specialix SX/SI multiport serial driver.
  267. sysctl/
  268. - directory with info on the /proc/sys/* files.
  269. sysrq.txt
  270. - info on the magic SysRq key.
  271. telephony/
  272. - directory with info on telephony (e.g. voice over IP) support.
  273. time_interpolators.txt
  274. - info on time interpolators.
  275. tipar.txt
  276. - information about Parallel link cable for Texas Instruments handhelds.
  277. tty.txt
  278. - guide to the locking policies of the tty layer.
  279. unicode.txt
  280. - info on the Unicode character/font mapping used in Linux.
  281. uml/
  282. - directory with information about User Mode Linux.
  283. usb/
  284. - directory with info regarding the Universal Serial Bus.
  285. video4linux/
  286. - directory with info regarding video/TV/radio cards and linux.
  287. vm/
  288. - directory with info on the Linux vm code.
  289. voyager.txt
  290. - guide to running Linux on the Voyager architecture.
  291. watchdog/
  292. - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
  293. x86_64/
  294. - directory with info on Linux support for AMD x86-64 (Hammer) machines.
  295. xterm-linux.xpm
  296. - XPM image of penguin logo (see logo.txt) sitting on an xterm.
  297. zorro.txt
  298. - info on writing drivers for Zorro bus devices found on Amigas.