blob: 8ddae4e4299aa10e84f27ab480a3ec3f79c97261 [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 Chehab337c1882016-11-07 17:03:18 -020030 tainted-kernels
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030031 ramoops
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030032 dynamic-debug-howto
Jonathan Corbet7358bb22016-10-26 16:14:52 -060033 init
34
35This is the beginning of a section with information of interest to
36application developers. Documents covering various aspects of the kernel
37ABI will be found here.
38
39.. toctree::
40 :maxdepth: 1
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -020041
Jonathan Corbet7358bb22016-10-26 16:14:52 -060042 sysfs-rules
43
44The rest of this manual consists of various unordered guides on how to
45configure specific aspects of kernel behavior to your liking.
46
47.. toctree::
48 :maxdepth: 1
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -020049
Jonathan Corbet7358bb22016-10-26 16:14:52 -060050 initrd
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030051 serial-console
52 braille-console
53 parport
54 md
55 module-signing
56 sysrq
57 unicode
58 vga-softcursor
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030059 binfmt-misc
60 mono
61 java
Mauro Carvalho Chehabfd77f6b2016-10-26 16:24:41 -020062 ras
Markus Heiser6f2ec3a2016-10-26 08:23:16 +020063
64.. only:: subproject and html
65
66 Indices
67 =======
68
69 * :ref:`genindex`