index.rst 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191
  1. =================================================
  2. The Linux kernel user's and administrator's guide
  3. =================================================
  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. General guides to kernel administration
  9. ---------------------------------------
  10. This initial section contains overall information, including the README
  11. file describing the kernel as a whole, documentation on kernel parameters,
  12. etc.
  13. .. toctree::
  14. :maxdepth: 1
  15. README
  16. devices
  17. features
  18. A big part of the kernel's administrative interface is the /proc and sysfs
  19. virtual filesystems; these documents describe how to interact with tem
  20. .. toctree::
  21. :maxdepth: 1
  22. sysfs-rules
  23. sysctl/index
  24. cputopology
  25. abi
  26. Security-related documentation:
  27. .. toctree::
  28. :maxdepth: 1
  29. hw-vuln/index
  30. LSM/index
  31. perf-security
  32. Booting the kernel
  33. ------------------
  34. .. toctree::
  35. :maxdepth: 1
  36. bootconfig
  37. kernel-parameters
  38. efi-stub
  39. initrd
  40. Tracking down and identifying problems
  41. --------------------------------------
  42. Here is a set of documents aimed at users who are trying to track down
  43. problems and bugs in particular.
  44. .. toctree::
  45. :maxdepth: 1
  46. reporting-issues
  47. reporting-regressions
  48. quickly-build-trimmed-linux
  49. verify-bugs-and-bisect-regressions
  50. bug-hunting
  51. bug-bisect
  52. tainted-kernels
  53. ramoops
  54. dynamic-debug-howto
  55. init
  56. kdump/index
  57. perf/index
  58. pstore-blk
  59. clearing-warn-once
  60. kernel-per-CPU-kthreads
  61. lockup-watchdogs
  62. RAS/index
  63. sysrq
  64. Core-kernel subsystems
  65. ----------------------
  66. These documents describe core-kernel administration interfaces that are
  67. likely to be of interest on almost any system.
  68. .. toctree::
  69. :maxdepth: 1
  70. cgroup-v2
  71. cgroup-v1/index
  72. cpu-load
  73. mm/index
  74. module-signing
  75. namespaces/index
  76. numastat
  77. pm/index
  78. syscall-user-dispatch
  79. Support for non-native binary formats. Note that some of these
  80. documents are ... old ...
  81. .. toctree::
  82. :maxdepth: 1
  83. binfmt-misc
  84. java
  85. mono
  86. Block-layer and filesystem administration
  87. -----------------------------------------
  88. .. toctree::
  89. :maxdepth: 1
  90. bcache
  91. binderfs
  92. blockdev/index
  93. cifs/index
  94. device-mapper/index
  95. ext4
  96. filesystem-monitoring
  97. nfs/index
  98. iostats
  99. jfs
  100. md
  101. ufs
  102. xfs
  103. Device-specific guides
  104. ----------------------
  105. How to configure your hardware within your Linux system.
  106. .. toctree::
  107. :maxdepth: 1
  108. acpi/index
  109. aoe/index
  110. auxdisplay/index
  111. braille-console
  112. btmrvl
  113. dell_rbu
  114. edid
  115. gpio/index
  116. hw_random
  117. laptops/index
  118. lcd-panel-cgram
  119. media/index
  120. nvme-multipath
  121. parport
  122. pnp
  123. rapidio
  124. rtc
  125. serial-console
  126. svga
  127. thermal/index
  128. thunderbolt
  129. vga-softcursor
  130. video-output
  131. Workload analysis
  132. -----------------
  133. This is the beginning of a section with information of interest to
  134. application developers and system integrators doing analysis of the
  135. Linux kernel for safety critical applications. Documents supporting
  136. analysis of kernel interactions with applications, and key kernel
  137. subsystems expectations will be found here.
  138. .. toctree::
  139. :maxdepth: 1
  140. workload-tracing
  141. Everything else
  142. ---------------
  143. A few hard-to-categorize and generally obsolete documents.
  144. .. toctree::
  145. :maxdepth: 1
  146. ldm
  147. unicode