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 September 23, 1994
  36 .Dt SYSCTL 8
  37 .Os
  38 .Sh NAME
  39 .Nm sysctl
  40 .Nd get or set kernel state
  41 .Sh SYNOPSIS
  42 .Nm sysctl
  43 .Op Fl bn
  44 .Ar name ...
  45 .Nm sysctl
  46 .Op Fl bn
  47 .Fl w
  48 .Ar name=value ...
  49 .Nm sysctl
  50 .Op Fl bn
  51 .Fl aAX
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 utility retrieves kernel state and allows processes with
  56 appropriate privilege to set kernel state.
  57 The state to be retrieved or set is described using a
  58 ``Management Information Base'' (``MIB'') style name,
  59 described as a dotted set of components.
  60 .Pp
  61 The following options are available:
  62 .Bl -tag -width indent
  63 .It Fl a
  64 List all the currently available string or integer values.
  65 .It Fl A
  66 List all the known MIB names including opaques.
  67 Those with string or integer values will be printed as with the
  68 .Fl a
  69 flag; for the opaque values,
  70 information about the format and the length is printed in addition the first
  71 few bytes is dumped in hex.
  72 .It Fl X
  73 Same as
  74 .Fl A
  75 except the entire value of opaque variables is hexdumped.
  76 .It Fl n
  77 Specify that the printing of the field name should be
  78 suppressed and that only its value should be output.
  79 This flag is useful for setting shell variables.
  80 For example, to save the pagesize in variable psize, use:
  81 .Bd -literal -offset indent -compact
  82 set psize=`sysctl -n hw.pagesize`
  83 .Ed
  84 .It Fl b
  85 Force the value of the variable(s) to be output in raw, binary
  86 format.  No names are printed and no terminating newlines are output.
  87 This is mostly useful with a single variable.
  88 .It Fl w Ar name=value ...
  89 Set the MIB
  90 .Ar name
  91 to the new
  92 .Ar value .
  93 If just a MIB style
  94 .Ar name
  95 is given,
  96 the corresponding value is retrieved.
  97 .El
  98 .Pp
  99 The information available from
 100 .Nm
 101 consists of integers, strings, and opaques.
 102 .Nm Sysctl
 103 only knows about a couple of opaque types, and will resort to hexdumps
 104 for the rest.
 105 The opaque information is much more useful if retrieved by special
 106 purpose programs such as
 107 .Nm ps ,
 108 .Nm systat ,
 109 and
 110 .Nm netstat .
 111 .Pp
 112 The string and integer information is summarized below.
 113 For a detailed description of these variable see
 114 .Xr sysctl 3 .
 115 .Pp
 116 The changeable column indicates whether a process with appropriate
 117 privilege can change the value.
 118 .Bl -column net.inet.ip.forwardingxxxxxx integerxxx
 119 .It Sy Name     Type    Changeable
 120 .It kern.ostype string  no
 121 .It kern.osrelease      string  no
 122 .It kern.osrevision     integer no
 123 .It kern.version        string  no
 124 .It kern.maxvnodes      integer yes
 125 .It kern.maxproc        integer no
 126 .It kern.maxprocperuid  integer yes
 127 .It kern.maxfiles       integer yes
 128 .It kern.maxfilesperproc        integer yes
 129 .It kern.argmax integer no
 130 .It kern.securelevel    integer raise only
 131 .It kern.hostname       string  yes
 132 .It kern.hostid integer yes
 133 .It kern.clockrate      struct  no
 134 .It kern.posix1version  integer no
 135 .It kern.ngroups        integer no
 136 .It kern.job_control    integer no
 137 .It kern.saved_ids      integer no
 138 .It kern.boottime       struct  no
 139 .It kern.domainname     string  yes
 140 .It kern.update integer yes
 141 .It kern.osreldate      string  no
 142 .It kern.bootfile       string  yes
 143 .It kern.corefile       string  yes
 144 .It kern.logsigexit     integer yes
 145 .It vm.loadavg  struct  no
 146 .It hw.machine  string  no
 147 .It hw.model    string  no
 148 .It hw.ncpu     integer no
 149 .It hw.byteorder        integer no
 150 .It hw.physmem  integer no
 151 .It hw.usermem  integer no
 152 .It hw.pagesize integer no
 153 .It hw.floatingpoint    integer no
 154 .It hw.machine_arch     string  no
 155 .It machdep.console_device      dev_t   no
 156 .It machdep.adjkerntz   integer yes
 157 .It machdep.disable_rtc_set     integer yes
 158 .It user.cs_path        string  no
 159 .It user.bc_base_max    integer no
 160 .It user.bc_dim_max     integer no
 161 .It user.bc_scale_max   integer no
 162 .It user.bc_string_max  integer no
 163 .It user.coll_weights_max       integer no
 164 .It user.expr_nest_max  integer no
 165 .It user.line_max       integer no
 166 .It user.re_dup_max     integer no
 167 .It user.posix2_version integer no
 168 .It user.posix2_c_bind  integer no
 169 .It user.posix2_c_dev   integer no
 170 .It user.posix2_char_term       integer no
 171 .It user.posix2_fort_dev        integer no
 172 .It user.posix2_fort_run        integer no
 173 .It user.posix2_localedef       integer no
 174 .It user.posix2_sw_dev  integer no
 175 .It user.posix2_upe     integer no
 176 .It user.stream_max     integer no
 177 .It user.tzname_max     integer no
 178 .El
 179 .Sh EXAMPLES
 180 For example, to retrieve the maximum number of processes allowed
 181 in the system, one would use the following request:
 182 .Bd -literal -offset indent -compact
 183 sysctl kern.maxproc
 184 .Ed
 185 .Pp
 186 To set the maximum number of processes allowed
 187 per uid to 1000, one would use the following request:
 188 .Bd -literal -offset indent -compact
 189 sysctl -w kern.maxprocperuid=1000
 190 .Ed
 191 .Pp
 192 Information about the system clock rate may be obtained with:
 193 .Bd -literal -offset indent -compact
 194 sysctl kern.clockrate
 195 .Ed
 196 .Pp
 197 Information about the load average history may be obtained with:
 198 .Bd -literal -offset indent -compact
 199 sysctl vm.loadavg
 200 .Ed
 201 .Pp
 202 More variables than these exist, and the best and likely only place
 203 to search for their deeper meaning is undoubtedly the source where
 204 they are defined.
 205 .Sh FILES
 206 .Bl -tag -width <netinet/icmpXvar.h> -compact
 207 .It Pa <sys/sysctl.h>
 208 definitions for top level identifiers, second level kernel and hardware
 209 identifiers, and user level identifiers
 210 .It Pa <sys/socket.h>
 211 definitions for second level network identifiers
 212 .It Pa <sys/gmon.h>
 213 definitions for third level profiling identifiers
 214 .It Pa <vm/vm_param.h>
 215 definitions for second level virtual memory identifiers
 216 .It Pa <netinet/in.h>
 217 definitions for third level Internet identifiers and
 218 fourth level IP identifiers
 219 .It Pa <netinet/icmp_var.h>
 220 definitions for fourth level ICMP identifiers
 221 .It Pa <netinet/udp_var.h>
 222 definitions for fourth level UDP identifiers
 223 .El
 224 .Sh SEE ALSO
 225 .Xr sysctl 3
 226 .Xr blackhole 4
 227 .Sh BUGS
 228 .Nm Sysctl
 229 presently exploits an undocumented interface to the kernel
 230 sysctl facility to traverse the sysctl tree and to retrieve format
 231 and name information.
 232 This correct interface is being thought about for the time being.
 233 .Sh HISTORY
 234 .Nm Sysctl
 235 first appeared in
 236 .Bx 4.4 .
 237 .Pp
 238 In
 239 .Fx 2.2 ,
 240 .Nm
 241 was significantly remodeled.