Bug 194781 - iostat(8) man page incorrect for -w
Summary: iostat(8) man page incorrect for -w
Status: New
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: amd64 Any
: --- Affects Some People
Assignee: freebsd-bugs (Nobody)
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2014-11-03 13:09 UTC by mwlucas
Modified: 2018-04-09 07:18 UTC (History)
4 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description mwlucas 2014-11-03 13:09:35 UTC 
iostat(8) says:

     -w    Pause wait seconds between each display.  If no wait interval is
           specified, the default is 1 second.

iostat itself disagrees:

iostat -xw
iostat: option requires an argument -- w
usage: iostat [-CdhIKoTxz?] [-c count] [-M core] [-n devs] [-N system]
              [-t type,if,pass] [-w wait] [drives]

Suggest dropping the second sentence from the man page entry.
Comment 1 Benjamin Kaduk freebsd_committer freebsd_triage 2014-11-03 16:55:43 UTC 
From r215786:

Clarify a few details about iostat(8) behavior:

- The default repeat count for iostat(8) is 1 unless there
  was a -w on the command line.

The second sentence should remain, but perhaps could change to "If -w is not specified, [...]".
Comment 2 Steven Hartland freebsd_committer freebsd_triage 2014-11-03 17:08:40 UTC 
No not really as if -w isn't specified it doesn't do interval based display.
Comment 3 Benjamin Kaduk freebsd_committer freebsd_triage 2014-11-03 17:25:56 UTC 
(In reply to Steven Hartland from comment #2)
> No not really as if -w isn't specified it doesn't do interval based display.

Not even if a -c count is specified?
Comment 4 Benjamin Kaduk freebsd_committer freebsd_triage 2014-11-03 17:25:56 UTC 
(In reply to Steven Hartland from comment #2)
> No not really as if -w isn't specified it doesn't do interval based display.

Not even if a -c count is specified?
Comment 5 Steven Hartland freebsd_committer freebsd_triage 2014-11-03 17:34:44 UTC 
You're correct if -c X is specified by no -w then it defaults to 1 second.
Comment 6 Warren Block freebsd_committer freebsd_triage 2014-11-03 18:03:15 UTC 
Bug 153012 is similar, and has a patch that might be useful.
Comment 7 Benjamin Kaduk freebsd_committer freebsd_triage 2014-11-03 18:05:08 UTC 
The cleanups I made for vmstat.8 in r269727 might also be worth looking at.