diff options
Diffstat (limited to 'share/man')
38 files changed, 226 insertions, 51 deletions
diff --git a/share/man/man4/cc_newreno.4 b/share/man/man4/cc_newreno.4 index 25afa8f93448..a5ae283948da 100644 --- a/share/man/man4/cc_newreno.4 +++ b/share/man/man4/cc_newreno.4 @@ -75,6 +75,7 @@ the congestion window in response to an ECN congestion signal when .Va net.inet.tcp.cc.abe=1 per: cwnd = (cwnd * CC_NEWRENO_BETA_ECN) / 100. Default is 80. +.El .Sh MIB Variables The algorithm exposes these variables in the .Va net.inet.tcp.cc.newreno @@ -93,6 +94,7 @@ the congestion window in response to an ECN congestion signal when .Va net.inet.tcp.cc.abe=1 per: cwnd = (cwnd * beta_ecn) / 100. Default is 80. +.El .Sh SEE ALSO .Xr cc_chd 4 , .Xr cc_cubic 4 , diff --git a/share/man/man4/ctl.4 b/share/man/man4/ctl.4 index d6a8888bbbaa..e150d70665d2 100644 --- a/share/man/man4/ctl.4 +++ b/share/man/man4/ctl.4 @@ -202,6 +202,7 @@ The default value is 1024. .It Va kern.cam.ctl.max_ports Specifies the maximum number of ports we support, must be a power of 2. The default value is 256. +.El .Sh SEE ALSO .Xr cfiscsi 4 , .Xr cfumass 4 , diff --git a/share/man/man4/ehci.4 b/share/man/man4/ehci.4 index 45e64432133f..17186a797ddf 100644 --- a/share/man/man4/ehci.4 +++ b/share/man/man4/ehci.4 @@ -88,6 +88,7 @@ The default value is 0 (off). .It Va hw.usb.ehci.no_hs This tunable disables USB devices to attach like HIGH-speed ones and will force all attached devices to attach to the FULL- or LOW-speed companion controller. The default value is 0 (off). +.El .Sh SYSCTL VARIABLES The following variables are available as both .Xr sysctl 8 diff --git a/share/man/man4/em.4 b/share/man/man4/em.4 index c79e88cc9ed2..a1fa22c2d0d3 100644 --- a/share/man/man4/em.4 +++ b/share/man/man4/em.4 @@ -264,6 +264,7 @@ If .Va hw.em.tx_int_delay is non-zero, this tunable limits the maximum delay in which a transmit interrupt is generated. +.El .Sh FILES .Bl -tag -width /dev/led/em* .It Pa /dev/led/em* diff --git a/share/man/man4/ena.4 b/share/man/man4/ena.4 index 5008ab2aa28a..1f2afbb8a7f1 100644 --- a/share/man/man4/ena.4 +++ b/share/man/man4/ena.4 @@ -239,6 +239,7 @@ for more details. .Pp Packet with unsupported number of segments was queued for sending to the device; packet will be dropped. +.El .Sh SUPPORT If an issue is identified with the released source code with a supported adapter email the specific information related to the issue to diff --git a/share/man/man4/ip.4 b/share/man/man4/ip.4 index 555aca1e36df..bb92dd011c4d 100644 --- a/share/man/man4/ip.4 +++ b/share/man/man4/ip.4 @@ -28,7 +28,7 @@ .\" @(#)ip.4 8.2 (Berkeley) 11/30/93 .\" $FreeBSD$ .\" -.Dd August 19, 2018 +.Dd February 22, 2019 .Dt IP 4 .Os .Sh NAME @@ -571,32 +571,55 @@ To join a multicast group, use the .Dv IP_ADD_MEMBERSHIP option: .Bd -literal -struct ip_mreq mreq; -setsockopt(s, IPPROTO_IP, IP_ADD_MEMBERSHIP, &mreq, sizeof(mreq)); +struct ip_mreqn mreqn; +setsockopt(s, IPPROTO_IP, IP_ADD_MEMBERSHIP, &mreqn, sizeof(mreqn)); .Ed .Pp where -.Fa mreq +.Fa mreqn is the following structure: .Bd -literal -struct ip_mreq { +struct ip_mreqn { struct in_addr imr_multiaddr; /* IP multicast address of group */ struct in_addr imr_interface; /* local IP address of interface */ + int imr_ifindex; /* interface index */ } .Ed .Pp -.Va imr_interface -should be set to the -.Tn IP -address of a particular multicast-capable interface if +.Va imr_ifindex +should be set to the index of a particular multicast-capable interface if the host is multihomed. -It may be set to -.Dv INADDR_ANY -to choose the default interface, although this is not recommended; -this is considered to be the first interface corresponding -to the default route. -Otherwise, the first multicast-capable interface -configured in the system will be used. +If +.Va imr_ifindex +is non-zero, value of +.Va imr_interface +is ignored. +Otherwise, if +.Va imr_ifindex +is 0, kernel will use IP address from +.Va imr_interface +to lookup the interface. +Value of +.Va imr_interface +may be set to +.Va INADDR_ANY +to choose the default interface, although this is not recommended; this is +considered to be the first interface corresponding to the default route. +Otherwise, the first multicast-capable interface configured in the system +will be used. +.Pp +Legacy +.Vt "struct ip_mreq" , +that lacks +.Va imr_ifindex +field is also supported by +.Dv IP_ADD_MEMBERSHIP +setsockopt. +In this case kernel would behave as if +.Va imr_ifindex +was set to zero: +.Va imr_interface +will be used to lookup interface. .Pp Prior to .Fx 7.0 , diff --git a/share/man/man4/ips.4 b/share/man/man4/ips.4 index a4b8c2cd7253..ece0bc37ba8f 100644 --- a/share/man/man4/ips.4 +++ b/share/man/man4/ips.4 @@ -114,7 +114,7 @@ Unable to obtain adapter or drive configuration. A buffer input/output error has occurred. .Bq Er ENXIO .El -.Ss General adapter errors: +.Ss General adapter errors : .Bl -diag .It Attaching bus failed .Pp @@ -146,7 +146,7 @@ The adapter is disabled. .Pp The driver was unable to allocate resources for the device. .El -.Ss Error messages due to DMA: +.Ss Error messages due to DMA : .Bl -diag .It can't alloc command dma tag .It can't alloc SG dma tag @@ -155,7 +155,7 @@ The driver was unable to allocate resources for the device. .Pp Failure to map or allocate DMA resources. .El -.Ss Cache, buffer, and command errors: +.Ss Cache, buffer, and command errors : .Bl -diag .It failed to initialize command buffers .It no mem for command slots! diff --git a/share/man/man4/liquidio.4 b/share/man/man4/liquidio.4 index 75cd3aa59708..e69384e3ad67 100644 --- a/share/man/man4/liquidio.4 +++ b/share/man/man4/liquidio.4 @@ -110,6 +110,7 @@ To enable/disable driver RSS support .It Va hw.lio.hwlro .Pp To enable/disable hardware LRO +.El .Sh SUPPORT For general information and support, go to the Cavium support website at: diff --git a/share/man/man4/nda.4 b/share/man/man4/nda.4 index 9e9bff5922dc..b2fb74ace520 100644 --- a/share/man/man4/nda.4 +++ b/share/man/man4/nda.4 @@ -70,14 +70,15 @@ It's value is hard coded to 0 indicating flash. This variable reports whether the .Nm driver accepts unmapped I/O for this unit. +.El .Sh FILES .Bl -tag -width ".Pa /dev/nda*" -compact .It Pa /dev/nda* NVMe storage device nodes .El .Sh SEE ALSO -.Xr nvme 4 , -.Xr nvd 4 +.Xr nvd 4 , +.Xr nvme 4 .Sh HISTORY The .Nm diff --git a/share/man/man4/ng_nat.4 b/share/man/man4/ng_nat.4 index bdb31bc996df..018d4521eed2 100644 --- a/share/man/man4/ng_nat.4 +++ b/share/man/man4/ng_nat.4 @@ -387,6 +387,7 @@ route add default x.y.0.1 msg igb0_NAT: setdlt 1 msg igb0_NAT: setaliasaddr x.y.8.35 SEQ +.Ed .Sh SEE ALSO .Xr libalias 3 , .Xr ng_ipfw 4 , diff --git a/share/man/man4/ohci.4 b/share/man/man4/ohci.4 index b7df14a50825..a2f2e9ef8e08 100644 --- a/share/man/man4/ohci.4 +++ b/share/man/man4/ohci.4 @@ -70,6 +70,7 @@ tunables: Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0. +.El .Sh SEE ALSO .Xr ehci 4 , .Xr uhci 4 , diff --git a/share/man/man4/pci.4 b/share/man/man4/pci.4 index a7bfa608af0a..5ae10657e550 100644 --- a/share/man/man4/pci.4 +++ b/share/man/man4/pci.4 @@ -386,7 +386,7 @@ specified by the member, otherwise fail. .It PCIIO_BAR_MMAP_EXCL Must be used together with -.Vd PCIIO_BAR_MMAP_FIXED +.Dv PCIIO_BAR_MMAP_FIXED If the specified base contains already established mappings, the operation fails instead of implicitly unmapping them. .It PCIIO_BAR_MMAP_RW diff --git a/share/man/man4/sctp.4 b/share/man/man4/sctp.4 index 940476128bbe..7a150c79ca4e 100644 --- a/share/man/man4/sctp.4 +++ b/share/man/man4/sctp.4 @@ -176,7 +176,7 @@ and tested with .Xr getsockopt 2 or .Xr sctp_opt_info 3 : -.Bl -tag -indent +.Bl -tag -width indent .It Dv SCTP_NODELAY Under most circumstances, .Tn SCTP diff --git a/share/man/man4/ses.4 b/share/man/man4/ses.4 index 066230257893..5b740d0790e0 100644 --- a/share/man/man4/ses.4 +++ b/share/man/man4/ses.4 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd September 05, 2015 +.Dd September 5, 2015 .Dt SES 4 .Os .Sh NAME diff --git a/share/man/man4/siftr.4 b/share/man/man4/siftr.4 index e122b5cdd35b..28e38e56d4c0 100644 --- a/share/man/man4/siftr.4 +++ b/share/man/man4/siftr.4 @@ -399,11 +399,15 @@ The summation of num_inbound_tcp_pkts and num_outbound_tcp_pkts. .El .Bl -tag -offset indent -width Va .It Va num_inbound_skipped_pkts_malloc -Number of inbound packets that were not processed because of failed malloc() calls. +Number of inbound packets that were not processed because of failed +.Fn malloc +calls. .El .Bl -tag -offset indent -width Va .It Va num_outbound_skipped_pkts_malloc -Number of outbound packets that were not processed because of failed malloc() calls. +Number of outbound packets that were not processed because of failed +.Fn malloc +calls. .El .Bl -tag -offset indent -width Va .It Va num_inbound_skipped_pkts_mtx @@ -759,8 +763,10 @@ Ideally, .Nm should intercept packets after they have been processed by the TCP layer i.e. intercept packets coming up the stack after they have been processed by -tcp_input(), and intercept packets coming down the stack after they have been -processed by tcp_output(). +.Fn tcp_input , +and intercept packets coming down the stack after they have been +processed by +.Fn tcp_output . The current code still gives satisfactory granularity though, as inbound events tend to trigger outbound events, allowing the cause-and-effect to be observed indirectly by capturing the state on outbound events as well. diff --git a/share/man/man4/smartpqi.4 b/share/man/man4/smartpqi.4 index 2b180f03db3f..ca3fad07a9de 100644 --- a/share/man/man4/smartpqi.4 +++ b/share/man/man4/smartpqi.4 @@ -23,7 +23,7 @@ .\" SUCH DAMAGE. .\" .\" $FreeBSD$ stable/10/share/man/man4/smartpqi.4 195614 2017-01-11 08:10:18Z jkim $ -.Dd April 06, 2018 +.Dd April 6, 2018 .Dt SMARTPQI 4 .Os .Sh NAME @@ -37,6 +37,7 @@ kernel configuration file: .Cd device pci .Cd device scbus .Cd device smartpqi +.Ed .Pp Alternatively, to load the driver as a module at boot time, place the following line in @@ -81,10 +82,10 @@ smartpqi management interface .Xr kld 4 , .Xr linux 4 , .Xr scsi 4 , -.Xr kldload 8 -.Xr pass 4 -.Xr xpt 4 -.Xr loader.conf 5 +.Xr kldload 8 , +.Xr pass 4 , +.Xr xpt 4 , +.Xr loader.conf 5 , .Xr camcontrol 8 .Rs .%T "Microsemi Website" @@ -95,7 +96,7 @@ The .Nm driver first appeared in .Fx 11.1 . -.Sh AUTHOR +.Sh AUTHORS .An Murthy Bhat .Aq murthy.bhat@microsemi.com .Sh BUGS diff --git a/share/man/man4/syscons.4 b/share/man/man4/syscons.4 index 49b4c84aabf1..8fa34eefb67d 100644 --- a/share/man/man4/syscons.4 +++ b/share/man/man4/syscons.4 @@ -38,6 +38,7 @@ .Cd "options SC_ALT_MOUSE_IMAGE" .Cd "options SC_CUT_SEPCHARS=_characters_" .Cd "options SC_CUT_SPACES2TABS" +.Cd "options SC_DFLT_TERM" .Cd "options SC_DISABLE_KDBKEY" .Cd "options SC_DISABLE_REBOOT" .Cd "options SC_HISTORY_SIZE=N" @@ -48,6 +49,9 @@ .Cd "options SC_NO_PALETTE_LOADING" .Cd "options SC_NO_SUSPEND_VTYSWITCH" .Cd "options SC_NO_SYSMOUSE" +.Cd "options SC_NO_TERM_DUMB" +.Cd "options SC_NO_TERM_SC" +.Cd "options SC_NO_TERM_SCTEKEN" .Cd "options SC_PIXEL_MODE" .Cd "options SC_TWOBUTTON_MOUSE" .Cd "options SC_NORM_ATTR=_attribute_" @@ -285,6 +289,8 @@ This options instructs the driver to convert leading spaces into tabs when copying data into cut buffer. This might be useful to preserve indentation when copying tab-indented text. +.It Dv SC_DFLT_TERM=_name_ +This option specifies the name of the preferred terminal emulator. .It Dv SC_DISABLE_KDBKEY This option disables the ``debug'' key combination (by default, it is .Dv Alt-Esc , @@ -409,6 +415,15 @@ will fail if this option is defined. This option implies the .Dv SC_NO_CUTPASTE option too. +.It Dv SC_NO_TERM_DUMB +.It Dv SC_NO_TERM_SC +.It Dv SC_NO_TERM_SCTEKEN +These options remove the +.Qq dumb , +.Qq sc , +and +.Qq scteken +terminal emulators, respectively. .El .Ss Driver Flags The following driver flags can be used to control the diff --git a/share/man/man4/sysmouse.4 b/share/man/man4/sysmouse.4 index f57b680c0933..e33021c15534 100644 --- a/share/man/man4/sysmouse.4 +++ b/share/man/man4/sysmouse.4 @@ -55,7 +55,6 @@ Make sure that .Xr moused 8 is running, otherwise the user process will not see any data coming from the mouse. -.Pp .Ss Operation Levels The .Nm diff --git a/share/man/man4/tcp.4 b/share/man/man4/tcp.4 index b12b07f02253..20ee4e139ee1 100644 --- a/share/man/man4/tcp.4 +++ b/share/man/man4/tcp.4 @@ -597,8 +597,7 @@ The default TCP function block (TCP stack). .It Va functions_inherit_listen_socket_stack Determines whether to inherit listen socket's tcp stack or use the current system default tcp stack, as defined by -.Va functions_default -.Pc . +.Va functions_default . Default is true. .It Va insecure_rst Use criteria defined in RFC793 instead of RFC5961 for accepting RST segments. diff --git a/share/man/man4/uath.4 b/share/man/man4/uath.4 index 07cdc280db13..391cef220360 100644 --- a/share/man/man4/uath.4 +++ b/share/man/man4/uath.4 @@ -76,7 +76,7 @@ This is normally done by the utility that is launched by .Xr devd 8 when the device is inserted. -.Xr uathload +.Xr uathload 8 includes the firmware in the binary program. This firmware is licensed for general use and is included in the base system. .Sh HARDWARE diff --git a/share/man/man4/ucom.4 b/share/man/man4/ucom.4 index 4eb2d12c217c..3146823fa814 100644 --- a/share/man/man4/ucom.4 +++ b/share/man/man4/ucom.4 @@ -81,6 +81,7 @@ driver will mark terminals as console devices when operating in device mode. Default is 1. .It Va hw.usb.ucom.pps_mode Enables and configure PPS capture mode as described below. +.El .Sh Pulse Per Second (PPS) Timing Interface The .Nm diff --git a/share/man/man4/ugen.4 b/share/man/man4/ugen.4 index 71b9d4dec41d..ad3ba80e0af7 100644 --- a/share/man/man4/ugen.4 +++ b/share/man/man4/ugen.4 @@ -302,6 +302,7 @@ tunables: Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0. +.El .Sh FILES .Bl -tag -width ".Pa /dev/ugen Ns Ar N Ns Pa \&. Ns Ar E" -compact .It Pa /dev/ugen Ns Ar N Ns Pa \&. Ns Ar E diff --git a/share/man/man4/uhci.4 b/share/man/man4/uhci.4 index 0dc0d94f2fd8..871d78ef92d9 100644 --- a/share/man/man4/uhci.4 +++ b/share/man/man4/uhci.4 @@ -60,6 +60,7 @@ tunables: Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0. +.El .Sh SEE ALSO .Xr ehci 4 , .Xr ohci 4 , diff --git a/share/man/man4/uhid.4 b/share/man/man4/uhid.4 index e0868e73fb65..3bcbaf5aed0d 100644 --- a/share/man/man4/uhid.4 +++ b/share/man/man4/uhid.4 @@ -155,6 +155,7 @@ tunables: Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0. +.El .Sh FILES .Bl -tag -width ".Pa /dev/uhid?" .It Pa /dev/uhid? diff --git a/share/man/man4/ukbd.4 b/share/man/man4/ukbd.4 index 6192bcd1dbcf..0b58446fcb77 100644 --- a/share/man/man4/ukbd.4 +++ b/share/man/man4/ukbd.4 @@ -147,6 +147,7 @@ tunables: Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0. +.El .Sh FILES .Bl -tag -width ".Pa /dev/kbd*" -compact .It Pa /dev/kbd* diff --git a/share/man/man4/umoscom.4 b/share/man/man4/umoscom.4 index 8361615dd77d..f2b6aec225a7 100644 --- a/share/man/man4/umoscom.4 +++ b/share/man/man4/umoscom.4 @@ -77,4 +77,7 @@ corresponding callout initial-state and lock-state devices .Sh HISTORY The .Nm -driver appeared in OpenBSD and was ported to FreeBSD. +driver appeared in +.Ox +and was ported to +.Fx . diff --git a/share/man/man4/ums.4 b/share/man/man4/ums.4 index e7c51f417ef5..cbc94160b260 100644 --- a/share/man/man4/ums.4 +++ b/share/man/man4/ums.4 @@ -75,6 +75,7 @@ tunables: Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0. +.El .Sh FILES .Bl -tag -width /dev/ums0 -compact .It Pa /dev/ums0 diff --git a/share/man/man4/uplcom.4 b/share/man/man4/uplcom.4 index 66f3e59d9e12..1f89d92fb1c1 100644 --- a/share/man/man4/uplcom.4 +++ b/share/man/man4/uplcom.4 @@ -191,6 +191,7 @@ tunables: Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0. +.El .Sh FILES .Bl -tag -width "/dev/ttyU*.init" -compact .It Pa /dev/ttyU* diff --git a/share/man/man4/usb.4 b/share/man/man4/usb.4 index 8ff2dac6fb23..5b745f5c7787 100644 --- a/share/man/man4/usb.4 +++ b/share/man/man4/usb.4 @@ -142,6 +142,7 @@ tunables: Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0. +.El .Sh SEE ALSO The .Tn USB @@ -173,7 +174,7 @@ specifications can be found at: .Xr uvscom 4 , .Xr xhci 4 .Xr usbconfig 8 , -.Xr usbdi 9 , +.Xr usbdi 9 .Sh STANDARDS The .Nm diff --git a/share/man/man4/uvscom.4 b/share/man/man4/uvscom.4 index 43f4fda14d5a..1dc5b93c5350 100644 --- a/share/man/man4/uvscom.4 +++ b/share/man/man4/uvscom.4 @@ -90,6 +90,7 @@ for callout ports .It Pa /dev/cuaU*.init .It Pa /dev/cuaU*.lock corresponding callout initial-state and lock-state devices +.El .Sh SEE ALSO .Xr tty 4 , .Xr ucom 4 , diff --git a/share/man/man4/vale.4 b/share/man/man4/vale.4 index dcdd24cccbdf..a3b1bce09857 100644 --- a/share/man/man4/vale.4 +++ b/share/man/man4/vale.4 @@ -28,7 +28,7 @@ .\" $FreeBSD$ .\" $Id: $ .\" -.Dd Jan 9, 2019 +.Dd January 9, 2019 .Dt VALE 4 .Os .Sh NAME diff --git a/share/man/man4/vmci.4 b/share/man/man4/vmci.4 index afff97b7001c..a216787e982e 100644 --- a/share/man/man4/vmci.4 +++ b/share/man/man4/vmci.4 @@ -59,6 +59,7 @@ virtual machine itself. .Rs .%T "VMware vSockets Documentation" .%U https://www.vmware.com/support/developer/vmci-sdk/ +.Re .Sh HISTORY The .Nm diff --git a/share/man/man4/vmm.4 b/share/man/man4/vmm.4 index a94a392f9713..9a39cec665da 100644 --- a/share/man/man4/vmm.4 +++ b/share/man/man4/vmm.4 @@ -31,7 +31,6 @@ .Nm vmm.ko .Nd "bhyve virtual machine monitor" .Sh SYNOPSIS -.Pp To load the driver as a module at boot, add this line to .Xr loader.conf 5 : .Bd -literal -offset indent @@ -47,7 +46,7 @@ kldload vmm .Nm provides the kernel portion of the .Xr bhyve 4 -hypervisor. +hypervisor. .Pp An Intel CPU with VT-x/EPT or AMD CPU with SVM support is required. .Pp diff --git a/share/man/man4/wi.4 b/share/man/man4/wi.4 index 0e55e7b21e6f..f2f00f56820e 100644 --- a/share/man/man4/wi.4 +++ b/share/man/man4/wi.4 @@ -316,7 +316,7 @@ command. .Xr wlan_xauth 4 , .Xr hostapd 8 , .Xr ifconfig 8 , -.Xr wpa_supplicant 8 . +.Xr wpa_supplicant 8 .Rs .%T HCF Light programming specification .%U http://web.archive.org/web/20040130141721/http://wavelan.com/ diff --git a/share/man/man4/xe.4 b/share/man/man4/xe.4 index 60c53ac0118a..d4d8fd08b5eb 100644 --- a/share/man/man4/xe.4 +++ b/share/man/man4/xe.4 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd October 24 2018 +.Dd October 24, 2018 .Dt XE 4 .Os .Sh NAME diff --git a/share/man/man4/xhci.4 b/share/man/man4/xhci.4 index 073586ae3034..d475c5e502fc 100644 --- a/share/man/man4/xhci.4 +++ b/share/man/man4/xhci.4 @@ -67,6 +67,7 @@ tunables: Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0. +.El .Sh SEE ALSO .Xr ehci 4 , .Xr ohci 4 , diff --git a/share/man/man5/style.mdoc.5 b/share/man/man5/style.mdoc.5 index 39c2961aefd6..c4cd8084c5b9 100644 --- a/share/man/man5/style.mdoc.5 +++ b/share/man/man5/style.mdoc.5 @@ -203,7 +203,7 @@ macro is usually not necessary. .It Use .Sy \&Va -instead of: +instead of .Sy \&Dv for .Xr sysctl 8 diff --git a/share/man/man9/sysctl.9 b/share/man/man9/sysctl.9 index 09c56871d7e9..9f81f2a7d777 100644 --- a/share/man/man9/sysctl.9 +++ b/share/man/man9/sysctl.9 @@ -25,11 +25,14 @@ .\" .\" $FreeBSD$ .\" -.Dd June 1, 2018 +.Dd February 25, 2019 .Dt SYSCTL 9 .Os .Sh NAME .Nm SYSCTL_DECL , +.Nm SYSCTL_ADD_BOOL , +.Nm SYSCTL_ADD_COUNTER_U64 , +.Nm SYSCTL_ADD_COUNTER_U64_ARRAY , .Nm SYSCTL_ADD_INT , .Nm SYSCTL_ADD_LONG , .Nm SYSCTL_ADD_NODE , @@ -42,6 +45,8 @@ .Nm SYSCTL_ADD_S16 , .Nm SYSCTL_ADD_S32 , .Nm SYSCTL_ADD_S64 , +.Nm SYSCTL_ADD_SBINTIME_MSEC , +.Nm SYSCTL_ADD_SBINTIME_USEC , .Nm SYSCTL_ADD_STRING , .Nm SYSCTL_ADD_STRUCT , .Nm SYSCTL_ADD_U8 , @@ -52,10 +57,15 @@ .Nm SYSCTL_ADD_UINT , .Nm SYSCTL_ADD_ULONG , .Nm SYSCTL_ADD_UQUAD , +.Nm SYSCTL_ADD_UMA_CUR , +.Nm SYSCTL_ADD_UMA_MAX , .Nm SYSCTL_CHILDREN , .Nm SYSCTL_STATIC_CHILDREN , .Nm SYSCTL_NODE_CHILDREN , .Nm SYSCTL_PARENT , +.Nm SYSCTL_BOOL , +.Nm SYSCTL_COUNTER_U64 , +.Nm SYSCTL_COUNTER_U64_ARRAY , .Nm SYSCTL_INT , .Nm SYSCTL_INT_WITH_LABEL , .Nm SYSCTL_LONG , @@ -69,6 +79,8 @@ .Nm SYSCTL_S16 , .Nm SYSCTL_S32 , .Nm SYSCTL_S64 , +.Nm SYSCTL_SBINTIME_MSEC , +.Nm SYSCTL_SBINTIME_USEC , .Nm SYSCTL_STRING , .Nm SYSCTL_STRUCT , .Nm SYSCTL_U8 , @@ -77,13 +89,47 @@ .Nm SYSCTL_U64 , .Nm SYSCTL_UINT , .Nm SYSCTL_ULONG , -.Nm SYSCTL_UQUAD +.Nm SYSCTL_UQUAD , +.Nm SYSCTL_UMA_CUR , +.Nm SYSCTL_UMA_MAX .Nd Dynamic and static sysctl MIB creation functions .Sh SYNOPSIS .In sys/param.h .In sys/sysctl.h .Fn SYSCTL_DECL name .Ft struct sysctl_oid * +.Fo SYSCTL_ADD_BOOL +.Fa "struct sysctl_ctx_list *ctx" +.Fa "struct sysctl_oid_list *parent" +.Fa "int number" +.Fa "const char *name" +.Fa "int ctlflags" +.Fa "bool *ptr" +.Fa "uint8_t val" +.Fa "const char *descr" +.Fc +.Ft struct sysctl_oid * +.Fo SYSCTL_ADD_COUNTER_U64 +.Fa "struct sysctl_ctx_list *ctx" +.Fa "struct sysctl_oid_list *parent" +.Fa "int number" +.Fa "const char *name" +.Fa "int ctlflags" +.Fa "counter_u64_t *ptr" +.Fa "const char *descr" +.Fc +.Ft struct sysctl_oid * +.Fo SYSCTL_ADD_COUNTER_U64_ARRAY +.Fa "struct sysctl_ctx_list *ctx" +.Fa "struct sysctl_oid_list *parent" +.Fa "int number" +.Fa "const char *name" +.Fa "int ctlflags" +.Fa "counter_u64_t *ptr" +.Fa "intmax_t len" +.Fa "const char *descr" +.Fc +.Ft struct sysctl_oid * .Fo SYSCTL_ADD_INT .Fa "struct sysctl_ctx_list *ctx" .Fa "struct sysctl_oid_list *parent" @@ -214,6 +260,26 @@ .Fa "const char *descr" .Fc .Ft struct sysctl_oid * +.Fo SYSCTL_ADD_SBINTIME_MSEC +.Fa "struct sysctl_ctx_list *ctx" +.Fa "struct sysctl_oid_list *parent" +.Fa "int number" +.Fa "const char *name" +.Fa "int ctlflags" +.Fa "sbintime_t *ptr" +.Fa "const char *descr" +.Fc +.Ft struct sysctl_oid * +.Fo SYSCTL_ADD_SBINTIME_USEC +.Fa "struct sysctl_ctx_list *ctx" +.Fa "struct sysctl_oid_list *parent" +.Fa "int number" +.Fa "const char *name" +.Fa "int ctlflags" +.Fa "sbintime_t *ptr" +.Fa "const char *descr" +.Fc +.Ft struct sysctl_oid * .Fo SYSCTL_ADD_STRING .Fa "struct sysctl_ctx_list *ctx" .Fa "struct sysctl_oid_list *parent" @@ -311,6 +377,27 @@ .Fa "const char *descr" .Fc .Ft struct sysctl_oid * +.Fo SYSCTL_ADD_UMA_CUR +.Fa "struct sysctl_ctx_list *ctx" +.Fa "struct sysctl_oid_list *parent" +.Fa "int number" +.Fa "const char *name" +.Fa "int ctlflags" +.Fa "uma_zone_t ptr" +.Fa "const char *descr" +.Fc +.Ft struct sysctl_oid * +.Fo SYSCTL_ADD_UMA_MAX +.Fa "struct sysctl_ctx_list *ctx" +.Fa "struct sysctl_oid_list *parent" +.Fa "int number" +.Fa "const char *name" +.Fa "int ctlflags" +.Fa "uma_zone_t ptr" +.Fa "const char *descr" +.Fc +.Fa "const char *descr" +.Ft struct sysctl_oid * .Fo SYSCTL_ADD_UAUTO .Fa "struct sysctl_ctx_list *ctx" .Fa "struct sysctl_oid_list *parent" @@ -337,6 +424,9 @@ .Fo SYSCTL_PARENT .Fa "struct sysctl_oid *oid" .Fc +.Fn SYSCTL_BOOL parent number name ctlflags ptr val descr +.Fn SYSCTL_COUNTER_U64 parent number name ctlflags ptr descr +.Fn SYSCTL_COUNTER_U64_ARRAY parent number name ctlflags ptr len descr .Fn SYSCTL_INT parent number name ctlflags ptr val descr .Fn SYSCTL_INT_WITH_LABEL parent number name ctlflags ptr val descr label .Fn SYSCTL_LONG parent number name ctlflags ptr val descr @@ -350,6 +440,8 @@ .Fn SYSCTL_S16 parent number name ctlflags ptr val descr .Fn SYSCTL_S32 parent number name ctlflags ptr val descr .Fn SYSCTL_S64 parent number name ctlflags ptr val descr +.Fn SYSCTL_SBINTIME_MSEC parent number name ctlflags ptr descr +.Fn SYSCTL_SBINTIME_USEC parent number name ctlflags ptr descr .Fn SYSCTL_STRING parent number name ctlflags arg len descr .Fn SYSCTL_STRUCT parent number name ctlflags ptr struct_type descr .Fn SYSCTL_U8 parent number name ctlflags ptr val descr @@ -359,6 +451,8 @@ .Fn SYSCTL_UINT parent number name ctlflags ptr val descr .Fn SYSCTL_ULONG parent number name ctlflags ptr val descr .Fn SYSCTL_UQUAD parent number name ctlflags ptr val descr +.Fn SYSCTL_UMA_MAX parent number name ctlflags ptr descr +.Fn SYSCTL_UMA_CUR parent number name ctlflags ptr descr .Sh DESCRIPTION The .Nm SYSCTL @@ -416,6 +510,7 @@ argument. For string type OIDs a length of zero means that .Xr strlen 3 will be used to get the length of the string at each access to the OID. +For array type OIDs the length must be greater than zero. .It Fa ptr Pointer to sysctl variable or string data. For sysctl values the pointer can be SYSCTL_NULL_XXX_PTR which means the OID is read-only and the returned value should be taken from the @@ -544,6 +639,9 @@ This OID type is especially useful if the kernel data is not easily accessible, or needs to be processed before exporting. .Sh CREATING A STATIC SYSCTL Static sysctls are declared using one of the +.Fn SYSCTL_BOOL , +.Fn SYSCTL_COUNTER_U64 , +.Fn SYSCTL_COUNTER_U64_ARRAY , .Fn SYSCTL_INT , .Fn SYSCTL_INT_WITH_LABEL , .Fn SYSCTL_LONG , @@ -557,6 +655,8 @@ Static sysctls are declared using one of the .Fn SYSCTL_S16 , .Fn SYSCTL_S32 , .Fn SYSCTL_S64 , +.Fn SYSCTL_SBINTIME_MSEC , +.Fn SYSCTL_SBINTIME_USEC , .Fn SYSCTL_STRING , .Fn SYSCTL_STRUCT , .Fn SYSCTL_U8 , @@ -564,12 +664,17 @@ Static sysctls are declared using one of the .Fn SYSCTL_U32 , .Fn SYSCTL_U64 , .Fn SYSCTL_UINT , -.Fn SYSCTL_ULONG +.Fn SYSCTL_ULONG , +.Fn SYSCTL_UQUAD , +.Fn SYSCTL_UMA_CUR or -.Fn SYSCTL_UQUAD +.Fn SYSCTL_UMA_MAX macros. .Sh CREATING A DYNAMIC SYSCTL Dynamic nodes are created using one of the +.Fn SYSCTL_ADD_BOOL , +.Fn SYSCTL_ADD_COUNTER_U64 , +.Fn SYSCTL_ADD_COUNTER_U64_ARRAY , .Fn SYSCTL_ADD_INT , .Fn SYSCTL_ADD_LONG , .Fn SYSCTL_ADD_NODE , @@ -582,6 +687,8 @@ Dynamic nodes are created using one of the .Fn SYSCTL_ADD_S16 , .Fn SYSCTL_ADD_S32 , .Fn SYSCTL_ADD_S64 , +.Fn SYSCTL_ADD_SBINTIME_MSEC , +.Fn SYSCTL_ADD_SBINTIME_USEC , .Fn SYSCTL_ADD_STRING , .Fn SYSCTL_ADD_STRUCT , .Fn SYSCTL_ADD_U8 , @@ -591,8 +698,10 @@ Dynamic nodes are created using one of the .Fn SYSCTL_ADD_UAUTO , .Fn SYSCTL_ADD_UINT , .Fn SYSCTL_ADD_ULONG , +.Fn SYSCTL_ADD_UQUAD , +.Fn SYSCTL_ADD_UMA_CUR or -.Fn SYSCTL_UQUAD +.Fn SYSCTL_ADD_UMA_MAX functions. See .Xr sysctl_remove_oid 9 |