^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) ===========================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) Documentation for /proc/sys
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) ===========================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) Copyright (c) 1998, 1999, Rik van Riel <riel@nl.linux.org>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) ------------------------------------------------------------------------------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) 'Why', I hear you ask, 'would anyone even _want_ documentation
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) for them sysctl files? If anybody really needs it, it's all in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) the source...'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) Well, this documentation is written because some people either
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) don't know they need to tweak something, or because they don't
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) have the time or knowledge to read the source code.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) Furthermore, the programmers who built sysctl have built it to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) be actually used, not just for the fun of programming it :-)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) ------------------------------------------------------------------------------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) Legal blurb:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) As usual, there are two main things to consider:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) 1. you get what you pay for
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) 2. it's free
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) The consequences are that I won't guarantee the correctness of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) this document, and if you come to me complaining about how you
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) screwed up your system because of wrong documentation, I won't
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) feel sorry for you. I might even laugh at you...
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) But of course, if you _do_ manage to screw up your system using
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) only the sysctl options used in this file, I'd like to hear of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) it. Not only to have a great laugh, but also to make sure that
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) you're the last RTFMing person to screw up.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) In short, e-mail your suggestions, corrections and / or horror
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) stories to: <riel@nl.linux.org>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) Rik van Riel.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) --------------------------------------------------------------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) Introduction
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) ============
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) Sysctl is a means of configuring certain aspects of the kernel
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) at run-time, and the /proc/sys/ directory is there so that you
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) don't even need special tools to do it!
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) In fact, there are only four things needed to use these config
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) facilities:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) - a running Linux system
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) - root access
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) - common sense (this is especially hard to come by these days)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) - knowledge of what all those values mean
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) As a quick 'ls /proc/sys' will show, the directory consists of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) several (arch-dependent?) subdirs. Each subdir is mainly about
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) one part of the kernel, so you can do configuration on a piece
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) by piece basis, or just some 'thematic frobbing'.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) This documentation is about:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) =============== ===============================================================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) abi/ execution domains & personalities
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) debug/ <empty>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) dev/ device specific information (eg dev/cdrom/info)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) fs/ specific filesystems
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) filehandle, inode, dentry and quota tuning
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) binfmt_misc <Documentation/admin-guide/binfmt-misc.rst>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) kernel/ global kernel info / tuning
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) miscellaneous stuff
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) net/ networking stuff, for documentation look in:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) <Documentation/networking/>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) proc/ <empty>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) sunrpc/ SUN Remote Procedure Call (NFS)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) vm/ memory management tuning
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) buffer and cache management
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) user/ Per user per user namespace limits
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) =============== ===============================================================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) These are the subdirs I have on my system. There might be more
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) or other subdirs in another setup. If you see another dir, I'd
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) really like to hear about it :-)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) .. toctree::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) :maxdepth: 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) abi
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) fs
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) kernel
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) net
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) sunrpc
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) user
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) vm