The server returns "AUTH_FAILED". Such strings and code related references should use the :code:`SOME_STRING` style.
Signed-off-by: David Sommerseth <dav...@openvpn.net> --- doc/man-sections/client-options.rst | 10 +++++----- doc/man-sections/script-options.rst | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/man-sections/client-options.rst b/doc/man-sections/client-options.rst index 98b80cb1..249af0a3 100644 --- a/doc/man-sections/client-options.rst +++ b/doc/man-sections/client-options.rst @@ -28,7 +28,7 @@ configuration. where the server can push new options to the client. The password the user entered is never preserved once an authentication token has been set. If the OpenVPN server side rejects the authentication token then - the client will receive an ``AUTH_FAIL`` and disconnect. + the client will receive an :code:`AUTH_FAILED` and disconnect. The purpose of this is to enable two factor authentication methods, such as HOTP or TOTP, to be used without needing to retrieve a new OTP code @@ -70,14 +70,14 @@ configuration. --auth-retry type Controls how OpenVPN responds to username/password verification errors - such as the client-side response to an AUTH\_FAILED message from the - server or verification failure of the private key password. + such as the client-side response to an :code:`AUTH_FAILED` message from + the server or verification failure of the private key password. Normally used to prevent auth errors from being fatal on the client side, and to permit username/password requeries in case of error. - An AUTH\_FAILED message is generated by the server if the client fails - ``--auth-user-pass`` authentication, or if the server-side + An :code:`AUTH_FAILED` message is generated by the server if the client + fails ``--auth-user-pass`` authentication, or if the server-side ``--client-connect`` script returns an error status when the client tries to connect. diff --git a/doc/man-sections/script-options.rst b/doc/man-sections/script-options.rst index 8ea5b4a7..ee209a6d 100644 --- a/doc/man-sections/script-options.rst +++ b/doc/man-sections/script-options.rst @@ -467,7 +467,7 @@ permitted character class for each string: *--auth-user-pass username* Same as Common Name, with one exception: starting with OpenVPN 2.0.1, the username is passed to the - OPENVPN\_PLUGIN\_AUTH\_USER\_PASS\_VERIFY plugin in its raw form, + :code:`OPENVPN_PLUGIN_AUTH_USER_PASS_VERIFY` plugin in its raw form, without string remapping. *--auth-user-pass password* -- 2.26.0 _______________________________________________ Openvpn-devel mailing list Openvpn-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/openvpn-devel