[Openvpn-devel,16/16] doc/man: Minor improvements to the plug-in section

Message ID 20200715223013.11726-17-davids@openvpn.net
State Superseded
Headers show
Series
  • man-page overhaul project
Related show

Commit Message

David Sommerseth July 15, 2020, 10:30 p.m.
Make the valid syntax clearer and apply proper styling of few
reference strings.

Signed-off-by: David Sommerseth <davids@openvpn.net>
---
 doc/man-sections/plugin-options.rst | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

Patch

diff --git a/doc/man-sections/plugin-options.rst b/doc/man-sections/plugin-options.rst
index 20b74edd..1beccd3d 100644
--- a/doc/man-sections/plugin-options.rst
+++ b/doc/man-sections/plugin-options.rst
@@ -5,7 +5,15 @@  OpenVPN can be extended by loading external plug-in modules at runtime.  These
 plug-ins must be prebuilt and adhere to the OpenVPN Plug-In API.
 
 --plugin args
-  Loads a given plug-in module.  The ``module-name`` needs to be the first
+  Loads an OpenVPN plug-in module.
+
+  Valid syntax:
+  ::
+
+     plugin module-name
+     plugin module-name "arguments"
+
+  The ``module-name`` needs to be the first
   argument, indicating the plug-in to load.  The second argument is an
   optional init string which will be passed directly to the plug-in.
   If the init consists of multiple arguments it must be enclosed in
@@ -26,8 +34,8 @@  plug-ins must be prebuilt and adhere to the OpenVPN Plug-In API.
      /usr/lib/my/plug.so  /usr/lib/my/plug.so
 
 
-  DEFAULT\_DIR is replaced by the default plug-in directory, which is
-  configured at the build time of OpenVPN. CWD is the current directory
+  ``DEFAULT_DIR`` is replaced by the default plug-in directory, which is
+  configured at the build time of OpenVPN. ``CWD`` is the current directory
   where OpenVPN was started or the directory OpenVPN have switched into
   via the ``--cd`` option before the ``--plugin`` option.