git: 18be782c4e5f - main - pfsync: Provide documentation regarding message version

From: Kristof Provost <kp_at_FreeBSD.org>
Date: Tue, 17 Oct 2023 06:40:12 UTC
The branch main has been updated by kp:

URL: https://cgit.FreeBSD.org/src/commit/?id=18be782c4e5fcbe4d37a951a6c77c13b3c11b8be

commit 18be782c4e5fcbe4d37a951a6c77c13b3c11b8be
Author:     Kajetan Staszkiewicz <vegeta@tuxpowered.net>
AuthorDate: 2023-10-17 04:38:47 +0000
Commit:     Kristof Provost <kp@FreeBSD.org>
CommitDate: 2023-10-17 04:38:47 +0000

    pfsync: Provide documentation regarding message version
    
    Reviewed by:    kp
    MFC after:      3 days
    Sponsored by:   InnoGames GmbH
    Differential Revision:  https://reviews.freebsd.org/D42235
---
 sbin/ifconfig/ifconfig.8 |  7 ++++++-
 share/man/man4/pfsync.4  | 28 +++++++++++++++++++++++++++-
 2 files changed, 33 insertions(+), 2 deletions(-)

diff --git a/sbin/ifconfig/ifconfig.8 b/sbin/ifconfig/ifconfig.8
index 1dc4c2e1b56d..bd6cbd05210e 100644
--- a/sbin/ifconfig/ifconfig.8
+++ b/sbin/ifconfig/ifconfig.8
@@ -27,7 +27,7 @@
 .\"
 .\"     From: @(#)ifconfig.8	8.3 (Berkeley) 1/5/94
 .\"
-.Dd June 20, 2023
+.Dd October 17, 2023
 .Dt IFCONFIG 8
 .Os
 .Sh NAME
@@ -2886,6 +2886,11 @@ acknowledged that the associated state has been inserted.
 .It Fl defer
 Do not defer the first packet in a state.
 This is the default.
+.It Fl version Ar n
+Configure message format for compatibility with older versions of FreeBSD.
+Refer to
+.Xr pfsync 4
+for details.
 .El
 .Ss VLAN Parameters
 The following parameters are specific to
diff --git a/share/man/man4/pfsync.4 b/share/man/man4/pfsync.4
index 5a1d576824e6..4decb50feb7b 100644
--- a/share/man/man4/pfsync.4
+++ b/share/man/man4/pfsync.4
@@ -24,7 +24,7 @@
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd December 6, 2018
+.Dd October 17, 2023
 .Dt PFSYNC 4
 .Os
 .Sh NAME
@@ -113,6 +113,32 @@ dedicated to pfsync messages such as a crossover cable between two firewalls,
 or specify a peer address and protect the traffic with
 .Xr ipsec 4 .
 .Pp
+When new features are introduced to
+.Xr pf 4
+the format of messages used by
+.Nm
+might change.
+.Nm
+will by default use the latest format.
+If synchronization with a peer running an older version of FreeBSD is needed the
+.Ar version
+parameter can be used.
+E.g.:
+.Bd -literal -offset indent
+# ifconfig pfsync0 version 1301
+.Ed
+.Pp
+.Bd
+Currently the following versions are supported:
+.Bl -tag -width indent
+.It Cm 1301
+FreeBSD releases 13.2 and older.
+Compatibility with FreeBSD 13.1 has been verified.
+.It Cm 1400
+FreeBSD release 14.0.
+.El
+.Ed
+.Pp
 .Nm
 has the following
 .Xr sysctl 8