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 | |
Mauro Carvalho Chehab | a7ee04b | 2020-10-30 08:40:36 +0100 | [diff] [blame] | 21 | abi |
Mauro Carvalho Chehab | 63fdc46 | 2020-11-30 16:36:34 +0100 | [diff] [blame] | 22 | features |
Mauro Carvalho Chehab | a7ee04b | 2020-10-30 08:40:36 +0100 | [diff] [blame] | 23 | |
Thomas Gleixner | 65fd4cb | 2019-02-19 11:10:49 +0100 | [diff] [blame] | 24 | This section describes CPU vulnerabilities and their mitigations. |
Thomas Gleixner | 3ec8ce5 | 2018-07-13 16:23:26 +0200 | [diff] [blame] | 25 | |
| 26 | .. toctree:: |
| 27 | :maxdepth: 1 |
| 28 | |
Thomas Gleixner | 65fd4cb | 2019-02-19 11:10:49 +0100 | [diff] [blame] | 29 | hw-vuln/index |
Thomas Gleixner | 3ec8ce5 | 2018-07-13 16:23:26 +0200 | [diff] [blame] | 30 | |
Jonathan Corbet | 7358bb2 | 2016-10-26 16:14:52 -0600 | [diff] [blame] | 31 | Here is a set of documents aimed at users who are trying to track down |
| 32 | problems and bugs in particular. |
| 33 | |
| 34 | .. toctree:: |
| 35 | :maxdepth: 1 |
Mauro Carvalho Chehab | 337c188 | 2016-11-07 17:03:18 -0200 | [diff] [blame] | 36 | |
Thorsten Leemhuis | 3e544d7 | 2020-12-04 07:43:49 +0100 | [diff] [blame] | 37 | reporting-issues |
Thorsten Leemhuis | 1ecf393 | 2022-02-16 07:51:33 +0100 | [diff] [blame] | 38 | reporting-regressions |
Jonathan Corbet | 7358bb2 | 2016-10-26 16:14:52 -0600 | [diff] [blame] | 39 | security-bugs |
Mauro Carvalho Chehab | 9d85025 | 2016-09-21 09:51:11 -0300 | [diff] [blame] | 40 | bug-hunting |
Mauro Carvalho Chehab | c730904 | 2016-11-07 17:03:17 -0200 | [diff] [blame] | 41 | bug-bisect |
Mauro Carvalho Chehab | 337c188 | 2016-11-07 17:03:18 -0200 | [diff] [blame] | 42 | tainted-kernels |
Mauro Carvalho Chehab | 9d85025 | 2016-09-21 09:51:11 -0300 | [diff] [blame] | 43 | ramoops |
Mauro Carvalho Chehab | 9d85025 | 2016-09-21 09:51:11 -0300 | [diff] [blame] | 44 | dynamic-debug-howto |
Jonathan Corbet | 7358bb2 | 2016-10-26 16:14:52 -0600 | [diff] [blame] | 45 | init |
Mauro Carvalho Chehab | 330d481 | 2019-06-13 15:21:39 -0300 | [diff] [blame] | 46 | kdump/index |
Mauro Carvalho Chehab | 59809fe | 2019-06-18 16:06:08 -0300 | [diff] [blame] | 47 | perf/index |
Daniel W. S. Almeida | 00d7c1e | 2020-07-18 13:51:03 -0300 | [diff] [blame] | 48 | pstore-blk |
Jonathan Corbet | 7358bb2 | 2016-10-26 16:14:52 -0600 | [diff] [blame] | 49 | |
| 50 | This is the beginning of a section with information of interest to |
| 51 | application developers. Documents covering various aspects of the kernel |
| 52 | ABI will be found here. |
| 53 | |
| 54 | .. toctree:: |
| 55 | :maxdepth: 1 |
Mauro Carvalho Chehab | 337c188 | 2016-11-07 17:03:18 -0200 | [diff] [blame] | 56 | |
Jonathan Corbet | 7358bb2 | 2016-10-26 16:14:52 -0600 | [diff] [blame] | 57 | sysfs-rules |
| 58 | |
| 59 | The rest of this manual consists of various unordered guides on how to |
| 60 | configure specific aspects of kernel behavior to your liking. |
| 61 | |
| 62 | .. toctree:: |
| 63 | :maxdepth: 1 |
Mauro Carvalho Chehab | 337c188 | 2016-11-07 17:03:18 -0200 | [diff] [blame] | 64 | |
Changbin Du | 680e6ff | 2019-04-25 23:30:54 +0800 | [diff] [blame] | 65 | acpi/index |
Mauro Carvalho Chehab | 83bbf6e | 2019-06-27 12:59:40 -0300 | [diff] [blame] | 66 | aoe/index |
Jonathan Neuschäfer | 2c1d7ff | 2019-10-12 19:11:09 +0200 | [diff] [blame] | 67 | auxdisplay/index |
| 68 | bcache |
| 69 | binderfs |
| 70 | binfmt-misc |
| 71 | blockdev/index |
Masami Hiramatsu | 7b9b816 | 2020-01-11 01:05:06 +0900 | [diff] [blame] | 72 | bootconfig |
Jonathan Neuschäfer | 2c1d7ff | 2019-10-12 19:11:09 +0200 | [diff] [blame] | 73 | braille-console |
Mauro Carvalho Chehab | 4f4cfa6 | 2019-06-27 14:56:51 -0300 | [diff] [blame] | 74 | btmrvl |
Jonathan Neuschäfer | 2c1d7ff | 2019-10-12 19:11:09 +0200 | [diff] [blame] | 75 | cgroup-v1/index |
| 76 | cgroup-v2 |
| 77 | cifs/index |
Mauro Carvalho Chehab | 4f4cfa6 | 2019-06-27 14:56:51 -0300 | [diff] [blame] | 78 | clearing-warn-once |
| 79 | cpu-load |
| 80 | cputopology |
Jonathan Neuschäfer | d4300c4 | 2019-10-12 19:11:10 +0200 | [diff] [blame] | 81 | dell_rbu |
Mauro Carvalho Chehab | 6cf2a73 | 2019-06-18 12:40:23 -0300 | [diff] [blame] | 82 | device-mapper/index |
Jonathan Neuschäfer | 320bfd9 | 2020-02-14 18:41:33 +0100 | [diff] [blame] | 83 | edid |
Mauro Carvalho Chehab | 4f4cfa6 | 2019-06-27 14:56:51 -0300 | [diff] [blame] | 84 | efi-stub |
Jonathan Neuschäfer | 2c1d7ff | 2019-10-12 19:11:09 +0200 | [diff] [blame] | 85 | ext4 |
Gabriel Krisman Bertazi | c0baf9a | 2021-10-25 16:27:46 -0300 | [diff] [blame] | 86 | filesystem-monitoring |
Daniel W. S. Almeida | 2f123b9a | 2020-01-10 20:24:23 -0300 | [diff] [blame] | 87 | nfs/index |
Mauro Carvalho Chehab | c2746a1 | 2019-06-28 08:14:42 -0300 | [diff] [blame] | 88 | gpio/index |
Mauro Carvalho Chehab | 4f4cfa6 | 2019-06-27 14:56:51 -0300 | [diff] [blame] | 89 | highuid |
| 90 | hw_random |
Jonathan Neuschäfer | 2c1d7ff | 2019-10-12 19:11:09 +0200 | [diff] [blame] | 91 | initrd |
Mauro Carvalho Chehab | 4f4cfa6 | 2019-06-27 14:56:51 -0300 | [diff] [blame] | 92 | iostats |
Jonathan Neuschäfer | 2c1d7ff | 2019-10-12 19:11:09 +0200 | [diff] [blame] | 93 | java |
| 94 | jfs |
Mauro Carvalho Chehab | 4f4cfa6 | 2019-06-27 14:56:51 -0300 | [diff] [blame] | 95 | kernel-per-CPU-kthreads |
Mauro Carvalho Chehab | 9e1cbed | 2019-06-13 15:07:43 -0300 | [diff] [blame] | 96 | laptops/index |
Mauro Carvalho Chehab | 4f4cfa6 | 2019-06-27 14:56:51 -0300 | [diff] [blame] | 97 | lcd-panel-cgram |
| 98 | ldm |
| 99 | lockup-watchdogs |
Jonathan Neuschäfer | 2c1d7ff | 2019-10-12 19:11:09 +0200 | [diff] [blame] | 100 | LSM/index |
| 101 | md |
Mauro Carvalho Chehab | 32e2eae | 2020-03-04 13:08:03 +0100 | [diff] [blame] | 102 | media/index |
Jonathan Neuschäfer | 2c1d7ff | 2019-10-12 19:11:09 +0200 | [diff] [blame] | 103 | mm/index |
| 104 | module-signing |
| 105 | mono |
| 106 | namespaces/index |
Mauro Carvalho Chehab | 4f4cfa6 | 2019-06-27 14:56:51 -0300 | [diff] [blame] | 107 | numastat |
Jonathan Neuschäfer | 2c1d7ff | 2019-10-12 19:11:09 +0200 | [diff] [blame] | 108 | parport |
| 109 | perf-security |
| 110 | pm/index |
Mauro Carvalho Chehab | 4f4cfa6 | 2019-06-27 14:56:51 -0300 | [diff] [blame] | 111 | pnp |
Jonathan Neuschäfer | 2c1d7ff | 2019-10-12 19:11:09 +0200 | [diff] [blame] | 112 | rapidio |
| 113 | ras |
Mauro Carvalho Chehab | 4f4cfa6 | 2019-06-27 14:56:51 -0300 | [diff] [blame] | 114 | rtc |
Jonathan Neuschäfer | 2c1d7ff | 2019-10-12 19:11:09 +0200 | [diff] [blame] | 115 | serial-console |
Mauro Carvalho Chehab | 4f4cfa6 | 2019-06-27 14:56:51 -0300 | [diff] [blame] | 116 | svga |
Gabriel Krisman Bertazi | a4452e67 | 2020-11-27 14:32:38 -0500 | [diff] [blame] | 117 | syscall-user-dispatch |
Jonathan Neuschäfer | 2c1d7ff | 2019-10-12 19:11:09 +0200 | [diff] [blame] | 118 | sysrq |
| 119 | thunderbolt |
| 120 | ufs |
| 121 | unicode |
| 122 | vga-softcursor |
Mauro Carvalho Chehab | 4f4cfa6 | 2019-06-27 14:56:51 -0300 | [diff] [blame] | 123 | video-output |
Jonathan Neuschäfer | 2c1d7ff | 2019-10-12 19:11:09 +0200 | [diff] [blame] | 124 | xfs |
Markus Heiser | 6f2ec3a | 2016-10-26 08:23:16 +0200 | [diff] [blame] | 125 | |
| 126 | .. only:: subproject and html |
| 127 | |
| 128 | Indices |
| 129 | ======= |
| 130 | |
| 131 | * :ref:`genindex` |