Jonathan Corbet | 7358bb2 | 2016-10-26 16:14:52 -0600 | [diff] [blame] | 1 | The Linux kernel user's and administrator's guide |
| 2 | ================================================= |
Mauro Carvalho Chehab | 9d85025 | 2016-09-21 09:51:11 -0300 | [diff] [blame] | 3 | |
Jonathan Corbet | 7358bb2 | 2016-10-26 16:14:52 -0600 | [diff] [blame] | 4 | The following is a collection of user-oriented documents that have been |
| 5 | added to the kernel over time. There is, as yet, little overall order or |
| 6 | organization here — this material was not written to be a single, coherent |
| 7 | document! With luck things will improve quickly over time. |
| 8 | |
| 9 | This initial section contains overall information, including the README |
| 10 | file describing the kernel as a whole, documentation on kernel parameters, |
Mauro Carvalho Chehab | 337c188 | 2016-11-07 17:03:18 -0200 | [diff] [blame] | 11 | etc. |
Mauro Carvalho Chehab | 9d85025 | 2016-09-21 09:51:11 -0300 | [diff] [blame] | 12 | |
| 13 | .. toctree:: |
Jonathan Corbet | 7358bb2 | 2016-10-26 16:14:52 -0600 | [diff] [blame] | 14 | :maxdepth: 1 |
Mauro Carvalho Chehab | 9d85025 | 2016-09-21 09:51:11 -0300 | [diff] [blame] | 15 | |
| 16 | README |
Jonathan Corbet | 7358bb2 | 2016-10-26 16:14:52 -0600 | [diff] [blame] | 17 | kernel-parameters |
| 18 | devices |
Mauro Carvalho Chehab | 5704324 | 2019-04-22 16:48:00 -0300 | [diff] [blame] | 19 | sysctl/index |
Jonathan Corbet | 7358bb2 | 2016-10-26 16:14:52 -0600 | [diff] [blame] | 20 | |
Thomas Gleixner | 65fd4cb | 2019-02-19 11:10:49 +0100 | [diff] [blame] | 21 | This section describes CPU vulnerabilities and their mitigations. |
Thomas Gleixner | 3ec8ce5 | 2018-07-13 16:23:26 +0200 | [diff] [blame] | 22 | |
| 23 | .. toctree:: |
| 24 | :maxdepth: 1 |
| 25 | |
Thomas Gleixner | 65fd4cb | 2019-02-19 11:10:49 +0100 | [diff] [blame] | 26 | hw-vuln/index |
Thomas Gleixner | 3ec8ce5 | 2018-07-13 16:23:26 +0200 | [diff] [blame] | 27 | |
Jonathan Corbet | 7358bb2 | 2016-10-26 16:14:52 -0600 | [diff] [blame] | 28 | Here is a set of documents aimed at users who are trying to track down |
| 29 | problems and bugs in particular. |
| 30 | |
| 31 | .. toctree:: |
| 32 | :maxdepth: 1 |
Mauro Carvalho Chehab | 337c188 | 2016-11-07 17:03:18 -0200 | [diff] [blame] | 33 | |
Mauro Carvalho Chehab | 9d85025 | 2016-09-21 09:51:11 -0300 | [diff] [blame] | 34 | reporting-bugs |
Jonathan Corbet | 7358bb2 | 2016-10-26 16:14:52 -0600 | [diff] [blame] | 35 | security-bugs |
Mauro Carvalho Chehab | 9d85025 | 2016-09-21 09:51:11 -0300 | [diff] [blame] | 36 | bug-hunting |
Mauro Carvalho Chehab | c730904 | 2016-11-07 17:03:17 -0200 | [diff] [blame] | 37 | bug-bisect |
Mauro Carvalho Chehab | 337c188 | 2016-11-07 17:03:18 -0200 | [diff] [blame] | 38 | tainted-kernels |
Mauro Carvalho Chehab | 9d85025 | 2016-09-21 09:51:11 -0300 | [diff] [blame] | 39 | ramoops |
Mauro Carvalho Chehab | 9d85025 | 2016-09-21 09:51:11 -0300 | [diff] [blame] | 40 | dynamic-debug-howto |
Jonathan Corbet | 7358bb2 | 2016-10-26 16:14:52 -0600 | [diff] [blame] | 41 | init |
Mauro Carvalho Chehab | 330d481 | 2019-06-13 15:21:39 -0300 | [diff] [blame] | 42 | kdump/index |
Mauro Carvalho Chehab | 59809fe | 2019-06-18 16:06:08 -0300 | [diff] [blame] | 43 | perf/index |
Jonathan Corbet | 7358bb2 | 2016-10-26 16:14:52 -0600 | [diff] [blame] | 44 | |
| 45 | This is the beginning of a section with information of interest to |
| 46 | application developers. Documents covering various aspects of the kernel |
| 47 | ABI will be found here. |
| 48 | |
| 49 | .. toctree:: |
| 50 | :maxdepth: 1 |
Mauro Carvalho Chehab | 337c188 | 2016-11-07 17:03:18 -0200 | [diff] [blame] | 51 | |
Jonathan Corbet | 7358bb2 | 2016-10-26 16:14:52 -0600 | [diff] [blame] | 52 | sysfs-rules |
| 53 | |
| 54 | The rest of this manual consists of various unordered guides on how to |
| 55 | configure specific aspects of kernel behavior to your liking. |
| 56 | |
| 57 | .. toctree:: |
| 58 | :maxdepth: 1 |
Mauro Carvalho Chehab | 337c188 | 2016-11-07 17:03:18 -0200 | [diff] [blame] | 59 | |
Jonathan Corbet | 7358bb2 | 2016-10-26 16:14:52 -0600 | [diff] [blame] | 60 | initrd |
Mauro Carvalho Chehab | b6e9d067 | 2018-05-09 10:18:45 -0300 | [diff] [blame] | 61 | cgroup-v2 |
Mauro Carvalho Chehab | da82c92 | 2019-06-27 13:08:35 -0300 | [diff] [blame] | 62 | cgroup-v1/index |
Mauro Carvalho Chehab | 9d85025 | 2016-09-21 09:51:11 -0300 | [diff] [blame] | 63 | serial-console |
| 64 | braille-console |
| 65 | parport |
| 66 | md |
| 67 | module-signing |
Mauro Carvalho Chehab | d2bdd48 | 2019-06-18 16:03:23 -0300 | [diff] [blame] | 68 | rapidio |
Mauro Carvalho Chehab | 9d85025 | 2016-09-21 09:51:11 -0300 | [diff] [blame] | 69 | sysrq |
| 70 | unicode |
| 71 | vga-softcursor |
Mauro Carvalho Chehab | 9d85025 | 2016-09-21 09:51:11 -0300 | [diff] [blame] | 72 | binfmt-misc |
| 73 | mono |
| 74 | java |
Mauro Carvalho Chehab | fd77f6b | 2016-10-26 16:24:41 -0200 | [diff] [blame] | 75 | ras |
Mauro Carvalho Chehab | fe8703c | 2018-05-07 06:35:40 -0300 | [diff] [blame] | 76 | bcache |
Mauro Carvalho Chehab | e775161 | 2019-06-18 11:47:10 -0300 | [diff] [blame] | 77 | blockdev/index |
Darrick J. Wong | d309121 | 2018-10-05 19:11:59 -0400 | [diff] [blame] | 78 | ext4 |
Matthew Wilcox (Oracle) | 66f2a12 | 2019-07-02 13:54:38 -0400 | [diff] [blame] | 79 | binderfs |
Rafael J. Wysocki | 2a0e492 | 2017-03-13 23:59:57 +0100 | [diff] [blame] | 80 | pm/index |
Mika Westerberg | 163f151 | 2017-06-06 15:25:18 +0300 | [diff] [blame] | 81 | thunderbolt |
Kees Cook | 504f231 | 2017-05-13 04:51:43 -0700 | [diff] [blame] | 82 | LSM/index |
Mike Rapoport | 3a3f7e2 | 2018-04-18 11:07:48 +0300 | [diff] [blame] | 83 | mm/index |
Mauro Carvalho Chehab | bf6b7a7 | 2019-06-18 16:33:50 -0300 | [diff] [blame] | 84 | namespaces/index |
Alexey Budankov | 036c20c | 2018-11-27 11:16:29 +0300 | [diff] [blame] | 85 | perf-security |
Changbin Du | 680e6ff | 2019-04-25 23:30:54 +0800 | [diff] [blame] | 86 | acpi/index |
Mauro Carvalho Chehab | 83bbf6e | 2019-06-27 12:59:40 -0300 | [diff] [blame] | 87 | aoe/index |
Mauro Carvalho Chehab | 4f4cfa6 | 2019-06-27 14:56:51 -0300 | [diff] [blame^] | 88 | btmrvl |
| 89 | clearing-warn-once |
| 90 | cpu-load |
| 91 | cputopology |
Mauro Carvalho Chehab | 6cf2a73 | 2019-06-18 12:40:23 -0300 | [diff] [blame] | 92 | device-mapper/index |
Mauro Carvalho Chehab | 4f4cfa6 | 2019-06-27 14:56:51 -0300 | [diff] [blame^] | 93 | efi-stub |
| 94 | highuid |
| 95 | hw_random |
| 96 | iostats |
| 97 | kernel-per-CPU-kthreads |
Mauro Carvalho Chehab | 9e1cbed | 2019-06-13 15:07:43 -0300 | [diff] [blame] | 98 | laptops/index |
Mauro Carvalho Chehab | 4f4cfa6 | 2019-06-27 14:56:51 -0300 | [diff] [blame^] | 99 | lcd-panel-cgram |
| 100 | ldm |
| 101 | lockup-watchdogs |
| 102 | numastat |
| 103 | pnp |
| 104 | rtc |
| 105 | svga |
| 106 | video-output |
Markus Heiser | 6f2ec3a | 2016-10-26 08:23:16 +0200 | [diff] [blame] | 107 | |
| 108 | .. only:: subproject and html |
| 109 | |
| 110 | Indices |
| 111 | ======= |
| 112 | |
| 113 | * :ref:`genindex` |