From nobody Sun Nov 26 18:31:21 2023 X-Original-To: dev-commits-src-main@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4Sdck12wxnz52fLp; Sun, 26 Nov 2023 18:31:21 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4Sdck12S6Hz4QNm; Sun, 26 Nov 2023 18:31:21 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1701023481; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=SXa/Y99WCOFqkRB0DkhQf2gSi/78Sw2/ElwqAN0i8u4=; b=YIEFXF0+fxWPvqPGxsSQNPO0UxrNDHGpa+Q+zxzrEDdUOHFZtjg6RKW6uuPo1YbvCQEdL4 pJATZyliwotxAZ/z9Agly26N7YaDg7srw50jJ3onEZhEH3kV5Y8uMudCWRO7XMHMfyHfjq iGywtcj81X+PgvMwMcUqrK/Tita7z+L8ZB7ZGRgJz8HmUC+pNbkMMbUUoCNMo6gLlIPTs1 RzDdgd7QljE91XBafkvLEmfcYh7SiHxoyj1TAO1QIhy8udx1gaRUQJKy5Bz2xBeGHp/QSB OEXzA1q8v0SsYKNZ8TUybznoAYVaVpt+9Uftxq63Z8/gl5q0URQsyUbP7N4K/A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1701023481; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=SXa/Y99WCOFqkRB0DkhQf2gSi/78Sw2/ElwqAN0i8u4=; b=oKFIOxXQOhU9NwmyRAPz3B+xsPfBYp61lTrn/jTZ18BSWio8/b9WRwPKD2qQl3YCVN3z7D 8eOVAkDo1cA1y0PBF4vG8rLWoaFy7oaTfc7QfAQb83UJrGAykFohFw4l3/Siax9iCel+81 mQYE21O56u9zyWGE4KT/81bq3fRECKUv9reouZcXEuQjOxiYL3lFvhPuGV9L2ud9DFn6u7 dWVc19qu3t+0qruJNu7SJdS2Ytr/pjESj3+dGm5f1pWo5XPlcnsYssDnzrKBoPcbFwjVib kICwcx5qbuA9FpRL06j5wmx0j4sohfDsdbusRg8KEB92mfXlhzVKVxC//YxmJQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1701023481; a=rsa-sha256; cv=none; b=j0gAbOXh4rxwfsnjnwO65ZJ/qQ0BRychMs0Z0/74fzk5rEw+Rqc2wI1dSHkIbXLV7w5ykt 698D2/0YiomvlRYkzdr6D3csRb4e/HzOCdo9S0AMJHmj05/CEdfon2F4xLlD6hknID9Sci LaP8dH3OsUTAwH/tK3Nn2BomRlwwHEWcdjPTxt5jqvnSr4DOdCLkVmdfoxiOOwWRoH+iYZ vvU9maqyJQxBhtpnsRvqdHYWay6pTkbJkf0Wwd629hzvMKRMwv17gHr5adl4A2dzv1XlAv FrmQ2rI+8geshCz1/iVvDOLIXBYVmwcVxpWUhhfVvavEPqKgV9L5fwkl1bUL2A== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4Sdck11Wfsz15PC; Sun, 26 Nov 2023 18:31:21 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 3AQIVLiO072901; Sun, 26 Nov 2023 18:31:21 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 3AQIVLaf072898; Sun, 26 Nov 2023 18:31:21 GMT (envelope-from git) Date: Sun, 26 Nov 2023 18:31:21 GMT Message-Id: <202311261831.3AQIVLaf072898@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Gordon Bergling Subject: git: 502e8f44fcc1 - main - iostat.8: Better wording for some use cases List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-main@freebsd.org X-BeenThere: dev-commits-src-main@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: gbe X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 502e8f44fcc18bfc6dadca56801d66cbce4c07ec Auto-Submitted: auto-generated The branch main has been updated by gbe: URL: https://cgit.FreeBSD.org/src/commit/?id=502e8f44fcc18bfc6dadca56801d66cbce4c07ec commit 502e8f44fcc18bfc6dadca56801d66cbce4c07ec Author: Gordon Bergling AuthorDate: 2023-11-26 18:30:58 +0000 Commit: Gordon Bergling CommitDate: 2023-11-26 18:30:58 +0000 iostat.8: Better wording for some use cases The iostat(8) manual page should be more specific when using options. Also extented the BUGS section. PR: 153012 Reviewed by: bcr MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D42633 --- usr.sbin/iostat/iostat.8 | 64 ++++++++++++++++++++++++++++++++++-------------- 1 file changed, 46 insertions(+), 18 deletions(-) diff --git a/usr.sbin/iostat/iostat.8 b/usr.sbin/iostat/iostat.8 index a08a62dc694d..a749b410d071 100644 --- a/usr.sbin/iostat/iostat.8 +++ b/usr.sbin/iostat/iostat.8 @@ -54,7 +54,7 @@ .\" .\" @(#)iostat.8 8.1 (Berkeley) 6/6/93 .\" -.Dd August 29, 2023 +.Dd November 26, 2023 .Dt IOSTAT 8 .Os .Sh NAME @@ -83,7 +83,12 @@ The utility displays kernel .Tn I/O statistics on terminal, device and cpu operations. -The first statistics that are printed are averaged over the system uptime. +The first statistics that are printed are averaged over the system uptime +(unless +.Fl I +is specified). +Any references to repetitions in this man page implicitly include the first +statistics output. To get information about the current activity, a suitable wait time should be specified, so that the subsequent sets of printed statistics will be averaged over that time. @@ -101,14 +106,11 @@ is specified. Repeat the display .Ar count times. -If no repeat -.Ar count -is specified, the default depends on whether -.Fl w -is specified. -With -.Fl w -the default repeat count is infinity, otherwise it is 1. +If +.Fl c +is not specified and a wait interval is specified, +the default repeat count is infinity. +If no wait interval is specified, the default repeat count is 1. .It Fl d Display only device statistics. If this flag is turned on, only device statistics will be displayed, unless @@ -130,8 +132,11 @@ per measurement cycle. Display total statistics for a given time period, rather than average statistics for each second during that time period. .It Fl K -In the blocks transferred display (-o), display block count in kilobytes rather -then the device native block size. +In the old-style blocks transferred display +.Po Fl I +and +.Fl o Pc , +display block count in kilobytes rather than the device native block size. .It Fl M Extract values associated with the name list from the specified core instead of the default @@ -145,7 +150,7 @@ Display up to number of devices. The .Nm -utility will display fewer devices if there are not +utility will display fewer devices if there are less than .Ar devs devices present. .It Fl o @@ -222,7 +227,7 @@ Passthrough devices The user must specify at least one device type, and may specify at most one device type from each category. Multiple device types in a single device type statement must be separated by -commas. +commas and are ANDed together. .Pp Any number of .Fl t @@ -236,14 +241,16 @@ Any device that fully matches any argument will be included in the .Nm output, up to the number of devices that can be displayed in -80 columns, or the maximum number of devices specified by the user. +80 columns, or the maximum number of devices +.Pq Fl n +specified by the user. .It Fl w Pause .Ar wait seconds between each display. -If no -.Ar wait -interval is specified, the default is 1 second. +If +.Fl w +is not specified, the default interval is 1 second. .Pp The .Nm @@ -518,3 +525,24 @@ The use of as a debugging tool for crash dumps is probably limited because there is currently no way to get statistics that only cover the time immediately before the crash. +.Pp +Each +.Ar drives +argument is passed to +.Fn isdigit . +If +.Fn isdigit +returns true, +.Nm +switches into an undocumented traditional syntax and subsequent arguments, +if any, will not be interpreted as drive names. +This behavior collides with the one documented in this man page and prevents +specifying drive names starting with a number. +E.g., the following +.Bd -literal -offset indent +iostat ada0 ada1 2 3 cd0 +.Ed +.Pp +This document's use of +.Dq device type +is misleading.