upstream/openvpn
1
0
Fork 0
mirror of https://github.com/OpenVPN/openvpn.git synced 2026-06-06 23:36:32 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

documentation: Fixes for previous fixes to --push-peer-info

Browse source 
- Clarify compression IV_ settings
- Clarify which settings might come from --setenv

Change-Id: Id8615515c8df6e38e931e357396811234faad796
Signed-off-by: Frank Lichtenheld <frank@lichtenheld.com>
Acked-by: Arne Schwabe <arne@rfc2549.org>
Message-Id: <20240206174745.74828-1-frank@lichtenheld.com>
URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg28184.html
Signed-off-by: Gert Doering <gert@greenie.muc.de>
(cherry picked from commit c1e1d132f6)
This commit is contained in:
Frank Lichtenheld 2024-02-06 18:47:45 +01:00 committed by Gert Doering
parent 18fb30f7ad
commit 6bed72d0f2
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/man-sections/client-options.rst
View file

@ -374,10 +374,11 @@ configuration.
:code:`IV_GUI_VER=<gui_id> <version>`
The UI version of a UI if one is running, for example
:code:`de.blinkt.openvpn 0.5.47` for the Android app.
This may be set by the client UI/GUI using ``--setenv``.
:code:`IV_SSO=[crtext,][openurl,][proxy_url]`
Additional authentication methods supported by the client.
This may be set by the client UI/GUI using ``--setenv``
This may be set by the client UI/GUI using ``--setenv``.
The following flags depend on which compression formats are compiled in
and whether compression is allowed by options. See `Protocol options`_
@ -388,13 +389,15 @@ configuration.
:code:`IV_LZO_STUB=1`
If client was built with LZO stub capability. This is only sent if
``IV_LZO=1`` is not sent.
``IV_LZO=1`` is not sent. This means the client can talk to a server
configured with ``--comp-lzo no``.
:code:`IV_LZ4=1` and :code:`IV_LZ4v2=1`
If the client supports LZ4 compression.
:code:`IV_COMP_STUB=1` and :code:`IV_COMP_STUBv2=1`
If the client supports stub compression.
If the client supports stub compression. This means the client can talk
to a server configured with ``--compress``.
When ``--push-peer-info`` is enabled the additional information consists
of the following data:
@ -414,7 +417,9 @@ configuration.
:code:`IV_PLAT_VER=x.y`
The version of the operating system, e.g. 6.1 for Windows 7.
This is only sent on Windows operating systems.
This may be set by the client UI/GUI using ``--setenv``.
On Windows systems it is automatically determined by openvpn
itself.
:code:`UV_<name>=<value>`
Client environment variables whose names start with