components/nicstat/patches/002-adjust-man-page.patch
author Mark Haywood <Mark.Haywood@Oracle.COM>
Wed, 18 Nov 2015 16:01:58 -0500
changeset 5105 4794ff32214d
parent 5029 77413b29eb5a
permissions -rw-r--r--
21653217 Integrate OpenvSwitch into Userland (fix audit)
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4066
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     1
Adjust the nicstat man page to just be Solaris specific.
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     2
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     3
These changes will be passed back upstream, to see if there is a way for
5029
77413b29eb5a 22107485 More Userland component man page normalizations
Rich Burridge <rich.burridge@oracle.com>
parents: 4066
diff changeset
     4
a Solaris or Linux man page to be obtained from a merged version
4066
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     5
5029
77413b29eb5a 22107485 More Userland component man page normalizations
Rich Burridge <rich.burridge@oracle.com>
parents: 4066
diff changeset
     6
--- nicstat.1.orig	2015-10-27 15:04:24.672109098 -0700
77413b29eb5a 22107485 More Userland component man page normalizations
Rich Burridge <rich.burridge@oracle.com>
parents: 4066
diff changeset
     7
+++ nicstat.1	2015-10-27 15:05:16.958756640 -0700
4066
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     8
@@ -14,7 +14,7 @@
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     9
 
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    10
 .SH NAME
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    11
 
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    12
-nicstat, enicstat \- print network traffic statistics
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    13
+nicstat \- print network traffic statistics
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    14
 .\" ========================================================================
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    15
 .SH SYNOPSIS
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    16
 .B nicstat
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    17
@@ -23,9 +23,6 @@
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    18
 .RI [-S int:mbps[fd|hd]]
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    19
 .I [interval
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    20
 .I [count]]
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    21
-.PP
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    22
-.B enicstat
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    23
-\fI<same options & operands>
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    24
 .\" ========================================================================
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    25
 
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    26
 .SH DESCRIPTION
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    27
@@ -106,17 +103,7 @@
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    28
 Show statistics for only the interface(s) listed.  Multiple interfaces
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    29
 can be listed, separated by commas (,).
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    30
 .TP 1i
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    31
-.BI \-S int:speed[fd|hd]
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    32
-(Linux only).
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    33
-Specify the speed (and optionally duplex mode) of one or more interfaces.
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    34
-The given speed(s) are in megabits/second.
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    35
-The duplex mode will default to "full" unless a suffix beginning with
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    36
-"h" or "H" is specified.
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    37
-Speed and duplex mode are obtained automatically on Solaris using the
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    38
-"ifspeed" and "link_duplex" kstat values.
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    39
-.TP 1i
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    40
 .B \-k
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    41
-(Solaris only).
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    42
 Search for active network interfaces by looking for kstat "link_state"
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    43
 statistics with a value of 1.  This is only of value on systems
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    44
 running Solaris 10 (or early releases of Solaris 11 Express), with
5029
77413b29eb5a 22107485 More Userland component man page normalizations
Rich Burridge <rich.burridge@oracle.com>
parents: 4066
diff changeset
    45
@@ -294,37 +281,18 @@
77413b29eb5a 22107485 More Userland component man page normalizations
Rich Burridge <rich.burridge@oracle.com>
parents: 4066
diff changeset
    46
 .fi
77413b29eb5a 22107485 More Userland component man page normalizations
Rich Burridge <rich.burridge@oracle.com>
parents: 4066
diff changeset
    47
 .\" ========================================================================
77413b29eb5a 22107485 More Userland component man page normalizations
Rich Burridge <rich.burridge@oracle.com>
parents: 4066
diff changeset
    48
 .SH SEE\ ALSO
77413b29eb5a 22107485 More Userland component man page normalizations
Rich Burridge <rich.burridge@oracle.com>
parents: 4066
diff changeset
    49
-.BR netstat (1M)
77413b29eb5a 22107485 More Userland component man page normalizations
Rich Burridge <rich.burridge@oracle.com>
parents: 4066
diff changeset
    50
-.BR kstat (1M),
77413b29eb5a 22107485 More Userland component man page normalizations
Rich Burridge <rich.burridge@oracle.com>
parents: 4066
diff changeset
    51
+.BR netstat (8)
77413b29eb5a 22107485 More Userland component man page normalizations
Rich Burridge <rich.burridge@oracle.com>
parents: 4066
diff changeset
    52
+.BR kstat (8),
4066
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    53
 .BR kstat (3KSTAT),
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    54
-.BR mibiisa (1M),
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    55
-.BR ethtool (8)
5029
77413b29eb5a 22107485 More Userland component man page normalizations
Rich Burridge <rich.burridge@oracle.com>
parents: 4066
diff changeset
    56
+.BR mibiisa (8)
4066
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    57
 
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    58
 "nicstat - the Solaris and Linux Network Monitoring Tool You Did Not Know You Needed"
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    59
 .RI - http://blogs.oracle.com/timc/entry/nicstat_the_solaris_and_linux
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    60
 .\" ========================================================================
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    61
 .SH NOTES
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    62
 .PP
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    63
-On Linux, the NoCP, Defer, TCP InKB, and TCP OutKB statistics are
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    64
-always reported as zero.
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    65
-.PP
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    66
 The way that saturation is reported is a best effort, as there is no
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    67
 standardized naming to capture all errors related to an interface's
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    68
 inability to receive or transmit a packet.  Monitoring %Util and
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    69
 packet rates, along with an understanding of the specific NICs may be
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    70
 more useful in judging whether you are nearing saturation.
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    71
-.PP
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    72
-The
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    73
-.B \-S
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    74
-option is provided for the Linux edition as nicstat requires
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    75
-super-user privilege to obtain speed and duplex mode information for
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    76
-interfaces.
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    77
-If you are unable to set up nicstat as setuid-root, a script named
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    78
-.B enicstat
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    79
-is available, which uses the
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    80
-.B ethtool
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    81
-utility then calls nicstat with an
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    82
-.B \-S
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    83
-value.
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    84
-.B ethtool
ab220f4ee1f7 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    85
-itself requires super-user privilege for this to work.