swrap: introduce a socket_wrapper_noop.so and socket_wrapper.h to provide noop stubs

[socket_wrapper.git] / doc / socket_wrapper.1.adoc

diff --git a/doc/socket_wrapper.1.adoc b/doc/socket_wrapper.1.adoc
index 9519fd4113e873c9bbe73926698a9a9a6527519d..fd0b74584224113e660b69151a78174565117919 100644 (file)
--- a/doc/socket_wrapper.1.adoc
+++ b/doc/socket_wrapper.1.adoc
@@ -133,6 +133,29 @@ EXAMPLE
   # Now you can type 'Hello!' which will be sent to the server and should appear
   # in the console output of the server.
 
+PUBLIC FUNCTIONS
+----------------
+
+Socket wrapper advanced helpers.
+
+Applications with the need to alter their behaviour when
+socket wrapper is active, can link use these functions.
+
+By default it's required for applications to use any of these
+functions as libsocket_wrapper.so is injected at runtime via
+LD_PRELOAD.
+
+Applications using these functions should link against
+libsocket_wrapper_noop.so by using -lsocket_wrapper_noop,
+or implement their own noop stubs.
+
+#include <socket_wrapper.h>
+
+bool socket_wrapper_enabled(void);
+
+- This returns true when socket wrapper is actively in use.
+
+
 RESOURCES
 ---------