aboutsummaryrefslogtreecommitdiff
path: root/share/man/man9/sysctl.9
Commit message (Collapse)AuthorAgeFilesLines
* sysctl.9: Constant integer example: Do not promote 'debug.sizeof'Olivier Certner2025-05-121-2/+2
| | | | | | | Replace it with another one, selected from current in-tree uses. MFC after: 1 day Sponsored by: The FreeBSD Foundation
* SYSCTL_ADD_CONST_STRING(9): HISTORYDavid E. O'Brien2024-04-031-0/+3
| | | | Add information of where one may use this API.
* SYSCTL(9): correct typoDavid E. O'Brien2024-03-151-1/+1
|
* sysctl(9): Fix typo translatation -> translationDamien Broka2023-09-121-1/+1
| | | | | MFC after: 3 days Pull Request: https://github.com/freebsd/freebsd-src/pull/839
* Remove $FreeBSD$: two-line nroff patternWarner Losh2023-08-161-2/+0
| | | | Remove /^\.\\"\n\.\\"\s*\$FreeBSD\$$\n/
* sysctl: Document formats for uint8_t and uint16_t in sysctl(9)Stéphane Rochoy2023-07-011-0/+8
| | | | | | | Was missing from c3220d0b6d72a1ed0ccfa188f0dfceef74421ab9. Reviewed by: imp Pull Request: https://github.com/freebsd/freebsd-src/pull/719
* sysctl.9: put negative sense sysctl note in own paragraphEd Maste2021-08-171-0/+1
| | | | | | | | | | The sysctl man page cautions against negative-sense boolean sysctls (foobar_disable), but it gets lost at the end of a large paragraph. Move it to a separate paragraph in an attempt to make it more clear. This man page could use a more holistic review and edit pass. This change is simple and straightforward and I hope provides a small but immediate benefit.
* sysctl(9): Fix a few mandoc related issuesGordon Bergling2020-12-191-2/+2
| | | | | | | | | | - missing comma before name: Nm SYSCTL_UQUAD - bad NAME section content: text MFC after: 1 week Notes: svn path=/head/; revision=368798
* add Xr to device_get_sysctl(9) to make this easier to findJohn-Mark Gurney2020-09-011-1/+2
| | | | Notes: svn path=/head/; revision=365062
* Sort UMA macros and create MLINKS for themMateusz Piotrowski2020-03-231-3/+3
| | | | | | | | | | | | This patch is a follow-up to r344518. Reported by: ngie Reviewed by: hselasky Differential Revision: https://reviews.freebsd.org/D24165 Notes: svn path=/head/; revision=359238
* Trim a spurious blank line I added in r348969.John Baldwin2019-08-191-1/+0
| | | | | | | | | I did not bump .Dd since there is no content change. MFC after: 3 days Notes: svn path=/head/; revision=351224
* Make the warning intervals for deprecated crypto algorithms tunable.John Baldwin2019-06-111-0/+30
| | | | | | | | | | | | | | | | | New sysctl/tunables can now set the interval (in seconds) between rate-limited crypto warnings. The new sysctls are: - kern.cryptodev_warn_interval for /dev/crypto - net.inet.ipsec.crypto_warn_interval for IPsec - kern.kgssapi_warn_interval for KGSSAPI Reviewed by: cem MFC after: 1 month Relnotes: yes Sponsored by: Chelsio Communications Differential Revision: https://reviews.freebsd.org/D20555 Notes: svn path=/head/; revision=348970
* Document sysctl nodes that translate their values.John Baldwin2019-06-111-1/+54
| | | | | | | | | | | | | This documents the behavior of sysctl_msec_to_ticks and SYSCTL_{ADD,}_SBINTIME_[UM]SEC. Reviewed by: cem MFC after: 1 week Sponsored by: Chelsio Communications Differential Revision: https://reviews.freebsd.org/D20596 Notes: svn path=/head/; revision=348969
* iflib: mark isc_driver_version as constantEric Joyner2019-03-191-0/+20
| | | | | | | | | | | | | | | | From Jake: The iflib core never modifies the isc_driver_version string. Allow drivers to safely assign pointers to constant buffers by marking this parameter const. Submitted by: Jacob Keller <jacob.e.keller@intel.com> Reviewed by: erj@, gallatin@, jhb@ MFC after: 1 week Sponsored by: Intel Corporation Differential Revision: https://reviews.freebsd.org/D19577 Notes: svn path=/head/; revision=345312
* Add missing types to the sysctl(9) manual pageMateusz Piotrowski2019-02-251-5/+114
| | | | | | | | | | | | | | | | | | | | | | | | | Update the diff to include other missing sysctl types found in sysctl.h. Some of these sysctls are already documented in other pages (e.g counter(9) and ZONE(9)), but they should at least be mentioned here for completeness. This patch now documents all of the following: - SYSCTL_BOOL/SYSCTL_ADD_BOOL - SYSCTL_COUNTER_U64/SYSCTL_ADD_COUNTER_U64 - SYSCTL_COUNTER_U64_ARRAY/SYSCTL_ADD_COUNTER_U64_ARRAY - SYSCTL_SBINTIME_MSEC/SYSCTL_ADD_SBINTIME_MSEC - SYSCTL_SBINTIME_USEC/SYSCTL_ADD_SBINTIME_USEC - SYSCTL_UMA_CUR/SYSCTL_ADD_UMA_CUR - SYSCTL_UMA_MAX/SYSCTL_ADD_UMA_MAX Submitted by: mhorne063_gmail.com Reviewed by: bcr, hselasky Approved by: bcr (doc), hselasky (src) Approved by: krion (mentor, implicit), mat (mentor, implicit) Differential Revision: https://reviews.freebsd.org/D19272 Notes: svn path=/head/; revision=344518
* Update the sysctl(9) manpage to indicate that <sys/param.h> is requiredJonathan T. Looney2018-06-011-2/+2
| | | | | | | | | | instead of <sys/types.h>. (<sys/sysctl.h> includes NULL, which is defined with <sys/param.h> and not <sys/types.h>.) Sponsored by: Netflix Notes: svn path=/head/; revision=334490
* Mention that CTLFLAG_MPSAFE is only for _PROC entries.Warner Losh2018-03-041-0/+3
| | | | Notes: svn path=/head/; revision=330372
* Add documentation for CTLFLAG_MPSAFE.Warner Losh2018-03-041-1/+6
| | | | Notes: svn path=/head/; revision=330368
* sysctl.9: document CTLFLAG_CAPRD and CTLFLAG_CAPWREd Maste2017-10-101-1/+5
| | | | | | | | | Reported by: Shawn Webb MFC after: 1 week Sponsored by: The FreeBSD Foundation Notes: svn path=/head/; revision=324509
* Add support for attaching aggregation labels to sysctl objects.Ed Schouten2016-12-141-1/+32
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I'm currently working on writing a metrics exporter for the Prometheus monitoring system to provide access to sysctl metrics. Prometheus and sysctl have some structural differences: - sysctl is a tree of string component names. - Prometheus uses a flat namespace for its metrics, but allows you to attach labels with values to them, so that you can do aggregation. An initial version of my exporter simply translated hw.acpi.thermal.tz1.temperature to sysctl_hw_acpi_thermal_tz1_temperature_celcius while we should ideally have sysctl_hw_acpi_thermal_temperature_celcius{thermal_zone="tz1"} allowing you to graph all thermal zones on a system in one go. The change presented in this commit adds support for accomplishing this, by providing the ability to attach labels to nodes. In the example I gave above, the label "thermal_zone" would be attached to "tz1". As this is a feature that will only be used very rarely, I decided to not change the KPI too aggressively. Discussed on: hackers@ Reviewed by: cem Differential Revision: https://reviews.freebsd.org/D8775 Notes: svn path=/head/; revision=310051
* sysctl.9: add missing underscore (SYSCTL_HANDLERARGS -> SYSCTL_HANDLER_ARGS)Andriy Voskoboinyk2016-09-291-1/+1
| | | | Notes: svn path=/head/; revision=306450
* Fix a bunch of "sentence not on new line" warnings in section 9.Edward Tomasz Napierala2016-06-081-2/+4
| | | | | | | MFC after: 1 month Notes: svn path=/head/; revision=301590
* Spelling fixes supplied by pfg@, detected with codespell, plusWarren Block2016-05-011-4/+4
| | | | | | | | | additional misspellings detected by igor. MFC after: 1 week Notes: svn path=/head/; revision=298904
* Round out SYSCTL macros to the full set of fixed-width typesConrad Meyer2015-11-071-11/+115
| | | | | | | | | | | | | | | | | | | | | | | | | Add S8, S16, S32, and U32 types; add SYSCTL*() macros for them, as well as for the existing 64-bit types. (While SYSCTL*QUAD and UQUAD macros already exist, they do not take the same sort of 'val' parameter that the other macros do.) Clean up the documented "types" in the sysctl.9 document. (These are macros and thus not real types, but the manual page documents intent.) The sysctl_add_oid(9) arg2 has been bumped from intptr_t to intmax_t to accommodate 64-bit types on 32-bit pointer architectures. This is just the kernel support piece; the userspace sysctl(1) support will follow in a later patch. Submitted by: Ravi Pokala <rpokala@panasas.com> Reviewed by: cem Relnotes: no Sponsored by: Panasas Differential Revision: https://reviews.freebsd.org/D4091 Notes: svn path=/head/; revision=290475
* sysctl(9): Document U8/U16 types from r289773Conrad Meyer2015-10-231-1/+37
| | | | | | | | Suggested by: ngie Sponsored by: EMC / Isilon Storage Division Notes: svn path=/head/; revision=289831
* Teach sysctl about the new optional suffix after IK to specifyWarner Losh2015-07-291-27/+25
| | | | | | | | | | precision. Update input as well. Add IK to the manual (it was missing completely). Differential Revision: https://reviews.freebsd.org/D3181 Notes: svn path=/head/; revision=285994
* Fix multiple incorrect SYSCTL arguments in the kernel:Hans Petter Selasky2014-10-211-11/+19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Wrong integer type was specified. - Wrong or missing "access" specifier. The "access" specifier sometimes included the SYSCTL type, which it should not, except for procedural SYSCTL nodes. - Logical OR where binary OR was expected. - Properly assert the "access" argument passed to all SYSCTL macros, using the CTASSERT macro. This applies to both static- and dynamically created SYSCTLs. - Properly assert the the data type for both static and dynamic SYSCTLs. In the case of static SYSCTLs we only assert that the data pointed to by the SYSCTL data pointer has the correct size, hence there is no easy way to assert types in the C language outside a C-function. - Rewrote some code which doesn't pass a constant "access" specifier when creating dynamic SYSCTL nodes, which is now a requirement. - Updated "EXAMPLES" section in SYSCTL manual page. MFC after: 3 days Sponsored by: Mellanox Technologies Notes: svn path=/head/; revision=273377
* Add a brief description of CTLFLAG_VNET flag. Since the VIMAGE isGleb Smirnoff2014-09-151-1/+3
| | | | | | | | absolutely not documented, I see no reason in long descriptions here. Notes: svn path=/head/; revision=271615
* - Add missing "Joel Dahl2014-09-091-44/+44
| | | | | | | - Sort sections Notes: svn path=/head/; revision=271314
* - Spelling correctionsHans Petter Selasky2014-08-021-6/+6
| | | | | | | | Suggested by: Garrett Cooper <yaneurabeya@gmail.com> PR: 192101 Notes: svn path=/head/; revision=269439
* - Updated SYSCTL manual pages after recent changes to the kernelHans Petter Selasky2014-07-311-46/+439
| | | | | | | | | | | | | SYSCTL code. Added description of new macros and functions. - Merged dynamic and static SYSCTL related content into a single manual page, hence parameters and functionality is very much the same. - Uppercased all occurrences of "OID". - Updated all SYSCTL examples. PR: 192101 Notes: svn path=/head/; revision=269344
* - Document the UQUAD sysctl variants.John Baldwin2013-09-121-9/+17
| | | | | | | | | | | | | - Clarify that exactly one of the "access" flags is required and list the optional flags in a separate list. Prefer bundling CTLFLAG_TUN into the access flag by not documenting it as an optional flag to set. Approved by: re (glebius) MFC after: 1 week Notes: svn path=/head/; revision=255498
* Typo and mdoc(7) style fixes.Glen Barber2012-05-201-1/+1
| | | | | | | | | PR: 168117 Submitted by: Nobuyuki Koganemaru (kogane&jp!freebsd!org) MFC after: 3 days Notes: svn path=/head/; revision=235693
* Correct the description for CTLFLAG_TUN and CTLFLAG_RDTUN, the declaring of aAndrew Thompson2012-02-291-2/+2
| | | | | | | | | | system tunable has never been implemented. This flag is only used by sysctl(8) to provide a helpful error message. Discussed with: dwhite, kan Notes: svn path=/head/; revision=232321
* Introduce signed and unsigned version of CTLTYPE_QUAD, renamingMatthew D Fleming2011-01-191-1/+3
| | | | | | | existing uses. Rename sysctl_handle_quad() to sysctl_handle_64(). Notes: svn path=/head/; revision=217616
* sysctl(8) should use the CTLTYPE to determine the type of data whenMatthew D Fleming2011-01-191-7/+0
| | | | | | | | | | | | | | reading. (This was already done for writing to a sysctl). This requires all SYSCTL setups to specify a type. Most of them are now checked at compile-time. Remove SYSCTL_*X* sysctl additions as the print being in hex should be controlled by the -x flag to sysctl(8). Succested by: bde Notes: svn path=/head/; revision=217586
* Xref sysctl(3)Gavin Atkinson2010-01-161-1/+2
| | | | | | | Approved by: ed (mentor) Notes: svn path=/head/; revision=202443
* Implement the following macros for completeness:Pawel Jakub Dawidek2008-07-211-2/+5
| | | | | | | | | | | | SYSCTL_QUAD() SYSCTL_ADD_QUAD() TUNABLE_QUAD() TUNABLE_QUAD_FETCH() Now we can use 64bit tunables on 32bit systems. Notes: svn path=/head/; revision=180661
* Spelling fixes.Mike Pritchard2006-12-141-1/+1
| | | | Notes: svn path=/head/; revision=165213
* Add a guideline for naming new sysctl nodes.Yaroslav Tykhiy2006-11-231-2/+26
| | | | | | | Discussed in: cvs-src (some time ago) Notes: svn path=/head/; revision=164560
* Revise markup.Ruslan Ermilov2006-09-301-140/+54
| | | | Notes: svn path=/head/; revision=162877
* Add an extension to the UINT & ULONG types. The XINT & XLONG types behaveDavid E. O'Brien2006-08-121-2/+25
| | | | | | | the same, except sysctl(8) will print out the values in hex. Notes: svn path=/head/; revision=161256
* Fix bug preventing the proper displaying of the CTLFLAG_WR option.David E. O'Brien2006-08-121-1/+1
| | | | Notes: svn path=/head/; revision=161253
* Fix a couple of typos and other minor nitsGiorgos Keramidas2006-04-281-4/+4
| | | | | | | Reviewed by: rwatson Notes: svn path=/head/; revision=158130
* Fix typo.Robert Watson2006-04-281-1/+1
| | | | | | | | MFC after: 1 month Submitted by: Antoine Brodin <antoine dot brodin@laposte dot net> Notes: svn path=/head/; revision=158122
* Add a basic man page for the sysctl(9) macro interfaces. Previously manRobert Watson2006-04-281-0/+343
pages existed only for the dynamic sysctl interfaces. There's probably more complete and accurate content, better advice, etc, that could be added here. Per scottl's suggest, add a small piece of moralizing text regarding the fact that sysctl names quickly get embedded in system configuration files, libraries, third party applications, and even books, so renaming and removing names after they've been published is a tricky issue. MFC after: 1 month Notes: svn path=/head/; revision=158110
generated by cgit v1.2.3 (git 2.25.1) at 2025-08-09 09:44:50 +0000