From: Simon Ruderich <simon@ruderich.org>
Date: Sat, 10 Aug 2013 14:58:46 +0000 (+0200)
Subject: tlsproxyhelper.c: Add description.
X-Git-Url: https://ruderich.org/simon/gitweb/?a=commitdiff_plain;h=579d66b3f6fcaed5b235f8d9111bf22100f5bd14;p=tlsproxy%2Ftlsproxy.git

tlsproxyhelper.c: Add description.
---

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
  *