| 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, |
| 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 |
| 19 | |
| 20 | Here is a set of documents aimed at users who are trying to track down |
| 21 | problems and bugs in particular. |
| 22 | |
| 23 | .. toctree:: |
| 24 | :maxdepth: 1 |
| 25 | |
| Mauro Carvalho Chehab | 9d85025 | 2016-09-21 09:51:11 -0300 | [diff] [blame] | 26 | reporting-bugs |
| Jonathan Corbet | 7358bb2 | 2016-10-26 16:14:52 -0600 | [diff] [blame^] | 27 | security-bugs |
| Mauro Carvalho Chehab | 9d85025 | 2016-09-21 09:51:11 -0300 | [diff] [blame] | 28 | bug-hunting |
| 29 | oops-tracing |
| 30 | ramoops |
| Mauro Carvalho Chehab | 9d85025 | 2016-09-21 09:51:11 -0300 | [diff] [blame] | 31 | dynamic-debug-howto |
| Jonathan Corbet | 7358bb2 | 2016-10-26 16:14:52 -0600 | [diff] [blame^] | 32 | init |
| 33 | |
| 34 | This is the beginning of a section with information of interest to |
| 35 | application developers. Documents covering various aspects of the kernel |
| 36 | ABI will be found here. |
| 37 | |
| 38 | .. toctree:: |
| 39 | :maxdepth: 1 |
| 40 | |
| 41 | sysfs-rules |
| 42 | |
| 43 | The rest of this manual consists of various unordered guides on how to |
| 44 | configure specific aspects of kernel behavior to your liking. |
| 45 | |
| 46 | .. toctree:: |
| 47 | :maxdepth: 1 |
| 48 | |
| 49 | initrd |
| Mauro Carvalho Chehab | 9d85025 | 2016-09-21 09:51:11 -0300 | [diff] [blame] | 50 | serial-console |
| 51 | braille-console |
| 52 | parport |
| 53 | md |
| 54 | module-signing |
| 55 | sysrq |
| 56 | unicode |
| 57 | vga-softcursor |
| Mauro Carvalho Chehab | 9d85025 | 2016-09-21 09:51:11 -0300 | [diff] [blame] | 58 | binfmt-misc |
| 59 | mono |
| 60 | java |
| 61 | bad-memory |
| 62 | basic-profiling |