blob: 86a6ab98d6b6a51e9f5e9ed880ca9b071e6c04ad [file] [log] [blame]
Jonathan Corbet7358bb22016-10-26 16:14:52 -06001The Linux kernel user's and administrator's guide
2=================================================
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -03003
Jonathan Corbet7358bb22016-10-26 16:14:52 -06004The following is a collection of user-oriented documents that have been
5added to the kernel over time. There is, as yet, little overall order or
6organization here this material was not written to be a single, coherent
7document! With luck things will improve quickly over time.
8
9This initial section contains overall information, including the README
10file describing the kernel as a whole, documentation on kernel parameters,
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -020011etc.
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030012
13.. toctree::
Jonathan Corbet7358bb22016-10-26 16:14:52 -060014 :maxdepth: 1
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030015
16 README
Jonathan Corbet7358bb22016-10-26 16:14:52 -060017 kernel-parameters
18 devices
19
20Here is a set of documents aimed at users who are trying to track down
21problems and bugs in particular.
22
23.. toctree::
24 :maxdepth: 1
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -020025
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030026 reporting-bugs
Jonathan Corbet7358bb22016-10-26 16:14:52 -060027 security-bugs
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030028 bug-hunting
Mauro Carvalho Chehabc7309042016-11-07 17:03:17 -020029 bug-bisect
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030030 oops-tracing
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -020031 tainted-kernels
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030032 ramoops
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030033 dynamic-debug-howto
Jonathan Corbet7358bb22016-10-26 16:14:52 -060034 init
35
36This is the beginning of a section with information of interest to
37application developers. Documents covering various aspects of the kernel
38ABI will be found here.
39
40.. toctree::
41 :maxdepth: 1
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -020042
Jonathan Corbet7358bb22016-10-26 16:14:52 -060043 sysfs-rules
44
45The rest of this manual consists of various unordered guides on how to
46configure specific aspects of kernel behavior to your liking.
47
48.. toctree::
49 :maxdepth: 1
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -020050
Jonathan Corbet7358bb22016-10-26 16:14:52 -060051 initrd
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030052 serial-console
53 braille-console
54 parport
55 md
56 module-signing
57 sysrq
58 unicode
59 vga-softcursor
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030060 binfmt-misc
61 mono
62 java
Markus Heiser6f2ec3a2016-10-26 08:23:16 +020063
64.. only:: subproject and html
65
66 Indices
67 =======
68
69 * :ref:`genindex`