Attention is currently required from: plaisthos.
Hello plaisthos,
I'd like you to do a code review.
Please visit
http://gerrit.openvpn.net/c/openvpn/+/1560?usp=email
to review the following change.
Change subject: doc: fix client-nat syntax and examples
......................................................................
doc: fix client-nat syntax and examples
The client-nat documentation uses an incorrect command form and
incomplete examples.
Document the actual syntax accepted by openvpn:
client-nat snat|dnat network netmask alias
Update examples to include all required arguments and rewrite the
explanatory text to describe 'network', 'netmask', and 'alias'
separately.
Documentation-only change; no behavior change.
Change-Id: I89f0aa9a23915c7783ae03793080ee989a437208
Signed-off-by: Ralf Lici <[email protected]>
---
M doc/man-sections/client-options.rst
1 file changed, 11 insertions(+), 6 deletions(-)
git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/60/1560/1
diff --git a/doc/man-sections/client-options.rst
b/doc/man-sections/client-options.rst
index b9ae7ce..85d25e5 100644
--- a/doc/man-sections/client-options.rst
+++ b/doc/man-sections/client-options.rst
@@ -132,16 +132,21 @@
ifconfig settings pushed to the client would create an IP numbering
conflict.
+ Valid syntax:
+ ::
+
+ client-nat snat|dnat network netmask alias
+
Examples:
::
- client-nat snat 192.168.0.0/255.255.0.0
- client-nat dnat 10.64.0.0/255.255.0.0
+ client-nat snat 192.168.0.0 255.255.0.0 10.64.0.0
+ client-nat dnat 10.64.0.0 255.255.0.0 192.168.0.0
- ``network/netmask`` (for example :code:`192.168.0.0/255.255.0.0`) defines
- the local view of a resource from the client perspective, while
- ``alias/netmask`` (for example :code:`10.64.0.0/255.255.0.0`) defines the
- remote view from the server perspective.
+ ``network`` and ``netmask`` (for example :code:`192.168.0.0
+ 255.255.0.0`) define the local view of a resource from the client
+ perspective, while ``alias`` (for example :code:`10.64.0.0`) defines the
+ remote view from the server perspective using the same netmask.
Use :code:`snat` (source NAT) for resources owned by the client and
:code:`dnat` (destination NAT) for remote resources.
--
To view, visit http://gerrit.openvpn.net/c/openvpn/+/1560?usp=email
To unsubscribe, or for help writing mail filters, visit
http://gerrit.openvpn.net/settings?usp=email
Gerrit-MessageType: newchange
Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: I89f0aa9a23915c7783ae03793080ee989a437208
Gerrit-Change-Number: 1560
Gerrit-PatchSet: 1
Gerrit-Owner: ralf_lici <[email protected]>
Gerrit-Reviewer: plaisthos <[email protected]>
Gerrit-CC: openvpn-devel <[email protected]>
Gerrit-Attention: plaisthos <[email protected]>
_______________________________________________
Openvpn-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/openvpn-devel
