All of lore.kernel.org
 help / color / mirror / Atom feed
From: rawal.abhishek92@gmail.com
To: netdev@vger.kernel.org
Cc: stephen@networkplumber.org, dsahern@gmail.com, arawal@redhat.com,
	jamie.bainbridge@gmail.com,
	Abhishek Rawal <rawal.abhishek92@gmail.com>
Subject: [PATCH next] man: ss.8: add description for SCTP related entries.
Date: Thu, 28 Nov 2024 10:13:40 +0530	[thread overview]
Message-ID: <20241128044340.27897-1-rawal.abhishek92@gmail.com> (raw)

From: Abhishek Rawal <rawal.abhishek92@gmail.com>

SCTP protocol support is included, but manpage lacks
the description for its entries. Add the missing
descriptions so that SCTP information is complete.

Signed-off-by: Abhishek Rawal <rawal.abhishek92@gmail.com>
Reviewed-by: Jamie Bainbridge <jamie.bainbridge@gmail.com>
---
 man/man8/ss.8 | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 53 insertions(+), 1 deletion(-)

diff --git a/man/man8/ss.8 b/man/man8/ss.8
index e23af826f467433623dcdc639e1023a87e487e81..736c51d11b59ae193a9173ae0ec2a37f4e6c4853 100644
--- a/man/man8/ss.8
+++ b/man/man8/ss.8
@@ -167,7 +167,7 @@ Show thread using socket. Implies
 .BR \-p .
 .TP
 .B \-i, \-\-info
-Show internal TCP information. Below fields may appear:
+Show internal TCP & SCTP information. Below fields may appear:
 .RS
 .P
 .TP
@@ -277,6 +277,58 @@ a helper variable for TCP internal auto tuning socket receive buffer
 .B tcp-ulp-mptcp flags:[MmBbJjecv] token:<rem_token(rem_id)/loc_token(loc_id)> seq:<sn> sfseq:<ssn> ssnoff:<off> maplen:<maplen>
 MPTCP subflow information
 .P
+.TP
+.B locals:<locals>
+Local SCTP IP addresses.
+.P
+.TP
+.B peers:<peers>
+Peer SCTP IP addresses.
+.P
+.TP
+.B tag:<tag>
+Tag expected in every inbound packet and sent in the INIT or INIT ACK chunk i.e Verification Tag.
+.P
+.TP
+.B state:<state>
+State of association i.e COOKIE-WAIT, COOKIE-ECHOED, ESTABLISHED, SHUTDOWN-PENDING, SHUTDOWN-SENT, SHUTDOWN-RECEIVED, SHUTDOWN-ACK-SENT.
+.P
+.TP
+.B rwnd:<rwnd>
+The last advertised value of rwnd over a SACK chunk.
+.P
+.TP
+.B prwnd:<prwnd>
+Current calculated value of the peer's rwnd.
+.P
+.TP
+.B ptag:<ptag>
+Tag expected in every outbound packet except in the INIT chunk i.e Peer Tag.
+.P
+.TP
+.B instrms:<instrms>
+Maximum number of inbound streams the association supports.
+.P
+.TP
+.B outstrms:<outstrms>
+Maximum number of outbound streams the association supports.
+.P
+.TP
+.B maxburst:<maxburst>
+Maximum number of new data packets that can be sent in a burst.
+.P
+.TP
+.B maxseg:<maxseg>
+Message size after which SCTP fragmentation will occur.
+.P
+.TP
+.B unackdata:<unackdata>
+The number of unacknowledged data chunks.
+.P
+.TP
+.B penddata:<penddata>
+Chunks missing from the peer.
+.P
 .RE
 .TP
 .B \-\-tos
-- 
2.47.0


             reply	other threads:[~2024-11-28  4:43 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-11-28  4:43 rawal.abhishek92 [this message]
2024-12-02 19:29 ` [PATCH next] man: ss.8: add description for SCTP related entries Stephen Hemminger
2024-12-03  2:51   ` Abhishek Rawal

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20241128044340.27897-1-rawal.abhishek92@gmail.com \
    --to=rawal.abhishek92@gmail.com \
    --cc=arawal@redhat.com \
    --cc=dsahern@gmail.com \
    --cc=jamie.bainbridge@gmail.com \
    --cc=netdev@vger.kernel.org \
    --cc=stephen@networkplumber.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.