[tor-commits] [torsocks/master] Fix: Improve README file

[dgoulet@xxxxxxxxxxxxxx]

commit 17b3d9b0b92cefbf33dadccf5171678984dee8e4
Author: David Goulet <dgoulet@xxxxxxxxx>
Date:   Sat Aug 31 11:37:54 2013 -0400

    Fix: Improve README file
    
    Signed-off-by: David Goulet <dgoulet@xxxxxxxxx>
---
 README |   55 +++++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 47 insertions(+), 8 deletions(-)

diff --git a/README b/README
index 475ff2c..a694a8a 100644
--- a/README
+++ b/README
@@ -1,20 +1,59 @@
 What is torsocks?
 -----------------
 
-Torsocks allows you to use most socks-friendly applications in a safe way with
-Tor. It ensures that DNS requests are handled safely and explicitly rejects any
-traffic other then TCP from the application you're using. 
+Torsocks allows you to use most applications in a safe way with Tor. It ensures
+that DNS requests are handled safely and explicitly rejects any traffic other
+then TCP from the application you're using.
+
+Torsocks is an ELF shared library that is loaded before all others. The library
+overrides every needed Internet communication libc function calls such as
+connect(2) or gethostbyname(3).
+
+This process is transparent to the user and if torsocks detects any
+communication that can't go through the Tor network such as UDP traffic for
+instance, the connection is denied. If, in some wayt, there is no way for
+torsocks to provide the Tor anonymity guarantee with your application, torsocks
+will force the application to quit and stop everything.
+
+Installation
+-----------------
+
+  $ ./configure
+  $ make
+  $ sudo make install
+
+If you are compiling it from the git repository, run ./autogen.sh before the
+configure script.
 
 Using torsocks
 --------------
-Torsocks allows you to use most socks-friendly applications in a safe way with Tor.
+
 Once you have installed torsocks, just launch it like so:
 
-  torsocks [application]
+  $ torsocks [application]
 
 So, for example you can use ssh to a some.ssh.com by doing:
 
-  torsocks ssh username@xxxxxxxxxxxx 
+  $ torsocks ssh username@xxxxxxxxxxxx
+
+You can use the torsocks library without the script provided:
+
+  $ LD_PREALOD=/full/path/to/libtorsocks.so your_app
+
+For more details, please see the torsocks.1, torsocks.8 and torsocks.conf.5 man
+pages. Also, you can use -h, --help for all the possible options of the
+torsocks script.
+
+A configuration file named *torsocks.conf* is also provided for the user to
+control some parameters.
+
+More informations
+--------------
+
+torsocks is distributed under the GNU General Public License version 2.
+
+Mailing list for help is <tor-talk@xxxxxxxxxxxxxxxxxxxx> and for development
+use <tor-dev@xxxxxxxxxxxxxxxxxxxx>. You can find the project also on IRC server
+irc.oftc.net (OFTC) in #tor and #tor-dev.
 
-The Tor project:
-https://www.torproject.org
+See more information about the Tor project at https://www.torproject.org.



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits