xref: /linux/Documentation/admin-guide/index.rst (revision b8265621f4888af9494e1d685620871ec81bc33d)
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   acpi/index
61   aoe/index
62   auxdisplay/index
63   bcache
64   binderfs
65   binfmt-misc
66   blockdev/index
67   bootconfig
68   braille-console
69   btmrvl
70   cgroup-v1/index
71   cgroup-v2
72   cifs/index
73   clearing-warn-once
74   cpu-load
75   cputopology
76   dell_rbu
77   device-mapper/index
78   edid
79   efi-stub
80   ext4
81   nfs/index
82   gpio/index
83   highuid
84   hw_random
85   initrd
86   iostats
87   java
88   jfs
89   kernel-per-CPU-kthreads
90   laptops/index
91   lcd-panel-cgram
92   ldm
93   lockup-watchdogs
94   LSM/index
95   md
96   media/index
97   mm/index
98   module-signing
99   mono
100   namespaces/index
101   numastat
102   parport
103   perf-security
104   pm/index
105   pnp
106   rapidio
107   ras
108   rtc
109   serial-console
110   svga
111   sysrq
112   thunderbolt
113   ufs
114   unicode
115   vga-softcursor
116   video-output
117   wimax/index
118   xfs
119
120.. only::  subproject and html
121
122   Indices
123   =======
124
125   * :ref:`genindex`
126