mirror of
https://github.com/OpenVPN/openvpn.git
synced 2024-09-20 12:02:28 +02:00
f500c49c8e
To avoid keeping around a full-size openvpn.rst file which is never needed but will take space in the repo forever, patches 01...04 of the big documentation overhaul projects were squashed togehter, keeping the individual commit logs and URL references below. Signed-off-by: Gert Doering <gert@greenie.muc.de> * This is a combination of 4 commits. * This is the 1st commit message: doc/man: Add an .rst formatted version of the man page This is the first step to move away from a manually editing g/nroff encoded man page. Some modifications was needed to ensure formatting was consistent and rendered reasonably okay in GitHub and that the generated man page (using rst2man) is looking as a proper man page. Unsupported options has also been moved into its own section. HTML rendering directly using rst2html has also been used to validate the conversion. The rst2man and rst2html utilities comes from the python-docutils project: https://docutils.sourceforge.io/ Signed-off-by: David Sommerseth <davids@openvpn.net> Acked-by: Gert Doering <gert@greenie.muc.de> Message-Id: <20200716225338.611-2-davids@openvpn.net> URL: https://sourceforge.net/p/openvpn/mailman/message/37063370/ Signed-off-by: Gert Doering <gert@greenie.muc.de> * This is the commit message #2: doc/man: Replace old man page with generated man page The doc/openvpn.8 and doc/openvpn.8.html files are now being removed from the git tree, as it will be generated from the doc/openvpn.8.rst file using python-docutils. An additional dist-hook is added so these files are generated automatically when source tarballs are generated for releases. This means users compiling directly from the source tarball will not need python-docutils installed. Signed-off-by: David Sommerseth <davids@openvpn.net> Acked-by: Gert Doering <gert@greenie.muc.de> Message-Id: <20200716225338.611-3-davids@openvpn.net> URL: https://sourceforge.net/p/openvpn/mailman/message/37063373/ Signed-off-by: Gert Doering <gert@greenie.muc.de> * This is the commit message #3: doc/man: Split up and reorganize main man page The openvpn.8.rst file is quite long and hard to edit, as it covers several hundred options. Some options were even documented multiple places. The example has also received some attention, cleaning up old and outdated infomration. In this commit the main man page is split up into multiple sections and options are sorted into each of the corresponding section. Inside each category, each option is for now sorted alphabetically. The main openvpn.8.rst file is currently kept unchanged and will be handled in the next commit. Many language improvements contributed by Richard Bonhomme has also been incorproated. Signed-off-by: David Sommerseth <davids@openvpn.net> Acked-by: Gert Doering <gert@greenie.muc.de> Message-Id: <20200716225338.611-4-davids@openvpn.net> URL: https://sourceforge.net/p/openvpn/mailman/message/37063376/ Signed-off-by: Gert Doering <gert@greenie.muc.de> * This is the commit message #4: doc/man: Complete openvpn.8.rst splitting This rebuilds the openvpn.8.rst content by using the text which was split out in the previous commit by using RST ..include statements. Signed-off-by: David Sommerseth <davids@openvpn.net> Acked-by: Gert Doering <gert@greenie.muc.de> Message-Id: <20200716225338.611-5-davids@openvpn.net> URL: https://sourceforge.net/p/openvpn/mailman/message/37063377/ Signed-off-by: Gert Doering <gert@greenie.muc.de>
66 lines
2.5 KiB
ReStructuredText
66 lines
2.5 KiB
ReStructuredText
--show-proxy-settings
|
|
Show sensed HTTP or SOCKS proxy settings. Currently, only Windows
|
|
clients support this option.
|
|
|
|
--http-proxy args
|
|
Connect to remote host through an HTTP proxy. This requires at least an
|
|
address ``server`` and ``port`` argument. If HTTP Proxy-Authenticate
|
|
is required, a file name to an ``authfile`` file containing a username
|
|
and password on 2 lines can be given, or :code:`stdin` to prompt from
|
|
console. Its content can also be specified in the config file with the
|
|
``--http-proxy-user-pass`` option. (See section on inline files)
|
|
|
|
The last optional argument is an ``auth-method`` which should be one
|
|
of :code:`none`, :code:`basic`, or :code:`ntlm`.
|
|
|
|
HTTP Digest authentication is supported as well, but only via the
|
|
:code:`auto` or :code:`auto-nct` flags (below). This must replace
|
|
the ``authfile`` argument.
|
|
|
|
The :code:`auto` flag causes OpenVPN to automatically determine the
|
|
``auth-method`` and query stdin or the management interface for
|
|
username/password credentials, if required. This flag exists on OpenVPN
|
|
2.1 or higher.
|
|
|
|
The ``auto-nct`` flag (no clear-text auth) instructs OpenVPN to
|
|
automatically determine the authentication method, but to reject weak
|
|
authentication protocols such as HTTP Basic Authentication.
|
|
|
|
Examples:
|
|
::
|
|
|
|
http-proxy proxy.example.net 3128
|
|
http-proxy proxy.example.net 3128 authfile.txt
|
|
http-proxy proxy.example.net 3128 stdin
|
|
http-proxy proxy.example.net 3128 auto basic
|
|
http-proxy proxy.example.net 3128 auto-nct ntlm
|
|
|
|
--http-proxy-option args
|
|
Set extended HTTP proxy options. Requires an option ``type`` as argument
|
|
and an optional ``parameter`` to the type. Repeat to set multiple
|
|
options.
|
|
|
|
:code:`VERSION` ``version``
|
|
Set HTTP version number to ``version`` (default :code:`1.0`).
|
|
|
|
:code:`AGENT` ``user-agent``
|
|
Set HTTP "User-Agent" string to ``user-agent``.
|
|
|
|
:code:`CUSTOM-HEADER` ``name`` ``content``
|
|
Adds the custom Header with ``name`` as name and ``content`` as
|
|
the content of the custom HTTP header.
|
|
|
|
Examples:
|
|
::
|
|
|
|
http-proxy-option VERSION 1.1
|
|
http-proxy-option AGENT OpenVPN/2.4
|
|
http-proxy-option X-Proxy-Flag some-flags
|
|
|
|
--socks-proxy args
|
|
Connect to remote host through a Socks5 proxy. A required ``server``
|
|
argument is needed. Optionally a ``port`` (default :code:`1080`) and
|
|
``authfile`` can be given. The ``authfile`` is a file containing a
|
|
username and password on 2 lines, or :code:`stdin` can be used to
|
|
prompt from console.
|