diff mbox series

[next] man: ss.8: add description for SCTP related entries.

Message ID 20241128044340.27897-1-rawal.abhishek92@gmail.com (mailing list archive)
State New
Headers show
Series [next] man: ss.8: add description for SCTP related entries. | expand

Checks

Context Check Description
netdev/tree_selection success Not a local patch

Commit Message

rawal.abhishek92@gmail.com Nov. 28, 2024, 4:43 a.m. UTC 
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 mbox series

Patch

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