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    kdump/index
  43    perf/index
  44
  45 This is the beginning of a section with information of interest to
  46 application developers.  Documents covering various aspects of the kernel
  47 ABI will be found here.
  48
  49 .. toctree::
  50    :maxdepth: 1
  51
  52    sysfs-rules
  53
  54 The rest of this manual consists of various unordered guides on how to
  55 configure 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    cifs/index
  81    xfs
  82    jfs
  83    ufs
  84    pm/index
  85    thunderbolt
  86    LSM/index
  87    mm/index
  88    namespaces/index
  89    perf-security
  90    acpi/index
  91    aoe/index
  92    btmrvl
  93    clearing-warn-once
  94    cpu-load
  95    cputopology
  96    device-mapper/index
  97    efi-stub
  98    gpio/index
  99    highuid
 100    hw_random
 101    iostats
 102    kernel-per-CPU-kthreads
 103    laptops/index
 104    auxdisplay/index
 105    lcd-panel-cgram
 106    ldm
 107    lockup-watchdogs
 108    numastat
 109    pnp
 110    rtc
 111    svga
 112    wimax/index
 113    video-output
 114
 115 .. only::  subproject and html
 116
 117    Indices
 118    =======
 119
 120    * :ref:`genindex`