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