X-Git-Url: https://ruderich.org/simon/gitweb/?p=tlsproxy%2Ftlsproxy.git;a=blobdiff_plain;f=lib%2Ftlsproxyhelper.c;fp=lib%2Ftlsproxyhelper.c;h=529dc55d922a39c5287fce0b94ebb7fd21aee2ea;hp=a37e0224dc9eac6332a1a0a11b3dd5a3f61531c1;hb=579d66b3f6fcaed5b235f8d9111bf22100f5bd14;hpb=3cb7193721894ec9c064bc22e09078e8c5cd3dd8

diff --git a/lib/tlsproxyhelper.c b/lib/tlsproxyhelper.c
index a37e022..529dc55 100644
--- a/lib/tlsproxyhelper.c
+++ b/lib/tlsproxyhelper.c
@@ -1,3 +1,16 @@
+/*
+ * Simple LD_PRELOAD wrapper for connect() which uses tlsproxy as proxy for
+ * programs which don't support setting a TLS proxy.
+ *
+ * The following environment variables can be used:
+ *
+ * - TLSPROXYHELPER_PORT: port where tlsproxy is running (default 9000)
+ *
+ * If an error occurs -1 is returned and errno is set (either EAFNOSUPPORT if
+ * another protocol besides IPv4/IPv6 was used, or EINVAL if another error
+ * occurred). The error is written to stderr with "tlsproxyhelper:" as prefix.
+ */
+
 /*
  * Copyright (C) 2011-2013  Simon Ruderich
  *