1*394d9b5aSjmc.\" $OpenBSD: kstat.1,v 1.2 2024/12/03 07:09:14 jmc Exp $ 2a09091e5Sschwarze.\" 3a09091e5Sschwarze.\" Copyright (c) 2020 Ingo Schwarze <schwarze@openbsd.org> 4a09091e5Sschwarze.\" 5a09091e5Sschwarze.\" Permission to use, copy, modify, and distribute this software for any 6a09091e5Sschwarze.\" purpose with or without fee is hereby granted, provided that the above 7a09091e5Sschwarze.\" copyright notice and this permission notice appear in all copies. 8a09091e5Sschwarze.\" 9a09091e5Sschwarze.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10a09091e5Sschwarze.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11a09091e5Sschwarze.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12a09091e5Sschwarze.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13a09091e5Sschwarze.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14a09091e5Sschwarze.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15a09091e5Sschwarze.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 16a09091e5Sschwarze.\" 17*394d9b5aSjmc.Dd $Mdocdate: December 3 2024 $ 18a09091e5Sschwarze.Dt KSTAT 1 19a09091e5Sschwarze.Os 20a09091e5Sschwarze.Sh NAME 21a09091e5Sschwarze.Nm kstat 22a09091e5Sschwarze.Nd display kernel statistics 23a09091e5Sschwarze.Sh SYNOPSIS 24a09091e5Sschwarze.Nm kstat 25a09091e5Sschwarze.Op Fl w Ar wait 26a09091e5Sschwarze.Oo 27a09091e5Sschwarze.Ar name | 28a09091e5Sschwarze.Sm off 29a09091e5Sschwarze.Ar provider : instance : name : unit 30a09091e5Sschwarze.Sm on 31a09091e5Sschwarze.Oc 32a09091e5Sschwarze.Ar ... 33a09091e5Sschwarze.Sh DESCRIPTION 34a09091e5SschwarzeThe 35a09091e5Sschwarze.Nm 36a09091e5Sschwarzeutility displays statistics collected by the kernel. 37a09091e5SschwarzeBy default, all available data is displayed. 38a09091e5SschwarzeIf at least one argument is given, the display is restricted to data 39a09091e5Sschwarzethat matches at least one of the arguments. 40a09091e5Sschwarze.Pp 41a09091e5SschwarzeThe options are as follows: 42a09091e5Sschwarze.Bl -tag -width provider 43a09091e5Sschwarze.It Fl w Ar wait 44a09091e5SschwarzeShow statistics at intervals of 45a09091e5Sschwarze.Ar wait 46a09091e5Sschwarzeseconds. 47a09091e5Sschwarze.El 48a09091e5Sschwarze.Pp 49a09091e5SschwarzeThe components of arguments are as follows: 50a09091e5Sschwarze.Bl -tag -width provider 51a09091e5Sschwarze.It Ar provider 52a09091e5SschwarzeThe name of the device providing the statistical data. 53a09091e5SschwarzePattern matching with 54*394d9b5aSjmc.Xr glob 7 55*394d9b5aSjmcpatterns is supported. 56a09091e5Sschwarze.It Ar instance 57a09091e5SschwarzeAn unsigned integer number. 58a09091e5SschwarzeCurrently, all statistics use an instance number of 0. 59a09091e5Sschwarze.It Ar name 60a09091e5SschwarzeA string identifying the kind of data to be shown. 61a09091e5SschwarzePattern matching with 62*394d9b5aSjmc.Xr glob 7 63*394d9b5aSjmcpatterns is supported. 64a09091e5Sschwarze.It Ar unit 65a09091e5SschwarzeAn unsigned integer number, used for example if a network device has 66a09091e5Sschwarzemultiple rings. 67a09091e5Sschwarze.El 68a09091e5Sschwarze.Pp 69a09091e5SschwarzeIf an empty string is given for any of the components, 70a09091e5Sschwarzeall values of the respective property are accepted. 71a09091e5Sschwarze.Pp 72a09091e5SschwarzeA complete list of four-component arguments supported on the current 73a09091e5Sschwarzemachine can be displayed by calling 74a09091e5Sschwarze.Nm 75a09091e5Sschwarzewithout any argument. 76a09091e5Sschwarze.Sh FILES 77a09091e5Sschwarze.Bl -tag -width /dev/kstat 78a09091e5Sschwarze.It Pa /dev/kstat 79a09091e5Sschwarzepseudo-device providing kernel statistics 80a09091e5Sschwarze.El 81a09091e5Sschwarze.Sh EXIT STATUS 82a09091e5Sschwarze.Ex -std 83a09091e5Sschwarze.Sh EXAMPLES 84a09091e5SschwarzeShow receive queue statistics for all interfaces 85a09091e5Sschwarzeand transmit queue statistics for all 86a09091e5Sschwarze.Xr em 4 87a09091e5Sschwarzeinterfaces: 88a09091e5Sschwarze.Pp 89a09091e5Sschwarze.Dl $ kstat rxq em*::txq: 90a09091e5Sschwarze.Sh SEE ALSO 91a09091e5Sschwarze.Xr netstat 1 , 92a09091e5Sschwarze.Xr systat 1 93a09091e5Sschwarze.\" XXX .Xr kstat 4 -- add this when that page is written 94a09091e5Sschwarze.Sh HISTORY 95a09091e5SschwarzeThe 96a09091e5Sschwarze.Nm 97a09091e5Sschwarzeutility first appeared in 98a09091e5Sschwarze.Ox 6.8 . 99a09091e5Sschwarze.Sh AUTHORS 100a09091e5Sschwarze.An David Gwynne Aq Mt dlg@openbsd.org 101