components/nicstat/patches/002-adjust-man-page.patch
author Huie-Ying Lee <huieying.lee@oracle.com>
Wed, 20 May 2015 15:14:17 -0700
branchs11-update
changeset 4329 771a6f41f496
parent 4127 2df9ab3557a8
child 5029 77413b29eb5a
permissions -rw-r--r--
21078900 openssh server should fatal out when pam_setcred and pam_open_session fail
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4127
2df9ab3557a8 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.
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     2
2df9ab3557a8 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
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     4
a Solaris or Linux man page can be obtained from a merged version
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     5
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     6
--- nicstat.1.orig	2014-11-23 17:37:32.617985414 -0800
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     7
+++ nicstat.1	2014-11-23 17:47:12.637407628 -0800
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     8
@@ -14,7 +14,7 @@
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
     9
 
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    10
 .SH NAME
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    11
 
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    12
-nicstat, enicstat \- print network traffic statistics
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    13
+nicstat \- print network traffic statistics
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    14
 .\" ========================================================================
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    15
 .SH SYNOPSIS
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    16
 .B nicstat
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    17
@@ -23,9 +23,6 @@
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    18
 .RI [-S int:mbps[fd|hd]]
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    19
 .I [interval
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    20
 .I [count]]
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    21
-.PP
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    22
-.B enicstat
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    23
-\fI<same options & operands>
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    24
 .\" ========================================================================
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    25
 
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    26
 .SH DESCRIPTION
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    27
@@ -106,17 +103,7 @@
2df9ab3557a8 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
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    29
 can be listed, separated by commas (,).
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    30
 .TP 1i
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    31
-.BI \-S int:speed[fd|hd]
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    32
-(Linux only).
2df9ab3557a8 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.
2df9ab3557a8 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.
2df9ab3557a8 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
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    36
-"h" or "H" is specified.
2df9ab3557a8 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
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    38
-"ifspeed" and "link_duplex" kstat values.
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    39
-.TP 1i
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    40
 .B \-k
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    41
-(Solaris only).
2df9ab3557a8 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"
2df9ab3557a8 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
2df9ab3557a8 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
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    45
@@ -297,34 +284,15 @@
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    46
 .BR netstat (1M)
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    47
 .BR kstat (1M),
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    48
 .BR kstat (3KSTAT),
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    49
-.BR mibiisa (1M),
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    50
-.BR ethtool (8)
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    51
+.BR mibiisa (1M)
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    52
 
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    53
 "nicstat - the Solaris and Linux Network Monitoring Tool You Did Not Know You Needed"
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    54
 .RI - http://blogs.oracle.com/timc/entry/nicstat_the_solaris_and_linux
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    55
 .\" ========================================================================
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    56
 .SH NOTES
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    57
 .PP
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    58
-On Linux, the NoCP, Defer, TCP InKB, and TCP OutKB statistics are
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    59
-always reported as zero.
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    60
-.PP
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    61
 The way that saturation is reported is a best effort, as there is no
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    62
 standardized naming to capture all errors related to an interface's
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    63
 inability to receive or transmit a packet.  Monitoring %Util and
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    64
 packet rates, along with an understanding of the specific NICs may be
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    65
 more useful in judging whether you are nearing saturation.
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    66
-.PP
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    67
-The
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    68
-.B \-S
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    69
-option is provided for the Linux edition as nicstat requires
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    70
-super-user privilege to obtain speed and duplex mode information for
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    71
-interfaces.
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    72
-If you are unable to set up nicstat as setuid-root, a script named
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    73
-.B enicstat
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    74
-is available, which uses the
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    75
-.B ethtool
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    76
-utility then calls nicstat with an
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    77
-.B \-S
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    78
-value.
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    79
-.B ethtool
2df9ab3557a8 PSARC 2014/401 nicstat version 1.95
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset
    80
-itself requires super-user privilege for this to work.