Browse code

Clarify --tmp-dir option

Signed-off-by: chantra <chantra@debuntu.org>
Acked-By: David Sommerseth <davids@redhat.com>
Signed-off-by: David Sommerseth <davids@redhat.com>

chantra authored on 2011/03/25 18:24:30
Showing 2 changed files
... ...
@@ -2928,9 +2928,26 @@ file.
2928 2928
 Specify a directory
2929 2929
 .B dir
2930 2930
 for temporary files.  This directory will be used by
2931
+openvpn processes and script to communicate temporary
2932
+data with openvpn main process. Note that
2933
+the directory must be writable by the OpenVPN process
2934
+after it has dropped it's root privileges.
2935
+
2936
+This directory will be used by in the following cases:
2937
+
2938
+*
2931 2939
 .B \-\-client-connect
2932 2940
 scripts to dynamically generate client-specific
2933 2941
 configuration files.
2942
+
2943
+*
2944
+.B OPENVPN_PLUGIN_AUTH_USER_PASS_VERIFY
2945
+plugin hook to return success/failure via auth_control_file
2946
+when using deferred auth method
2947
+
2948
+*
2949
+.B OPENVPN_PLUGIN_ENABLE_PF
2950
+plugin hook to pass filtering rules via pf_file
2934 2951
 .\"*********************************************************
2935 2952
 .TP
2936 2953
 .B \-\-hash-size r v
... ...
@@ -413,7 +413,7 @@ static const char usage_message[] =
413 413
   "--client-disconnect cmd : Run script cmd on client disconnection.\n"
414 414
   "--client-config-dir dir : Directory for custom client config files.\n"
415 415
   "--ccd-exclusive : Refuse connection unless custom client config is found.\n"
416
-  "--tmp-dir dir   : Temporary directory, used for --client-connect return file.\n"
416
+  "--tmp-dir dir   : Temporary directory, used for --client-connect return file and plugin communication.\n"
417 417
   "--hash-size r v : Set the size of the real address hash table to r and the\n"
418 418
   "                  virtual address table to v.\n"
419 419
   "--bcast-buffers n : Allocate n broadcast buffers.\n"