| sysctl_add_oid.9 (88509) | sysctl_add_oid.9 (89124) |
|---|---|
| 1.\" 2.\" Copyright (c) 2000, Andrzej Bialecki <abial@FreeBSD.org> 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright --- 11 unchanged lines hidden (view full) --- 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" | 1.\" 2.\" Copyright (c) 2000, Andrzej Bialecki <abial@FreeBSD.org> 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright --- 11 unchanged lines hidden (view full) --- 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" |
| 28.\" $FreeBSD: head/share/man/man9/sysctl_add_oid.9 88509 2001-12-26 23:14:04Z davidc $ | 28.\" $FreeBSD: head/share/man/man9/sysctl_add_oid.9 89124 2002-01-09 11:43:48Z mpp $ |
| 29.\" 30.Dd July 15, 2000 31.Dt SYSCTL_ADD_OID 9 32.Os 33.Sh NAME 34.Nm sysctl_add_oid , 35.Nm sysctl_remove_oid 36.Nd runtime sysctl tree manipulation --- 173 unchanged lines hidden (view full) --- 210which points to the head of the parent's list of children. 211.Pp 212Most top level categories are created statically. 213When connecting to existing static oids, 214this pointer can be obtained with the 215.Fn SYSCTL_STATIC_CHILDREN 216macro, where the 217.Fa OID_NAME | 29.\" 30.Dd July 15, 2000 31.Dt SYSCTL_ADD_OID 9 32.Os 33.Sh NAME 34.Nm sysctl_add_oid , 35.Nm sysctl_remove_oid 36.Nd runtime sysctl tree manipulation --- 173 unchanged lines hidden (view full) --- 210which points to the head of the parent's list of children. 211.Pp 212Most top level categories are created statically. 213When connecting to existing static oids, 214this pointer can be obtained with the 215.Fn SYSCTL_STATIC_CHILDREN 216macro, where the 217.Fa OID_NAME |
| 218argumwent is name of the parent oid of type | 218argument is name of the parent oid of type |
| 219.Dv CTLTYPE_NODE 220(i.e. the name displayed by 221.Xr sysctl 8 , 222preceded by underscore, and with all dots replaced with underscores). 223.Pp 224When connecting to an existing dynamic oid, this pointer 225can be obtained with the 226.Fn SYSCTL_CHILDREN 227macro, where the 228.Fa oidp 229argument points to the parent oid of type 230.Dv CTLTYPE_NODE . 231.Pp 232The 233.Fn sysctl_add_oid 234function creates raw oids of any type. | 219.Dv CTLTYPE_NODE 220(i.e. the name displayed by 221.Xr sysctl 8 , 222preceded by underscore, and with all dots replaced with underscores). 223.Pp 224When connecting to an existing dynamic oid, this pointer 225can be obtained with the 226.Fn SYSCTL_CHILDREN 227macro, where the 228.Fa oidp 229argument points to the parent oid of type 230.Dv CTLTYPE_NODE . 231.Pp 232The 233.Fn sysctl_add_oid 234function creates raw oids of any type. |
| 235If the oid is successfuly created, | 235If the oid is successfully created, |
| 236the function returns a pointer to it; 237otherwise it returns 238.Dv NULL . 239Many of the arguments for 240.Fn sysctl_add_oid 241are common to the macros. 242The arguments are as follows: 243.Bl -tag -width handler --- 29 unchanged lines hidden (view full) --- 273specified as a bitmask of the type and access values defined in the 274.Aq sys/sysctl.h 275header file. 276Oids created dynamically always have the 277.Dv CTLTYPE_DYN 278flag set. 279Access flags specify whether this oid is read-only or read-write, 280and whether it may be modified by all users | 236the function returns a pointer to it; 237otherwise it returns 238.Dv NULL . 239Many of the arguments for 240.Fn sysctl_add_oid 241are common to the macros. 242The arguments are as follows: 243.Bl -tag -width handler --- 29 unchanged lines hidden (view full) --- 273specified as a bitmask of the type and access values defined in the 274.Aq sys/sysctl.h 275header file. 276Oids created dynamically always have the 277.Dv CTLTYPE_DYN 278flag set. 279Access flags specify whether this oid is read-only or read-write, 280and whether it may be modified by all users |
| 281or by the supseruser only. | 281or by the superuser only. |
| 282.It Fa arg1 283A pointer to any data that the oid should reference, or 284.Dv NULL . 285.It Fa arg2 286The size of 287.Fa arg1 , 288or 0 if 289.Fa arg1 --- 212 unchanged lines hidden --- | 282.It Fa arg1 283A pointer to any data that the oid should reference, or 284.Dv NULL . 285.It Fa arg2 286The size of 287.Fa arg1 , 288or 0 if 289.Fa arg1 --- 212 unchanged lines hidden --- |