git: 81b4bf08955a - main - man: improve man pages for dtrace_sctp and dtrace_tcp

From: Michael Tuexen <tuexen_at_FreeBSD.org>
Date: Thu, 29 Jun 2023 13:01:22 UTC
The branch main has been updated by tuexen:

URL: https://cgit.FreeBSD.org/src/commit/?id=81b4bf08955a86e51cbc7ff878e95ff5e86e5eee

commit 81b4bf08955a86e51cbc7ff878e95ff5e86e5eee
Author:     Michael Tuexen <tuexen@FreeBSD.org>
AuthorDate: 2023-06-29 12:53:56 +0000
Commit:     Michael Tuexen <tuexen@FreeBSD.org>
CommitDate: 2023-06-29 12:59:51 +0000

    man: improve man pages for dtrace_sctp and dtrace_tcp
    
    Reviewed by:            manpages
    MFC after:              3 days
    Sponsored by:           Netflix, Inc.
    Differential Revision:  https://reviews.freebsd.org/D40796
---
 share/man/man4/dtrace_sctp.4 | 14 +++++++-------
 share/man/man4/dtrace_tcp.4  |  6 +++---
 2 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/share/man/man4/dtrace_sctp.4 b/share/man/man4/dtrace_sctp.4
index 7da53ca1f383..7f8490e97ab4 100644
--- a/share/man/man4/dtrace_sctp.4
+++ b/share/man/man4/dtrace_sctp.4
@@ -23,7 +23,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd August 22, 2018
+.Dd June 29, 2023
 .Dt DTRACE_SCTP 4
 .Os
 .Sh NAME
@@ -150,20 +150,20 @@ A script that logs SCTP packets in real time:
 
 dtrace:::BEGIN
 {
-        printf(" %3s %15s:%-5s      %15s:%-5s\n", "CPU",
+        printf(" %3s %15s:%-5s      %15s:%-5s\\n", "CPU",
             "LADDR", "LPORT", "RADDR", "RPORT");
 }
 
 sctp:::send
 {
-        printf(" %3d %16s:%-5d -> %16s:%-5d\n", cpu,
+        printf(" %3d %16s:%-5d -> %16s:%-5d\\n", cpu,
             args[2]->ip_saddr, args[4]->sctp_sport,
             args[2]->ip_daddr, args[4]->sctp_dport);
 }
 
 sctp:::receive
 {
-        printf(" %3d %16s:%-5d <- %16s:%-5d\n", cpu,
+        printf(" %3d %16s:%-5d <- %16s:%-5d\\n", cpu,
             args[2]->ip_daddr, args[4]->sctp_dport,
             args[2]->ip_saddr, args[4]->sctp_sport);
 }
@@ -177,7 +177,7 @@ int last[int];
 
 dtrace:::BEGIN
 {
-        printf(" %3s %12s  %-25s    %-25s\n",
+        printf(" %3s %12s  %-25s    %-25s\\n",
             "CPU", "DELTA(us)", "OLD", "NEW");
 }
 
@@ -185,7 +185,7 @@ sctp:::state-change
 / last[args[1]->cs_cid] /
 {
         this->elapsed = (timestamp - last[args[1]->cs_cid]) / 1000;
-        printf(" %3d %12d  %-25s -> %-25s\n", cpu, this->elapsed,
+        printf(" %3d %12d  %-25s -> %-25s\\n", cpu, this->elapsed,
             sctp_state_string[args[5]->sctps_state],
             sctp_state_string[args[3]->sctps_state]);
         last[args[1]->cs_cid] = timestamp;
@@ -194,7 +194,7 @@ sctp:::state-change
 sctp:::state-change
 / last[args[1]->cs_cid] == 0 /
 {
-        printf(" %3d %12s  %-25s -> %-25s\n", cpu, "-",
+        printf(" %3d %12s  %-25s -> %-25s\\n", cpu, "-",
             sctp_state_string[args[5]->sctps_state],
             sctp_state_string[args[3]->sctps_state]);
         last[args[1]->cs_cid] = timestamp;
diff --git a/share/man/man4/dtrace_tcp.4 b/share/man/man4/dtrace_tcp.4
index dbe3dd7ac099..5372b1a858f0 100644
--- a/share/man/man4/dtrace_tcp.4
+++ b/share/man/man4/dtrace_tcp.4
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd August 1, 2018
+.Dd June 29, 2023
 .Dt DTRACE_TCP 4
 .Os
 .Sh NAME
@@ -317,7 +317,7 @@ tcp:::send
         printf("%s", args[4]->tcp_flags & TH_ACK ? "ACK|" : "");
         printf("%s", args[4]->tcp_flags & TH_URG ? "URG|" : "");
         printf("%s", args[4]->tcp_flags == 0 ? "null " : "");
-        printf("\b)\\n");
+        printf("\\b)\\n");
 }
 
 tcp:::receive
@@ -333,7 +333,7 @@ tcp:::receive
         printf("%s", args[4]->tcp_flags & TH_ACK ? "ACK|" : "");
         printf("%s", args[4]->tcp_flags & TH_URG ? "URG|" : "");
         printf("%s", args[4]->tcp_flags == 0 ? "null " : "");
-        printf("\b)\\n");
+        printf("\\b)\\n");
 }
 .Ed
 The following script logs TCP connection state changes as they occur: