blob: 4e98f5596da0f6569e1f785cafcaefb59a6ba26f [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
Mauro Carvalho Chehab57043242019-04-22 16:48:00 -030019 sysctl/index
Jonathan Corbet7358bb22016-10-26 16:14:52 -060020
Thomas Gleixner65fd4cb2019-02-19 11:10:49 +010021This section describes CPU vulnerabilities and their mitigations.
Thomas Gleixner3ec8ce52018-07-13 16:23:26 +020022
23.. toctree::
24 :maxdepth: 1
25
Thomas Gleixner65fd4cb2019-02-19 11:10:49 +010026 hw-vuln/index
Thomas Gleixner3ec8ce52018-07-13 16:23:26 +020027
Jonathan Corbet7358bb22016-10-26 16:14:52 -060028Here is a set of documents aimed at users who are trying to track down
29problems and bugs in particular.
30
31.. toctree::
32 :maxdepth: 1
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -020033
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030034 reporting-bugs
Jonathan Corbet7358bb22016-10-26 16:14:52 -060035 security-bugs
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030036 bug-hunting
Mauro Carvalho Chehabc7309042016-11-07 17:03:17 -020037 bug-bisect
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -020038 tainted-kernels
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030039 ramoops
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030040 dynamic-debug-howto
Jonathan Corbet7358bb22016-10-26 16:14:52 -060041 init
Mauro Carvalho Chehab330d4812019-06-13 15:21:39 -030042 kdump/index
Mauro Carvalho Chehab59809fe2019-06-18 16:06:08 -030043 perf/index
Jonathan Corbet7358bb22016-10-26 16:14:52 -060044
45This is the beginning of a section with information of interest to
46application developers. Documents covering various aspects of the kernel
47ABI will be found here.
48
49.. toctree::
50 :maxdepth: 1
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -020051
Jonathan Corbet7358bb22016-10-26 16:14:52 -060052 sysfs-rules
53
54The rest of this manual consists of various unordered guides on how to
55configure specific aspects of kernel behavior to your liking.
56
57.. toctree::
58 :maxdepth: 1
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -020059
Jonathan Corbet7358bb22016-10-26 16:14:52 -060060 initrd
Mauro Carvalho Chehabb6e9d0672018-05-09 10:18:45 -030061 cgroup-v2
Mauro Carvalho Chehabda82c922019-06-27 13:08:35 -030062 cgroup-v1/index
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030063 serial-console
64 braille-console
65 parport
66 md
67 module-signing
Mauro Carvalho Chehabd2bdd482019-06-18 16:03:23 -030068 rapidio
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030069 sysrq
70 unicode
71 vga-softcursor
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030072 binfmt-misc
73 mono
74 java
Mauro Carvalho Chehabfd77f6b2016-10-26 16:24:41 -020075 ras
Mauro Carvalho Chehabfe8703c2018-05-07 06:35:40 -030076 bcache
Mauro Carvalho Chehabe7751612019-06-18 11:47:10 -030077 blockdev/index
Darrick J. Wongd3091212018-10-05 19:11:59 -040078 ext4
Matthew Wilcox (Oracle)66f2a122019-07-02 13:54:38 -040079 binderfs
Rafael J. Wysocki2a0e4922017-03-13 23:59:57 +010080 pm/index
Mika Westerberg163f1512017-06-06 15:25:18 +030081 thunderbolt
Kees Cook504f2312017-05-13 04:51:43 -070082 LSM/index
Mike Rapoport3a3f7e22018-04-18 11:07:48 +030083 mm/index
Mauro Carvalho Chehabbf6b7a72019-06-18 16:33:50 -030084 namespaces/index
Alexey Budankov036c20c2018-11-27 11:16:29 +030085 perf-security
Changbin Du680e6ff2019-04-25 23:30:54 +080086 acpi/index
Mauro Carvalho Chehab83bbf6e2019-06-27 12:59:40 -030087 aoe/index
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -030088 btmrvl
89 clearing-warn-once
90 cpu-load
91 cputopology
Mauro Carvalho Chehab6cf2a732019-06-18 12:40:23 -030092 device-mapper/index
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -030093 efi-stub
94 highuid
95 hw_random
96 iostats
97 kernel-per-CPU-kthreads
Mauro Carvalho Chehab9e1cbed2019-06-13 15:07:43 -030098 laptops/index
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -030099 lcd-panel-cgram
100 ldm
101 lockup-watchdogs
102 numastat
103 pnp
104 rtc
105 svga
106 video-output
Markus Heiser6f2ec3a2016-10-26 08:23:16 +0200107
108.. only:: subproject and html
109
110 Indices
111 =======
112
113 * :ref:`genindex`