xref: /linux/Documentation/admin-guide/index.rst (revision 34d5f4f269a21c7b5d64b4db0391d36511f1ac1a)
1The Linux kernel user's and administrator's guide
2=================================================
3
4The 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,
11etc.
12
13.. toctree::
14   :maxdepth: 1
15
16   README
17   kernel-parameters
18   devices
19   sysctl/index
20
21This section describes CPU vulnerabilities and their mitigations.
22
23.. toctree::
24   :maxdepth: 1
25
26   hw-vuln/index
27
28Here 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
33
34   reporting-bugs
35   security-bugs
36   bug-hunting
37   bug-bisect
38   tainted-kernels
39   ramoops
40   dynamic-debug-howto
41   init
42   kdump/index
43   perf/index
44
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
51
52   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
59
60   initrd
61   cgroup-v2
62   cgroup-v1/index
63   serial-console
64   braille-console
65   parport
66   md
67   module-signing
68   rapidio
69   sysrq
70   unicode
71   vga-softcursor
72   binfmt-misc
73   mono
74   java
75   ras
76   bcache
77   blockdev/index
78   ext4
79   binderfs
80   xfs
81   jfs
82   ufs
83   pm/index
84   thunderbolt
85   LSM/index
86   mm/index
87   namespaces/index
88   perf-security
89   acpi/index
90   aoe/index
91   btmrvl
92   clearing-warn-once
93   cpu-load
94   cputopology
95   device-mapper/index
96   efi-stub
97   gpio/index
98   highuid
99   hw_random
100   iostats
101   kernel-per-CPU-kthreads
102   laptops/index
103   lcd-panel-cgram
104   ldm
105   lockup-watchdogs
106   numastat
107   pnp
108   rtc
109   svga
110   video-output
111
112.. only::  subproject and html
113
114   Indices
115   =======
116
117   * :ref:`genindex`
118