Documentation/admin-guide/index.rst

   1 The Linux kernel user's and administrator's guide
   2 =================================================
   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
   9 This initial section contains overall information, including the README
  10 file describing the kernel as a whole, documentation on kernel parameters,
  11 etc.
  12
  13 .. toctree::
  14    :maxdepth: 1
  15
  16    README
  17    kernel-parameters
  18    devices
  19    sysctl/index
  20
  21 This section describes CPU vulnerabilities and their mitigations.
  22
  23 .. toctree::
  24    :maxdepth: 1
  25
  26    hw-vuln/index
  27
  28 Here is a set of documents aimed at users who are trying to track down
  29 problems 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    perf/index
  43
  44 This is the beginning of a section with information of interest to
  45 application developers.  Documents covering various aspects of the kernel
  46 ABI will be found here.
  47
  48 .. toctree::
  49    :maxdepth: 1
  50
  51    sysfs-rules
  52
  53 The rest of this manual consists of various unordered guides on how to
  54 configure specific aspects of kernel behavior to your liking.
  55
  56 .. toctree::
  57    :maxdepth: 1
  58
  59    initrd
  60    cgroup-v2
  61    serial-console
  62    braille-console
  63    parport
  64    md
  65    module-signing
  66    rapidio
  67    sysrq
  68    unicode
  69    vga-softcursor
  70    binfmt-misc
  71    mono
  72    java
  73    ras
  74    bcache
  75    ext4
  76    binderfs
  77    pm/index
  78    thunderbolt
  79    LSM/index
  80    mm/index
  81    namespaces/index
  82    perf-security
  83    acpi/index
  84    device-mapper/index
  85    laptops/index
  86
  87 .. only::  subproject and html
  88
  89    Indices
  90    =======
  91
  92    * :ref:`genindex`