From mboxrd@z Thu Jan 1 00:00:00 1970
Received: by passt.top (Postfix, from userid 1000)
id ED77F5A026B; Thu, 16 Feb 2023 02:09:00 +0100 (CET)
From: Stefano Brivio <sbrivio@redhat.com>
To: passt-dev@passt.top
Subject: [PATCH] passt.1: Fix typo, improve wording in examples of port forwarding specifiers
Date: Thu, 16 Feb 2023 02:09:00 +0100
Message-Id: <20230216010900.2224288-1-sbrivio@redhat.com>
X-Mailer: git-send-email 2.35.1
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Message-ID-Hash: RLTFLIZVC4BYMJELBPUSDL6KGI6EHVOA
X-Message-ID-Hash: RLTFLIZVC4BYMJELBPUSDL6KGI6EHVOA
X-MailFrom: sbrivio@passt.top
X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header
CC: Laine Stump <laine@redhat.com>, Yalan Zhang <yalzhang@redhat.com>
X-Mailman-Version: 3.3.3
Precedence: list
List-Id: Development discussion and patches for passt <passt-dev.passt.top>
Archived-At: <https://archives.passt.top/passt-dev/20230216010900.2224288-1-sbrivio@redhat.com/>
Archived-At: <https://passt.top/hyperkitty/list/passt-dev@passt.top/message/RLTFLIZVC4BYMJELBPUSDL6KGI6EHVOA/>
List-Archive: <https://archives.passt.top/passt-dev/>
List-Archive: <https://passt.top/hyperkitty/list/passt-dev@passt.top/>
List-Help: <mailto:passt-dev-request@passt.top?subject=help>
List-Owner: <mailto:passt-dev-owner@passt.top>
List-Post: <mailto:passt-dev@passt.top>
List-Subscribe: <mailto:passt-dev-join@passt.top>
List-Unsubscribe: <mailto:passt-dev-leave@passt.top>
Based on a patch from Laine, and reports from Laine and Yalan: fix
the "22-80:32-90" example, and improve wording for the other ones:
instead of using "to" to denote the end of a range, use "between ...
and", so that it's clear we're *not* referring to target ports.
Reported-by: Laine Stump <laine@redhat.com>
Reported-by: Yalan Zhang <yalzhang@redhat.com>
Fixes: da20f57f19dc ("passt, qrap: Add man pages")
Signed-off-by: Stefano Brivio <sbrivio@redhat.com>
---
passt.1 | 29 ++++++++++++++++-------------
1 file changed, 16 insertions(+), 13 deletions(-)
diff --git a/passt.1 b/passt.1
index 528763b..ec09c22 100644
--- a/passt.1
+++ b/passt.1
@@ -338,7 +338,7 @@ Examples:
.RS
.TP
-t 22
-Forward local port 22 to 22 on the guest
+Forward local port 22 to port 22 on the guest
.TP
-t 22:23
Forward local port 22 to port 23 on the guest
@@ -347,10 +347,11 @@ Forward local port 22 to port 23 on the guest
Forward local ports 22 and 25 to ports 22 and 25 on the guest
.TP
-t 22-80
-Forward local ports 22 to 80 to corresponding ports on the guest
+Forward local ports between 22 and 80 to corresponding ports on the guest
.TP
--t 22-80-32:90
-Forward local ports 22 to 80 to corresponding ports on the guest plus 10
+-t 22-80:32-90
+Forward local ports between 22 and 80 to corresponding ports on the guest, plus
+10
.TP
-t 192.0.2.1/22
Forward local port 22, bound to 192.0.2.1, to port 22 on the guest
@@ -359,10 +360,10 @@ Forward local port 22, bound to 192.0.2.1, to port 22 on the guest
Forward local port 22, bound to 192.0.2.1 and interface eth0, to port 22
.TP
-t 2000-5000,~3000-3010
-Forward local ports 2000 to 5000, but not 3000 to 3010
+Forward local ports between 2000 and 5000, but not between 3000 to 3010
.TP
-t 192.0.2.1/20-30,~25
-Forward local ports 20 to 24, and 26 to 30, bound to 192.0.2.1
+Forward local ports between 20 to 24, and between 26 to 30, bound to 192.0.2.1
.TP
-t ~20000-20010
Forward all ports to the guest, except for the range from 20000 to 20010
@@ -425,12 +426,13 @@ Forward local port 22 to port 23 in the target namespace
Forward local ports 22 and 25 to ports 22 and 25 in the target namespace
.TP
-t 22-80
-Forward local ports 22 to 80 to corresponding ports in the target namespace
-.TP
--t 22-80-32:90
-Forward local ports 22 to 80 to corresponding ports plus 10 in the target
+Forward local ports between 22 and 80 to corresponding ports in the target
namespace
.TP
+-t 22-80:32-90
+Forward local ports between 22 and 80 to corresponding ports, plus 10, in the
+target namespace
+.TP
-t 192.0.2.1/22
Forward local port 22, bound to 192.0.2.1, to port 22 in the target namespace
.TP
@@ -438,13 +440,14 @@ Forward local port 22, bound to 192.0.2.1, to port 22 in the target namespace
Forward local port 22, bound to 192.0.2.1 and interface eth0, to port 22
.TP
-t 2000-5000,~3000-3010
-Forward local ports 2000 to 5000, but not 3000 to 3010
+Forward local ports between 2000 and 5000, but not between 3000 to 3010
.TP
-t 192.0.2.1/20-30,~25
-Forward local ports 20 to 24, and 26 to 30, bound to 192.0.2.1
+Forward local ports between 20 to 24, and between 26 to 30, bound to 192.0.2.1
.TP
-t ~20000-20010
-Forward all ports to the namespace, except for the range from 20000 to 20010
+Forward all ports to the target namespace, except for the range from 20000 to
+20010
.RE
IPv6 bound ports are also forwarded for IPv4.
--
2.35.1