Documentation: delete unreferenced xterm-linux.xpm file
[linux-2.6.git] / Documentation / 00-INDEX
1
2 This is a brief list of all the files in ./linux/Documentation and what
3 they contain. If you add a documentation file, please list it here in
4 alphabetical order as well, or risk being hunted down like a rabid dog.
5 Please try and keep the descriptions small enough to fit on one line.
6                                                          Thanks -- Paul G.
7
8 Following translations are available on the WWW:
9
10    - Japanese, maintained by the JF Project (JF@linux.or.jp), at
11      http://www.linux.or.jp/JF/
12
13 00-INDEX
14         - this file.
15 ABI/
16         - info on kernel <-> userspace ABI and relative interface stability.
17 BUG-HUNTING
18         - brute force method of doing binary search of patches to find bug.
19 Changes
20         - list of changes that break older software packages.
21 CodingStyle
22         - how the boss likes the C code in the kernel to look.
23 DMA-API.txt
24         - DMA API, pci_ API & extensions for non-consistent memory machines.
25 DMA-mapping.txt
26         - info for PCI drivers using DMA portably across all platforms.
27 DocBook/
28         - directory with DocBook templates etc. for kernel documentation.
29 HOWTO
30         - the process and procedures of how to do Linux kernel development.
31 IO-mapping.txt
32         - how to access I/O mapped memory from within device drivers.
33 IPMI.txt
34         - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
35 IRQ-affinity.txt
36         - how to select which CPU(s) handle which interrupt events on SMP.
37 IRQ.txt
38         - description of what an IRQ is.
39 ManagementStyle
40         - how to (attempt to) manage kernel hackers.
41 MSI-HOWTO.txt
42         - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ.
43 PCIEBUS-HOWTO.txt
44         - a guide describing the PCI Express Port Bus driver.
45 RCU/
46         - directory with info on RCU (read-copy update).
47 README.DAC960
48         - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux.
49 README.cycladesZ
50         - info on Cyclades-Z firmware loading.
51 SAK.txt
52         - info on Secure Attention Keys.
53 SecurityBugs
54         - procedure for reporting security bugs found in the kernel.
55 SubmitChecklist
56         - Linux kernel patch submission checklist.
57 SubmittingDrivers
58         - procedure to get a new driver source included into the kernel tree.
59 SubmittingPatches
60         - procedure to get a source patch included into the kernel tree.
61 VGA-softcursor.txt
62         - how to change your VGA cursor from a blinking underscore.
63 accounting/
64         - documentation on accounting and taskstats.
65 aoe/
66         - description of AoE (ATA over Ethernet) along with config examples.
67 applying-patches.txt
68         - description of various trees and how to apply their patches.
69 arm/
70         - directory with info about Linux on the ARM architecture.
71 atomic_ops.txt
72         - semantics and behavior of atomic and bitmask operations.
73 auxdisplay/
74         - misc. LCD driver documentation (cfag12864b, ks0108).
75 basic_profiling.txt
76         - basic instructions for those who wants to profile Linux kernel.
77 binfmt_misc.txt
78         - info on the kernel support for extra binary formats.
79 blackfin/
80         - directory with documentation for the Blackfin arch.
81 block/
82         - info on the Block I/O (BIO) layer.
83 cachetlb.txt
84         - describes the cache/TLB flushing interfaces Linux uses.
85 cciss.txt
86         - info, major/minor #'s for Compaq's SMART Array Controllers.
87 cdrom/
88         - directory with information on the CD-ROM drivers that Linux has.
89 cli-sti-removal.txt
90         - cli()/sti() removal guide.
91 computone.txt
92         - info on Computone Intelliport II/Plus Multiport Serial Driver.
93 connector/
94         - docs on the netlink based userspace<->kernel space communication mod.
95 console/
96         - documentation on Linux console drivers.
97 cpqarray.txt
98         - info on using Compaq's SMART2 Intelligent Disk Array Controllers.
99 cpu-freq/
100         - info on CPU frequency and voltage scaling.
101 cpu-hotplug.txt
102         - document describing CPU hotplug support in the Linux kernel.
103 cpu-load.txt
104         - document describing how CPU load statistics are collected.
105 cpusets.txt
106         - documents the cpusets feature; assign CPUs and Mem to a set of tasks.
107 cputopology.txt
108         - documentation on how CPU topology info is exported via sysfs.
109 cris/
110         - directory with info about Linux on CRIS architecture.
111 crypto/
112         - directory with info on the Crypto API.
113 dcdbas.txt
114         - information on the Dell Systems Management Base Driver.
115 debugging-modules.txt
116         - some notes on debugging modules after Linux 2.6.3.
117 dell_rbu.txt
118         - document demonstrating the use of the Dell Remote BIOS Update driver.
119 device-mapper/
120         - directory with info on Device Mapper.
121 devices.txt
122         - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
123 digiepca.txt
124         - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
125 dnotify.txt
126         - info about directory notification in Linux.
127 dontdiff
128         - file containing a list of files that should never be diff'ed.
129 driver-model/
130         - directory with info about Linux driver model.
131 drivers/
132         - directory with driver documentation (currently only EDAC).
133 dvb/
134         - info on Linux Digital Video Broadcast (DVB) subsystem.
135 early-userspace/
136         - info about initramfs, klibc, and userspace early during boot.
137 eisa.txt
138         - info on EISA bus support.
139 exception.txt
140         - how Linux v2.2 handles exceptions without verify_area etc.
141 fault-injection/
142         - dir with docs about the fault injection capabilities infrastructure.
143 fb/
144         - directory with info on the frame buffer graphics abstraction layer.
145 feature-removal-schedule.txt
146         - list of files and features that are going to be removed.
147 filesystems/
148         - info on the vfs and the various filesystems that Linux supports.
149 firmware_class/
150         - request_firmware() hotplug interface info.
151 floppy.txt
152         - notes and driver options for the floppy disk driver.
153 fujitsu/
154         - Fujitsu FR-V Linux documentation.
155 gpio.txt
156         - overview of GPIO (General Purpose Input/Output) access conventions.
157 hayes-esp.txt
158         - info on using the Hayes ESP serial driver.
159 highuid.txt
160         - notes on the change from 16 bit to 32 bit user/group IDs.
161 hpet.txt
162         - High Precision Event Timer Driver for Linux.
163 hrtimer/
164         - info on the timer_stats debugging facility for timer (ab)use.
165 hrtimers/
166         - info on the hrtimers subsystem for high-resolution kernel timers.
167 hw_random.txt
168         - info on Linux support for random number generator in i8xx chipsets.
169 hwmon/
170         - directory with docs on various hardware monitoring drivers.
171 i2c/
172         - directory with info about the I2C bus/protocol (2 wire, kHz speed).
173 i2o/
174         - directory with info about the Linux I2O subsystem.
175 i386/
176         - directory with info about Linux on Intel 32 bit architecture.
177 ia64/
178         - directory with info about Linux on Intel 64 bit architecture.
179 ide.txt
180         - important info for users of ATA devices (IDE/EIDE disks and CD-ROMS).
181 infiniband/
182         - directory with documents concerning Linux InfiniBand support.
183 initrd.txt
184         - how to use the RAM disk as an initial/temporary root filesystem.
185 input/
186         - info on Linux input device support.
187 io_ordering.txt
188         - info on ordering I/O writes to memory-mapped addresses.
189 ioctl/
190         - directory with documents describing various IOCTL calls.
191 ioctl-number.txt
192         - how to implement and register device/driver ioctl calls.
193 iostats.txt
194         - info on I/O statistics Linux kernel provides.
195 irqflags-tracing.txt
196         - how to use the irq-flags tracing feature.
197 isapnp.txt
198         - info on Linux ISA Plug & Play support.
199 isdn/
200         - directory with info on the Linux ISDN support, and supported cards.
201 java.txt
202         - info on the in-kernel binary support for Java(tm).
203 kbuild/
204         - directory with info about the kernel build process.
205 kdump/
206         - directory with mini HowTo on getting the crash dump code to work.
207 kernel-doc-nano-HOWTO.txt
208         - mini HowTo on generation and location of kernel documentation files.
209 kernel-docs.txt
210         - listing of various WWW + books that document kernel internals.
211 kernel-parameters.txt
212         - summary listing of command line / boot prompt args for the kernel.
213 keys-request-key.txt
214         - description of the kernel key request service.
215 keys.txt
216         - description of the kernel key retention service.
217 kobject.txt
218         - info of the kobject infrastructure of the Linux kernel.
219 kprobes.txt
220         - documents the kernel probes debugging feature.
221 kref.txt
222         - docs on adding reference counters (krefs) to kernel objects.
223 laptop-mode.txt
224         - how to conserve battery power using laptop-mode.
225 ldm.txt
226         - a brief description of LDM (Windows Dynamic Disks).
227 leds-class.txt
228         - documents LED handling under Linux.
229 local_ops.txt
230         - semantics and behavior of local atomic operations.
231 lockdep-design.txt
232         - documentation on the runtime locking correctness validator.
233 logo.gif
234         - full colour GIF image of Linux logo (penguin - Tux).
235 logo.txt
236         - info on creator of above logo & site to get additional images from.
237 m68k/
238         - directory with info about Linux on Motorola 68k architecture.
239 magic-number.txt
240         - list of magic numbers used to mark/protect kernel data structures.
241 mca.txt
242         - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
243 md.txt
244         - info on boot arguments for the multiple devices driver.
245 memory-barriers.txt
246         - info on Linux kernel memory barriers.
247 memory.txt
248         - info on typical Linux memory problems.
249 mips/
250         - directory with info about Linux on MIPS architecture.
251 mono.txt
252         - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
253 moxa-smartio
254         - file with info on installing/using Moxa multiport serial driver.
255 mtrr.txt
256         - how to use PPro Memory Type Range Registers to increase performance.
257 mutex-design.txt
258         - info on the generic mutex subsystem.
259 nbd.txt
260         - info on a TCP implementation of a network block device.
261 netlabel/
262         - directory with information on the NetLabel subsystem.
263 networking/
264         - directory with info on various aspects of networking with Linux.
265 nfsroot.txt
266         - short guide on setting up a diskless box with NFS root filesystem.
267 nmi_watchdog.txt
268         - info on NMI watchdog for SMP systems.
269 nommu-mmap.txt
270         - documentation about no-mmu memory mapping support.
271 numastat.txt
272         - info on how to read Numa policy hit/miss statistics in sysfs.
273 oops-tracing.txt
274         - how to decode those nasty internal kernel error dump messages.
275 paride.txt
276         - information about the parallel port IDE subsystem.
277 parisc/
278         - directory with info on using Linux on PA-RISC architecture.
279 parport.txt
280         - how to use the parallel-port driver.
281 parport-lowlevel.txt
282         - description and usage of the low level parallel port functions.
283 pci-error-recovery.txt
284         - info on PCI error recovery.
285 pci.txt
286         - info on the PCI subsystem for device driver authors.
287 pcieaer-howto.txt
288         - the PCI Express Advanced Error Reporting Driver Guide HOWTO.
289 pcmcia/
290         - info on the Linux PCMCIA driver.
291 pi-futex.txt
292         - documentation on lightweight PI-futexes.
293 pm.txt
294         - info on Linux power management support.
295 pnp.txt
296         - Linux Plug and Play documentation.
297 power/
298         - directory with info on Linux PCI power management.
299 powerpc/
300         - directory with info on using Linux with the PowerPC.
301 preempt-locking.txt
302         - info on locking under a preemptive kernel.
303 prio_tree.txt
304         - info on radix-priority-search-tree use for indexing vmas.
305 ramdisk.txt
306         - short guide on how to set up and use the RAM disk.
307 rbtree.txt
308         - info on what red-black trees are and what they are for.
309 riscom8.txt
310         - notes on using the RISCom/8 multi-port serial driver.
311 robust-futex-ABI.txt
312         - documentation of the robust futex ABI.
313 robust-futexes.txt
314         - a description of what robust futexes are.
315 rocket.txt
316         - info on the Comtrol RocketPort multiport serial driver.
317 rpc-cache.txt
318         - introduction to the caching mechanisms in the sunrpc layer.
319 rt-mutex-design.txt
320         - description of the RealTime mutex implementation design.
321 rt-mutex.txt
322         - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
323 rtc.txt
324         - notes on how to use the Real Time Clock (aka CMOS clock) driver.
325 s390/
326         - directory with info on using Linux on the IBM S390.
327 sched-arch.txt
328         - CPU Scheduler implementation hints for architecture specific code.
329 sched-coding.txt
330         - reference for various scheduler-related methods in the O(1) scheduler.
331 sched-design.txt
332         - goals, design and implementation of the Linux O(1) scheduler.
333 sched-domains.txt
334         - information on scheduling domains.
335 sched-stats.txt
336         - information on schedstats (Linux Scheduler Statistics).
337 scsi/
338         - directory with info on Linux scsi support.
339 serial/
340         - directory with info on the low level serial API.
341 serial-console.txt
342         - how to set up Linux with a serial line console as the default.
343 sgi-ioc4.txt
344         - description of the SGI IOC4 PCI (multi function) device.
345 sgi-visws.txt
346         - short blurb on the SGI Visual Workstations.
347 sh/
348         - directory with info on porting Linux to a new architecture.
349 sharedsubtree.txt
350         - a description of shared subtrees for namespaces.
351 smart-config.txt
352         - description of the Smart Config makefile feature.
353 smp.txt
354         - a few notes on symmetric multi-processing.
355 sony-laptop.txt
356         - Sony Notebook Control Driver (SNC) Readme.
357 sonypi.txt
358         - info on Linux Sony Programmable I/O Device support.
359 sound/
360         - directory with info on sound card support.
361 sparc/
362         - directory with info on using Linux on Sparc architecture.
363 sparse.txt
364         - info on how to obtain and use the sparse tool for typechecking.
365 specialix.txt
366         - info on hardware/driver for specialix IO8+ multiport serial card.
367 spi/
368         - overview of Linux kernel Serial Peripheral Interface (SPI) support.
369 spinlocks.txt
370         - info on using spinlocks to provide exclusive access in kernel.
371 stable_api_nonsense.txt
372         - info on why the kernel does not have a stable in-kernel api or abi.
373 stable_kernel_rules.txt
374         - rules and procedures for the -stable kernel releases.
375 stallion.txt
376         - info on using the Stallion multiport serial driver.
377 svga.txt
378         - short guide on selecting video modes at boot via VGA BIOS.
379 sx.txt
380         - info on the Specialix SX/SI multiport serial driver.
381 sysctl/
382         - directory with info on the /proc/sys/* files.
383 sysrq.txt
384         - info on the magic SysRq key.
385 telephony/
386         - directory with info on telephony (e.g. voice over IP) support.
387 thinkpad-acpi.txt
388         - information on the (IBM and Lenovo) ThinkPad ACPI Extras driver.
389 time_interpolators.txt
390         - info on time interpolators.
391 tipar.txt
392         - information about Parallel link cable for Texas Instruments handhelds.
393 tty.txt
394         - guide to the locking policies of the tty layer.
395 uml/
396         - directory with information about User Mode Linux.
397 unicode.txt
398         - info on the Unicode character/font mapping used in Linux.
399 unshare.txt
400         - description of the Linux unshare system call.
401 usb/
402         - directory with info regarding the Universal Serial Bus.
403 video-output.txt
404         - sysfs class driver interface to enable/disable a video output device.
405 video4linux/
406         - directory with info regarding video/TV/radio cards and linux.
407 vm/
408         - directory with info on the Linux vm code.
409 voyager.txt
410         - guide to running Linux on the Voyager architecture.
411 w1/
412         - directory with documents regarding the 1-wire (w1) subsystem.
413 watchdog/
414         - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
415 x86_64/
416         - directory with info on Linux support for AMD x86-64 (Hammer) machines.
417 zorro.txt
418         - info on writing drivers for Zorro bus devices found on Amigas.