blob: 5bfafcbb9562c106f78e49eab3309fc0fb9b7644 [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
Mauro Carvalho Chehaba7ee04b2020-10-30 08:40:36 +010021 abi
Mauro Carvalho Chehab63fdc462020-11-30 16:36:34 +010022 features
Mauro Carvalho Chehaba7ee04b2020-10-30 08:40:36 +010023
Thomas Gleixner65fd4cb2019-02-19 11:10:49 +010024This section describes CPU vulnerabilities and their mitigations.
Thomas Gleixner3ec8ce52018-07-13 16:23:26 +020025
26.. toctree::
27 :maxdepth: 1
28
Thomas Gleixner65fd4cb2019-02-19 11:10:49 +010029 hw-vuln/index
Thomas Gleixner3ec8ce52018-07-13 16:23:26 +020030
Jonathan Corbet7358bb22016-10-26 16:14:52 -060031Here is a set of documents aimed at users who are trying to track down
32problems and bugs in particular.
33
34.. toctree::
35 :maxdepth: 1
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -020036
Thorsten Leemhuis3e544d72020-12-04 07:43:49 +010037 reporting-issues
Thorsten Leemhuis1ecf3932022-02-16 07:51:33 +010038 reporting-regressions
Jonathan Corbet7358bb22016-10-26 16:14:52 -060039 security-bugs
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030040 bug-hunting
Mauro Carvalho Chehabc7309042016-11-07 17:03:17 -020041 bug-bisect
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -020042 tainted-kernels
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030043 ramoops
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030044 dynamic-debug-howto
Jonathan Corbet7358bb22016-10-26 16:14:52 -060045 init
Mauro Carvalho Chehab330d4812019-06-13 15:21:39 -030046 kdump/index
Mauro Carvalho Chehab59809fe2019-06-18 16:06:08 -030047 perf/index
Daniel W. S. Almeida00d7c1e2020-07-18 13:51:03 -030048 pstore-blk
Jonathan Corbet7358bb22016-10-26 16:14:52 -060049
50This is the beginning of a section with information of interest to
51application developers. Documents covering various aspects of the kernel
52ABI will be found here.
53
54.. toctree::
55 :maxdepth: 1
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -020056
Jonathan Corbet7358bb22016-10-26 16:14:52 -060057 sysfs-rules
58
59The rest of this manual consists of various unordered guides on how to
60configure specific aspects of kernel behavior to your liking.
61
62.. toctree::
63 :maxdepth: 1
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -020064
Changbin Du680e6ff2019-04-25 23:30:54 +080065 acpi/index
Mauro Carvalho Chehab83bbf6e2019-06-27 12:59:40 -030066 aoe/index
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +020067 auxdisplay/index
68 bcache
69 binderfs
70 binfmt-misc
71 blockdev/index
Masami Hiramatsu7b9b8162020-01-11 01:05:06 +090072 bootconfig
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +020073 braille-console
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -030074 btmrvl
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +020075 cgroup-v1/index
76 cgroup-v2
77 cifs/index
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -030078 clearing-warn-once
79 cpu-load
80 cputopology
Jonathan Neuschäferd4300c42019-10-12 19:11:10 +020081 dell_rbu
Mauro Carvalho Chehab6cf2a732019-06-18 12:40:23 -030082 device-mapper/index
Jonathan Neuschäfer320bfd92020-02-14 18:41:33 +010083 edid
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -030084 efi-stub
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +020085 ext4
Gabriel Krisman Bertazic0baf9a2021-10-25 16:27:46 -030086 filesystem-monitoring
Daniel W. S. Almeida2f123b9a2020-01-10 20:24:23 -030087 nfs/index
Mauro Carvalho Chehabc2746a12019-06-28 08:14:42 -030088 gpio/index
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -030089 highuid
90 hw_random
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +020091 initrd
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -030092 iostats
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +020093 java
94 jfs
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -030095 kernel-per-CPU-kthreads
Mauro Carvalho Chehab9e1cbed2019-06-13 15:07:43 -030096 laptops/index
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -030097 lcd-panel-cgram
98 ldm
99 lockup-watchdogs
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200100 LSM/index
101 md
Mauro Carvalho Chehab32e2eae2020-03-04 13:08:03 +0100102 media/index
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200103 mm/index
104 module-signing
105 mono
106 namespaces/index
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300107 numastat
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200108 parport
109 perf-security
110 pm/index
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300111 pnp
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200112 rapidio
113 ras
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300114 rtc
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200115 serial-console
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300116 svga
Gabriel Krisman Bertazia4452e672020-11-27 14:32:38 -0500117 syscall-user-dispatch
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200118 sysrq
119 thunderbolt
120 ufs
121 unicode
122 vga-softcursor
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300123 video-output
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200124 xfs
Markus Heiser6f2ec3a2016-10-26 08:23:16 +0200125
126.. only:: subproject and html
127
128 Indices
129 =======
130
131 * :ref:`genindex`