xref: /linux/Documentation/admin-guide/index.rst (revision 0d3b051adbb72ed81956447d0d1e54d5943ee6f5)
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
21   abi
22   features
23
24This section describes CPU vulnerabilities and their mitigations.
25
26.. toctree::
27   :maxdepth: 1
28
29   hw-vuln/index
30
31Here 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
36
37   reporting-issues
38   Reporting bugs (obsolete) <reporting-bugs>
39   security-bugs
40   bug-hunting
41   bug-bisect
42   tainted-kernels
43   ramoops
44   dynamic-debug-howto
45   init
46   kdump/index
47   perf/index
48   pstore-blk
49
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
56
57   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
64
65   acpi/index
66   aoe/index
67   auxdisplay/index
68   bcache
69   binderfs
70   binfmt-misc
71   blockdev/index
72   bootconfig
73   braille-console
74   btmrvl
75   cgroup-v1/index
76   cgroup-v2
77   cifs/index
78   clearing-warn-once
79   cpu-load
80   cputopology
81   dell_rbu
82   device-mapper/index
83   edid
84   efi-stub
85   ext4
86   nfs/index
87   gpio/index
88   highuid
89   hw_random
90   initrd
91   iostats
92   java
93   jfs
94   kernel-per-CPU-kthreads
95   laptops/index
96   lcd-panel-cgram
97   ldm
98   lockup-watchdogs
99   LSM/index
100   md
101   media/index
102   mm/index
103   module-signing
104   mono
105   namespaces/index
106   numastat
107   parport
108   perf-security
109   pm/index
110   pnp
111   rapidio
112   ras
113   rtc
114   serial-console
115   svga
116   syscall-user-dispatch
117   sysrq
118   thunderbolt
119   ufs
120   unicode
121   vga-softcursor
122   video-output
123   xfs
124
125.. only::  subproject and html
126
127   Indices
128   =======
129
130   * :ref:`genindex`
131