openvpn/doc/man-sections
Ralf Lici 0481d9374f
Some checks failed
Build / Check code style with Uncrustify (push) Has been cancelled
Build / gcc-mingw - x64 - OSSL (push) Has been cancelled
Build / gcc-mingw - x86 - OSSL (push) Has been cancelled
Build / gcc - ubuntu-24.04 - OpenSSL 3.0.13 --enable-pkcs11 (push) Has been cancelled
Build / gcc - ubuntu-22.04 - OpenSSL 3.0.2 --enable-pkcs11 (push) Has been cancelled
Build / gcc - ubuntu-22.04 - mbed TLS 2.28.0 (push) Has been cancelled
Build / clang-asan - ubuntu-22.04 - mbedtls (push) Has been cancelled
Build / clang-asan - ubuntu-22.04 - openssl (push) Has been cancelled
Build / clang-asan - ubuntu-24.04 - mbedtls (push) Has been cancelled
Build / clang-asan - ubuntu-24.04 - openssl (push) Has been cancelled
Build / macos-13 - libressl - asan (push) Has been cancelled
Build / macos-13 - openssl@1.1 - asan (push) Has been cancelled
Build / macos-13 - openssl@3 - asan (push) Has been cancelled
Build / macos-14 - libressl - asan (push) Has been cancelled
Build / macos-14 - openssl@1.1 - asan (push) Has been cancelled
Build / macos-14 - openssl@3 - asan (push) Has been cancelled
Build / macos-15 - libressl - asan (push) Has been cancelled
Build / macos-15 - openssl@1.1 - asan (push) Has been cancelled
Build / macos-15 - openssl@3 - asan (push) Has been cancelled
Build / macos-13 - libressl - normal (push) Has been cancelled
Build / macos-13 - openssl@1.1 - normal (push) Has been cancelled
Build / macos-13 - openssl@3 - normal (push) Has been cancelled
Build / macos-14 - libressl - normal (push) Has been cancelled
Build / macos-14 - openssl@1.1 - normal (push) Has been cancelled
Build / macos-14 - openssl@3 - normal (push) Has been cancelled
Build / macos-15 - libressl - normal (push) Has been cancelled
Build / macos-15 - openssl@1.1 - normal (push) Has been cancelled
Build / macos-15 - openssl@3 - normal (push) Has been cancelled
Build / msbuild - amd64 - openssl (push) Has been cancelled
Build / msbuild - arm64 - openssl (push) Has been cancelled
Build / msbuild - x86 - openssl (push) Has been cancelled
Build / clang asan - ubuntu-22.04 - libressl (push) Has been cancelled
Build / gcc normal - ubuntu-22.04 - libressl (push) Has been cancelled
Build / mingw unittest argv - x64 - OSSL (push) Has been cancelled
Build / mingw unittest auth_token - x64 - OSSL (push) Has been cancelled
Build / mingw unittest buffer - x64 - OSSL (push) Has been cancelled
Build / mingw unittest crypto - x64 - OSSL (push) Has been cancelled
Build / mingw unittest cryptoapi - x64 - OSSL (push) Has been cancelled
Build / mingw unittest misc - x64 - OSSL (push) Has been cancelled
Build / mingw unittest ncp - x64 - OSSL (push) Has been cancelled
Build / mingw unittest packet_id - x64 - OSSL (push) Has been cancelled
Build / mingw unittest pkt - x64 - OSSL (push) Has been cancelled
Build / mingw unittest provider - x64 - OSSL (push) Has been cancelled
Build / mingw unittest tls_crypt - x64 - OSSL (push) Has been cancelled
Build / mingw unittest argv - x86 - OSSL (push) Has been cancelled
Build / mingw unittest auth_token - x86 - OSSL (push) Has been cancelled
Build / mingw unittest buffer - x86 - OSSL (push) Has been cancelled
Build / mingw unittest crypto - x86 - OSSL (push) Has been cancelled
Build / mingw unittest cryptoapi - x86 - OSSL (push) Has been cancelled
Build / mingw unittest misc - x86 - OSSL (push) Has been cancelled
Build / mingw unittest ncp - x86 - OSSL (push) Has been cancelled
Build / mingw unittest packet_id - x86 - OSSL (push) Has been cancelled
Build / mingw unittest pkt - x86 - OSSL (push) Has been cancelled
Build / mingw unittest provider - x86 - OSSL (push) Has been cancelled
Build / mingw unittest tls_crypt - x86 - OSSL (push) Has been cancelled
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 <ralf@mandelbit.com>
Acked-by: Frank Lichtenheld <frank@lichtenheld.com>
Gerrit URL: https://gerrit.openvpn.net/c/openvpn/+/1560
Message-Id: <20260309130546.7735-1-gert@greenie.muc.de>
URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg35966.html
Signed-off-by: Gert Doering <gert@greenie.muc.de>
(cherry picked from commit 60986ae533)
2026-03-09 14:40:39 +01:00
..
advanced-options.rst dco: add documentation for ovpn-dco-linux 2022-08-05 12:56:41 +02:00
cipher-negotiation.rst documentation: make section levels consistent 2024-03-25 16:25:07 +01:00
client-options.rst doc: fix client-nat syntax and examples 2026-03-09 14:40:39 +01:00
connection-profiles.rst Various typo fixes 2024-11-28 13:33:21 +01:00
encryption-options.rst documentation: make section levels consistent 2024-03-25 16:25:07 +01:00
example-fingerprint.rst Improve peer fingerprint documentation 2025-01-14 16:57:13 +01:00
examples.rst doc: run rst2* with --strict to catch warnings 2023-04-11 16:47:34 +02:00
generic-options.rst Fix tmp-dir documentation 2025-04-28 16:26:06 +02:00
inline-files.rst Document that auth-user-pass may be inlined 2024-02-23 12:42:45 +01:00
link-options.rst doc: Fix hyperlinks in openvpn(8) 2025-10-13 17:37:01 +02:00
log-options.rst Remove inetd support from OpenVPN 2021-01-30 11:03:40 +01:00
management-options.rst Allow management client to announce pss padding support 2022-01-20 16:29:45 +01:00
network-config.rst doc/man: Documentation for --bind-dev / VRFs on Linux 2020-07-17 12:58:58 +02:00
pkcs11-options.rst documentation: make section levels consistent 2024-03-25 16:25:07 +01:00
plugin-options.rst plug-ins: Disallow multiple deferred authentication plug-ins 2022-03-15 17:51:48 +01:00
protocol-options.rst doc: Fix hyperlinks in openvpn(8) 2025-10-13 17:37:01 +02:00
proxy-options.rst proxy-options.rst: Add proper documentation for --http-proxy-user-pass 2024-01-18 17:58:33 +01:00
renegotiation.rst documentation: make section levels consistent 2024-03-25 16:25:07 +01:00
script-options.rst Fix tmp-dir documentation 2025-04-28 16:26:06 +02:00
server-options.rst Fix port-share journal doc 2024-12-08 15:20:21 +01:00
signals.rst doc/man: convert openvpn.8 to split-up .rst files 2020-07-17 11:23:18 +02:00
tls-options.rst documentation: make section levels consistent 2024-03-25 16:25:07 +01:00
unsupported-options.rst documentation: update 'unsupported options' section 2023-01-11 14:52:54 +01:00
virtual-routing-and-forwarding.rst doc: run rst2* with --strict to catch warnings 2023-04-11 16:47:34 +02:00
vpn-network-options.rst remove repetitive words in documentation and comments 2024-03-08 16:48:35 +01:00
windows-options.rst Implement Windows CA template match for Crypto-API selector 2024-06-06 21:33:28 +02:00