| @@ -1,14 +1,14 @@ | | | @@ -1,14 +1,14 @@ |
1 | .\" $NetBSD: iostat.8,v 1.29 2023/07/28 09:18:58 mrg Exp $ | | 1 | .\" $NetBSD: iostat.8,v 1.30 2023/07/28 12:03:33 wiz Exp $ |
2 | .\" | | 2 | .\" |
3 | .\" Copyright (c) 1985, 1991, 1993 | | 3 | .\" Copyright (c) 1985, 1991, 1993 |
4 | .\" The Regents of the University of California. All rights reserved. | | 4 | .\" The Regents of the University of California. All rights reserved. |
5 | .\" | | 5 | .\" |
6 | .\" Redistribution and use in source and binary forms, with or without | | 6 | .\" Redistribution and use in source and binary forms, with or without |
7 | .\" modification, are permitted provided that the following conditions | | 7 | .\" modification, are permitted provided that the following conditions |
8 | .\" are met: | | 8 | .\" are met: |
9 | .\" 1. Redistributions of source code must retain the above copyright | | 9 | .\" 1. Redistributions of source code must retain the above copyright |
10 | .\" notice, this list of conditions and the following disclaimer. | | 10 | .\" notice, this list of conditions and the following disclaimer. |
11 | .\" 2. Redistributions in binary form must reproduce the above copyright | | 11 | .\" 2. Redistributions in binary form must reproduce the above copyright |
12 | .\" notice, this list of conditions and the following disclaimer in the | | 12 | .\" notice, this list of conditions and the following disclaimer in the |
13 | .\" documentation and/or other materials provided with the distribution. | | 13 | .\" documentation and/or other materials provided with the distribution. |
14 | .\" 3. Neither the name of the University nor the names of its contributors | | 14 | .\" 3. Neither the name of the University nor the names of its contributors |
| @@ -27,27 +27,27 @@ | | | @@ -27,27 +27,27 @@ |
27 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | | 27 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
28 | .\" SUCH DAMAGE. | | 28 | .\" SUCH DAMAGE. |
29 | .\" | | 29 | .\" |
30 | .\" from: @(#)iostat.8 8.1 (Berkeley) 6/6/93 | | 30 | .\" from: @(#)iostat.8 8.1 (Berkeley) 6/6/93 |
31 | .\" | | 31 | .\" |
32 | .Dd July 28, 2023 | | 32 | .Dd July 28, 2023 |
33 | .Dt IOSTAT 8 | | 33 | .Dt IOSTAT 8 |
34 | .Os | | 34 | .Os |
35 | .Sh NAME | | 35 | .Sh NAME |
36 | .Nm iostat | | 36 | .Nm iostat |
37 | .Nd report I/O statistics | | 37 | .Nd report I/O statistics |
38 | .Sh SYNOPSIS | | 38 | .Sh SYNOPSIS |
39 | .Nm | | 39 | .Nm |
40 | .Op Fl CdDITxXyz | | 40 | .Op Fl CDdITXxyz |
41 | .Op Fl c Ar count | | 41 | .Op Fl c Ar count |
42 | .Op Fl H Ar height | | 42 | .Op Fl H Ar height |
43 | .Op Fl W Ar width | | 43 | .Op Fl W Ar width |
44 | .Op Fl w Ar wait | | 44 | .Op Fl w Ar wait |
45 | .Op Ar drives | | 45 | .Op Ar drives |
46 | .Sh DESCRIPTION | | 46 | .Sh DESCRIPTION |
47 | .Nm | | 47 | .Nm |
48 | displays kernel I/O statistics on terminal, disk and CPU operations. | | 48 | displays kernel I/O statistics on terminal, disk and CPU operations. |
49 | By default, | | 49 | By default, |
50 | .Nm | | 50 | .Nm |
51 | displays one line of statistics averaged over the machine's run time. | | 51 | displays one line of statistics averaged over the machine's run time. |
52 | The use of | | 52 | The use of |
53 | .Fl c | | 53 | .Fl c |
| @@ -55,169 +55,169 @@ or | | | @@ -55,169 +55,169 @@ or |
55 | .Fl w | | 55 | .Fl w |
56 | presents successive lines averaged over the | | 56 | presents successive lines averaged over the |
57 | .Ar wait | | 57 | .Ar wait |
58 | period. | | 58 | period. |
59 | The | | 59 | The |
60 | .Fl I | | 60 | .Fl I |
61 | option causes | | 61 | option causes |
62 | .Nm | | 62 | .Nm |
63 | to print raw, unaveraged values (totals). | | 63 | to print raw, unaveraged values (totals). |
64 | .Pp | | 64 | .Pp |
65 | Only the last disk option specified | | 65 | Only the last disk option specified |
66 | .Fl ( d , | | 66 | .Fl ( d , |
67 | .Fl D , | | 67 | .Fl D , |
68 | .Fl x , | | | |
69 | .Fl X , | | 68 | .Fl X , |
| | | 69 | .Fl x , |
70 | or | | 70 | or |
71 | .Fl y ) | | 71 | .Fl y ) |
72 | is used. | | 72 | is used. |
73 | .Pp | | 73 | .Pp |
74 | The options are as follows: | | 74 | The options are as follows: |
75 | .Bl -tag -width XNXsystemX | | 75 | .Bl -tag -width XNXsystemX |
| | | 76 | .It Fl C |
| | | 77 | Show CPU statistics. |
| | | 78 | This is enabled by default unless any of the |
| | | 79 | .Fl D , |
| | | 80 | .Fl d , |
| | | 81 | .Fl T , |
| | | 82 | .Fl X , |
| | | 83 | .Fl x , |
| | | 84 | or |
| | | 85 | .Fl y |
| | | 86 | flags are used. |
76 | .It Fl c Ar count | | 87 | .It Fl c Ar count |
77 | Repeat the display | | 88 | Repeat the display |
78 | .Ar count | | 89 | .Ar count |
79 | times. | | 90 | times. |
80 | Unless the | | 91 | Unless the |
81 | .Fl I | | 92 | .Fl I |
82 | flag is in effect, the first display is for the time since a reboot and | | 93 | flag is in effect, the first display is for the time since a reboot and |
83 | each subsequent report is for the time period since the last display. | | 94 | each subsequent report is for the time period since the last display. |
84 | If no | | 95 | If no |
85 | .Ar wait | | 96 | .Ar wait |
86 | interval is specified, the default is 1 second. | | 97 | interval is specified, the default is 1 second. |
87 | .It Fl C | | | |
88 | Show CPU statistics. | | | |
89 | This is enabled by default unless any of the | | | |
90 | .Fl d , | | | |
91 | .Fl D , | | | |
92 | .Fl T , | | | |
93 | .Fl x , | | | |
94 | .Fl X , | | | |
95 | or | | | |
96 | .Fl y | | | |
97 | flags are used. | | | |
98 | .It Fl d | | | |
99 | Show disk statistics. | | | |
100 | This is the default. | | | |
101 | Displays | | | |
102 | number of transfers per second, | | | |
103 | kilobytes per transfer, | | | |
104 | and | | | |
105 | megabytes transferred per second. | | | |
106 | Use of this flag disables the default display of CPU and tty statistics. | | | |
107 | .It Fl D | | 98 | .It Fl D |
108 | Show alternative disk statistics. | | 99 | Show alternative disk statistics. |
109 | Displays | | 100 | Displays |
110 | number of transfers, | | 101 | number of transfers, |
111 | kilobytes transferred, | | 102 | kilobytes transferred, |
112 | and | | 103 | and |
113 | time spent in transfers, | | 104 | time spent in transfers, |
114 | during the | | 105 | during the |
115 | .Ar wait | | 106 | .Ar wait |
116 | period (or since boot with | | 107 | period (or since boot with |
117 | .Fl I ) . | | 108 | .Fl I ) . |
118 | Use of this flag disables the default display. | | 109 | Use of this flag disables the default display. |
| | | 110 | .It Fl d |
| | | 111 | Show disk statistics. |
| | | 112 | This is the default. |
| | | 113 | Displays |
| | | 114 | number of transfers per second, |
| | | 115 | kilobytes per transfer, |
| | | 116 | and |
| | | 117 | megabytes transferred per second. |
| | | 118 | Use of this flag disables the default display of CPU and tty statistics. |
119 | .It Fl H Ar height | | 119 | .It Fl H Ar height |
120 | Set the page size (length, or height) explicitly, as the number of lines, | | 120 | Set the page size (length, or height) explicitly, as the number of lines, |
121 | .Ar height . | | 121 | .Ar height . |
122 | If not set, the page length is taken from the environment variable | | 122 | If not set, the page length is taken from the environment variable |
123 | .Ev LINES | | 123 | .Ev LINES |
124 | if set, or from the terminal (window) size, if output is to a terminal | | 124 | if set, or from the terminal (window) size, if output is to a terminal |
125 | and its size is set, | | 125 | and its size is set, |
126 | and otherwise defaults to 20. | | 126 | and otherwise defaults to 20. |
127 | If explicitly set to zero, pages are considered to be infinitely long. | | 127 | If explicitly set to zero, pages are considered to be infinitely long. |
128 | This parameter determines the frequency at which repeated headers are output. | | 128 | This parameter determines the frequency at which repeated headers are output. |
129 | If the value is greater than zero, but too small for the header, along with | | 129 | If the value is greater than zero, but too small for the header, along with |
130 | one output set, then a new header will be produced for each set of output. | | 130 | one output set, then a new header will be produced for each set of output. |
131 | .It Fl I | | 131 | .It Fl I |
132 | Show the running total values, rather than an average. | | 132 | Show the running total values, rather than an average. |
133 | .ig ii | | 133 | .ig ii |
134 | .It Fl i | | 134 | .It Fl i |
135 | Like | | 135 | Like |
136 | .Fl I | | 136 | .Fl I |
137 | except the totals shown are those since | | 137 | except the totals shown are those since |
138 | .Nm | | 138 | .Nm |
139 | started running, rather than since the system booted. | | 139 | started running, rather than since the system booted. |
140 | In this case the first output would necessarily be zero, | | 140 | In this case the first output would necessarily be zero, |
141 | so is suppressed. | | 141 | so is suppressed. |
142 | Consequently this option produces no output if neither | | 142 | Consequently this option produces no output if neither |
143 | .Fl w | | | |
144 | nor | | | |
145 | .Fl c | | 143 | .Fl c |
| | | 144 | nor |
| | | 145 | .Fl w |
146 | is given. | | 146 | is given. |
147 | .ii | | 147 | .ii |
148 | .It Fl T | | 148 | .It Fl T |
149 | Show tty statistics. | | 149 | Show tty statistics. |
150 | This is enabled by default unless one, or more, of the | | 150 | This is enabled by default unless one, or more, of the |
151 | .Fl C , | | 151 | .Fl C , |
152 | .Fl d , | | | |
153 | .Fl D , | | 152 | .Fl D , |
154 | .Fl x , | | 153 | .Fl d , |
155 | .Fl X , | | 154 | .Fl X , |
| | | 155 | .Fl x , |
156 | or | | 156 | or |
157 | .Fl y | | 157 | .Fl y |
158 | flags are used. | | 158 | flags are used. |
159 | .ig uu | | 159 | .ig uu |
160 | .It Fl u | | 160 | .It Fl u |
161 | When totals are being shown | | 161 | When totals are being shown |
162 | .Pq Fl I | | 162 | .Pq Fl I |
163 | .ig ii | | 163 | .ig ii |
164 | .Po or | | 164 | .Po or |
165 | .Fl i Pc | | 165 | .Fl i Pc |
166 | .ii | | 166 | .ii |
167 | include a column after each relevant output column | | 167 | include a column after each relevant output column |
168 | showing the difference between this output and the previous. | | 168 | showing the difference between this output and the previous. |
169 | These added columns will be blank in the first displayed output. | | 169 | These added columns will be blank in the first displayed output. |
170 | .uu | | 170 | .uu |
171 | .It Fl w Ar wait | | | |
172 | Pause | | | |
173 | .Ar wait | | | |
174 | seconds between each display. | | | |
175 | If no repeat | | | |
176 | .Ar count | | | |
177 | is specified, the default is infinity. | | | |
178 | .It Fl W Ar width | | 171 | .It Fl W Ar width |
179 | Set the page width explicitly, as the number of columns of characters, | | 172 | Set the page width explicitly, as the number of columns of characters, |
180 | .Ar width . | | 173 | .Ar width . |
181 | If not set, the page width is taken from the environment variable | | 174 | If not set, the page width is taken from the environment variable |
182 | .Ev COLUMNS | | 175 | .Ev COLUMNS |
183 | if set, or from the terminal (window) size, if output is to a terminal | | 176 | if set, or from the terminal (window) size, if output is to a terminal |
184 | and its size is set, | | 177 | and its size is set, |
185 | and otherwise defaults to 80. | | 178 | and otherwise defaults to 80. |
186 | If explicitly set to 0, lines are considered infinitely long. | | 179 | If explicitly set to 0, lines are considered infinitely long. |
187 | This width is used only to determine the number of drives to display | | 180 | This width is used only to determine the number of drives to display |
188 | by default when no drive list is given. | | 181 | by default when no drive list is given. |
189 | In other cases output will be as wide as needed to display the | | 182 | In other cases output will be as wide as needed to display the |
190 | data requested. | | 183 | data requested. |
| | | 184 | .It Fl w Ar wait |
| | | 185 | Pause |
| | | 186 | .Ar wait |
| | | 187 | seconds between each display. |
| | | 188 | If no repeat |
| | | 189 | .Ar count |
| | | 190 | is specified, the default is infinity. |
| | | 191 | .It Fl X |
| | | 192 | Show limited alternative disk statistics. |
| | | 193 | Displays megabytes transferred, and time spent in transfers, during the |
| | | 194 | .Ar wait |
| | | 195 | period (or since boot with |
| | | 196 | .Fl I ) . |
| | | 197 | Use of this flag disables the default display. |
191 | .It Fl x | | 198 | .It Fl x |
192 | Show extended disk statistics. | | 199 | Show extended disk statistics. |
193 | Each disk is displayed on a line of its own with all available | | 200 | Each disk is displayed on a line of its own with all available |
194 | statistics. | | 201 | statistics. |
195 | This option overrides all other display options, and all | | 202 | This option overrides all other display options, and all |
196 | disks are displayed unless specific disk names | | 203 | disks are displayed unless specific disk names |
197 | are provided as arguments. | | 204 | are provided as arguments. |
198 | Additionally, separate read and write statistics are displayed. | | 205 | Additionally, separate read and write statistics are displayed. |
199 | The | | 206 | The |
200 | .Fl C | | 207 | .Fl C |
201 | and | | 208 | and |
202 | .Fl T | | 209 | .Fl T |
203 | options are ignored with this output format. | | 210 | options are ignored with this output format. |
204 | .It Fl X | | | |
205 | Show limited alternative disk statistics. | | | |
206 | Displays megabytes transferred, and time spent in transfers, during the | | | |
207 | .Ar wait | | | |
208 | period (or since boot with | | | |
209 | .Fl I ) . | | | |
210 | Use of this flag disables the default display. | | | |
211 | .It Fl y | | 211 | .It Fl y |
212 | Shows the extended statistics (as with | | 212 | Shows the extended statistics (as with |
213 | .Fl x ) | | 213 | .Fl x ) |
214 | and additional queuing statistics. | | 214 | and additional queuing statistics. |
215 | Output does not fit in an 80 column window. | | 215 | Output does not fit in an 80 column window. |
216 | The | | 216 | The |
217 | .Fl C | | 217 | .Fl C |
218 | and | | 218 | and |
219 | .Fl T | | 219 | .Fl T |
220 | options are ignored with this output format. | | 220 | options are ignored with this output format. |
221 | .It Fl z | | 221 | .It Fl z |
222 | Replaces drive and CPU statistic outputs that are exactly zero with spaces. | | 222 | Replaces drive and CPU statistic outputs that are exactly zero with spaces. |
223 | Note that zero values can still appear \(en this indicates a | | 223 | Note that zero values can still appear \(en this indicates a |
| @@ -344,22 +344,22 @@ option was added in | | | @@ -344,22 +344,22 @@ option was added in |
344 | Collection of queuing values and the | | 344 | Collection of queuing values and the |
345 | .Fl y | | 345 | .Fl y |
346 | option were added in | | 346 | option were added in |
347 | .Nx 8.0 . | | 347 | .Nx 8.0 . |
348 | The | | 348 | The |
349 | .Fl X | | 349 | .Fl X |
350 | option was added in | | 350 | option was added in |
351 | .Nx 11.0 . | | 351 | .Nx 11.0 . |
352 | The archaic option format: | | 352 | The archaic option format: |
353 | .br | | 353 | .br |
354 | .ti +3n | | 354 | .ti +3n |
355 | .Nm | | 355 | .Nm |
356 | .Op Ar drives ... | | 356 | .Op Ar drives ... |
357 | .Oo Ar wait Op Ar count Oc | | 357 | .Oo Ar wait Oo Ar count Oc Oc |
358 | .br | | 358 | .br |
359 | remains supported (the first | | 359 | remains supported (the first |
360 | .Ar drive | | 360 | .Ar drive |
361 | whose name starts with a digit is taken to be the | | 361 | whose name starts with a digit is taken to be the |
362 | .Ar wait | | 362 | .Ar wait |
363 | period) but is deprecated, | | 363 | period) but is deprecated, |
364 | and may be removed in a future version, | | 364 | and may be removed in a future version, |
365 | so should not be used. | | 365 | so should not be used. |