sbin/sysctl/sysctl.8

   1 .\" Copyright (c) 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     From: @(#)sysctl.8      8.1 (Berkeley) 6/6/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd March 10, 2002
  36 .Dt SYSCTL 8
  37 .Os
  38 .Sh NAME
  39 .Nm sysctl
  40 .Nd get or set kernel state
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl beNnox
  44 .Ar name Ns Op = Ns Ar value
  45 .Ar ...
  46 .Nm
  47 .Op Fl bdeNnox
  48 .Fl a
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 utility retrieves kernel state and allows processes with appropriate
  53 privilege to set kernel state.
  54 The state to be retrieved or set is described using a
  55 .Dq Management Information Base
  56 .Pq Dq MIB
  57 style name, described as a dotted set of
  58 components.
  59 .Pp
  60 The following options are available:
  61 .Bl -tag -width indent
  62 .It Fl A
  63 Equivalent to
  64 .Fl o a
  65 (for compatibility).
  66 .It Fl a
  67 List all the currently available non-opaque values.
  68 This option is ignored if one or more variable names are specified on
  69 the command line.
  70 .It Fl b
  71 Force the value of the variable(s) to be output in raw, binary format.
  72 No names are printed and no terminating newlines are output.
  73 This is mostly useful with a single variable.
  74 .It Fl d
  75 Print the description of the variable instead of its value.
  76 .It Fl e
  77 Separate the name and the value of the variable(s) with
  78 .Ql = .
  79 This is useful for producing output which can be fed back to the
  80 .Nm
  81 utility.
  82 This option is ignored if either
  83 .Fl N
  84 or
  85 .Fl n
  86 is specified, or a variable is being set.
  87 .It Fl N
  88 Show only variable names, not their values.
  89 This is particularly useful with shells that offer programmable
  90 completion.
  91 To enable completion of variable names in
  92 .Nm zsh ,
  93 use the following code:
  94 .Bd -literal -offset indent
  95 listsysctls () { set -A reply $(sysctl -AN ${1%.*}) }
  96 compctl -K listsysctls sysctl
  97 .Ed
  98 .It Fl n
  99 Show only variable values, not their names.
 100 This option is useful for setting shell variables.
 101 For instance, to save the pagesize in variable
 102 .Va psize ,
 103 use:
 104 .Pp
 105 .Dl "set psize=`sysctl -n hw.pagesize`"
 106 .It Fl o
 107 Show opaque variables (which are normally suppressed).
 108 The format and length are printed, as well as a hex dump of the first
 109 sixteen bytes of the value.
 110 .It Fl X
 111 Equivalent to
 112 .Fl x a
 113 (for compatibility).
 114 .It Fl x
 115 As
 116 .Fl o ,
 117 but prints a hex dump of the entire value instead of just the first
 118 few bytes.
 119 .El
 120 .Pp
 121 The information available from
 122 .Nm
 123 consists of integers, strings, devices
 124 .Pq Vt dev_t ,
 125 and opaque types.
 126 .Nm Sysctl
 127 only knows about a couple of opaque types, and will resort to hexdumps
 128 for the rest.
 129 The opaque information is much more useful if retrieved by special
 130 purpose programs such as
 131 .Nm ps , systat ,
 132 and
 133 .Nm netstat .
 134 .Pp
 135 The string and integer information is summarized below.
 136 For a detailed description of these variable see
 137 .Xr sysctl 3 .
 138 .Pp
 139 The changeable column indicates whether a process with appropriate
 140 privilege can change the value.
 141 String, integer, and devices values can be set using
 142 .Nm .
 143 For device values,
 144 .Ar value
 145 can be specified as a character device special file name.
 146 Special values
 147 .Cm off
 148 and
 149 .Cm none
 150 denote
 151 .Dq no device .
 152 .Bl -column security.bsd.unprivileged_read_msgbuf integerxxx
 153 .It Sy "Name    Type    Changeable
 154 .It "kern.ostype        string  no
 155 .It "kern.osrelease     string  no
 156 .It "kern.osrevision    integer no
 157 .It "kern.version       string  no
 158 .It "kern.maxvnodes     integer yes
 159 .It "kern.maxproc       integer no
 160 .It "kern.maxprocperuid integer yes
 161 .It "kern.maxfiles      integer yes
 162 .It "kern.maxfilesperproc       integer yes
 163 .It "kern.argmax        integer no
 164 .It "kern.securelevel   integer raise only
 165 .It "kern.hostname      string  yes
 166 .It "kern.hostid        integer yes
 167 .It "kern.clockrate     struct  no
 168 .It "kern.posix1version integer no
 169 .It "kern.ngroups       integer no
 170 .It "kern.job_control   integer no
 171 .It "kern.saved_ids     integer no
 172 .It "kern.boottime      struct  no
 173 .It "kern.domainname    string  yes
 174 .It "kern.filedelay     integer yes
 175 .It "kern.dirdelay      integer yes
 176 .It "kern.metadelay     integer yes
 177 .It "kern.osreldate     string  no
 178 .It "kern.bootfile      string  yes
 179 .It "kern.corefile      string  yes
 180 .It "kern.dumpdev       dev_t   yes
 181 .It "kern.logsigexit    integer yes
 182 .It "security.bsd.suser_enabled integer yes
 183 .It "security.bsd.see_other_uids        integer yes
 184 .It "security.bsd.unprivileged_proc_debug       integer yes
 185 .It "security.bsd.unprivileged_read_msgbuf      integer yes
 186 .It "vm.loadavg struct  no
 187 .It "hw.machine string  no
 188 .It "hw.model   string  no
 189 .It "hw.ncpu    integer no
 190 .It "hw.byteorder       integer no
 191 .It "hw.physmem integer no
 192 .It "hw.usermem integer no
 193 .It "hw.pagesize        integer no
 194 .It "hw.floatingpoint   integer no
 195 .It "hw.machine_arch    string  no
 196 .It "machdep.console_device     dev_t   no
 197 .It "machdep.adjkerntz  integer yes
 198 .It "machdep.disable_rtc_set    integer yes
 199 .It "machdep.guessed_bootdev    string  no
 200 .It "user.cs_path       string  no
 201 .It "user.bc_base_max   integer no
 202 .It "user.bc_dim_max    integer no
 203 .It "user.bc_scale_max  integer no
 204 .It "user.bc_string_max integer no
 205 .It "user.coll_weights_max      integer no
 206 .It "user.expr_nest_max integer no
 207 .It "user.line_max      integer no
 208 .It "user.re_dup_max    integer no
 209 .It "user.posix2_version        integer no
 210 .It "user.posix2_c_bind integer no
 211 .It "user.posix2_c_dev  integer no
 212 .It "user.posix2_char_term      integer no
 213 .It "user.posix2_fort_dev       integer no
 214 .It "user.posix2_fort_run       integer no
 215 .It "user.posix2_localedef      integer no
 216 .It "user.posix2_sw_dev integer no
 217 .It "user.posix2_upe    integer no
 218 .It "user.stream_max    integer no
 219 .It "user.tzname_max    integer no
 220 .El
 221 .Sh EXAMPLES
 222 For example, to retrieve the maximum number of processes allowed
 223 in the system, one would use the following request:
 224 .Pp
 225 .Dl "sysctl kern.maxproc"
 226 .Pp
 227 To set the maximum number of processes allowed
 228 per uid to 1000, one would use the following request:
 229 .Pp
 230 .Dl "sysctl kern.maxprocperuid=1000"
 231 .Pp
 232 The device used for crash dumps can be specified using:
 233 .Pp
 234 .Dl "sysctl kern.dumpdev=/dev/somedev"
 235 .Pp
 236 which is equivalent to
 237 .Pp
 238 .Dl "dumpon /dev/somedev"
 239 .Pp
 240 Information about the system clock rate may be obtained with:
 241 .Pp
 242 .Dl "sysctl kern.clockrate"
 243 .Pp
 244 Information about the load average history may be obtained with:
 245 .Pp
 246 .Dl "sysctl vm.loadavg"
 247 .Pp
 248 More variables than these exist, and the best and likely only place
 249 to search for their deeper meaning is undoubtedly the source where
 250 they are defined.
 251 .Sh FILES
 252 .Bl -tag -width ".Aq Pa netinet/icmp_var.h" -compact
 253 .It Aq Pa sys/sysctl.h
 254 definitions for top level identifiers, second level kernel and hardware
 255 identifiers, and user level identifiers
 256 .It Aq Pa sys/socket.h
 257 definitions for second level network identifiers
 258 .It Aq Pa sys/gmon.h
 259 definitions for third level profiling identifiers
 260 .It Aq Pa vm/vm_param.h
 261 definitions for second level virtual memory identifiers
 262 .It Aq Pa netinet/in.h
 263 definitions for third level Internet identifiers and
 264 fourth level IP identifiers
 265 .It Aq Pa netinet/icmp_var.h
 266 definitions for fourth level ICMP identifiers
 267 .It Aq Pa netinet/udp_var.h
 268 definitions for fourth level UDP identifiers
 269 .El
 270 .Sh COMPATIBILITY
 271 The
 272 .Fl w
 273 option has been deprecated and is silently ignored.
 274 .Sh SEE ALSO
 275 .Xr sysctl 3 ,
 276 .Xr sysctl.conf 5
 277 .Sh BUGS
 278 .Nm Sysctl
 279 presently exploits an undocumented interface to the kernel
 280 sysctl facility to traverse the sysctl tree and to retrieve format
 281 and name information.
 282 This correct interface is being thought about for the time being.
 283 .Sh HISTORY
 284 .Nm Sysctl
 285 first appeared in
 286 .Bx 4.4 .
 287 .Pp
 288 In
 289 .Fx 2.2 ,
 290 .Nm
 291 was significantly remodeled.