Imported Upstream version 0.3.2

[anytun.git] / README

diff --git a/README b/README
index b7168e2..ffceb10 100644 (file)
--- a/README
+++ b/README
@@ -20,7 +20,32 @@ common:
   libboost-thread1.35-dev
   libboost-system1.35-dev
   libboost-regex1.35-dev
-  asciidoc (only for manpage)
+
+only for manpage:
+  asciidoc
+
+
+Freebsd
+-------
+
+using libgcrypt:
+   security/libgcrypt
+
+using ssl crypto lib:
+   <nothing here>
+
+common:
+   devel/boost
+   devel/gmake
+
+only for manpage:
+
+ textproc/asciidoc
+ textproc/libxslt
+ textproc/docbook-xsl
+ sysutils/readlink
+ misc/getopt 
+
 
 
 Windows
@@ -54,7 +79,8 @@ Installation
 
 Getting the source via subversion:
 ----------------------------------
-svn co http://anytun.org/svn/anytun/
+svn co http://svn.anytun.org/anytun/trunk anytun
+cd anytun
 
 Building from source
 --------------------
@@ -77,6 +103,56 @@ Notes:
   - if using openssl pre 0.9.8 you have to disable passphrase
     because openssl had no SHA256 implementation prior to this
     version
+  - on FreeBSD you have to use gmake instead of make
+
+Installing
+----------
+
+# sudo make install
+
+This will install anytun under the --prefix defined with configure.
+
+Uninstalling
+------------
+
+# sudo make remove
+
+This removes everytthing except for the config files
+
+# sudo make purge
+
+This also removes the config files
+
+
+
+Usage:
+======
+
+init.d script
+-------------
+
+The init.d script can be used to start anytun at boot time. It searches for 
+configuration files which reside at $CONFIG_DIR. For each instance of anytun
+which should be started there must be a directory containing at least a file
+named config. This file must contain all command line parameter which should
+be used when starting the daemon. One line for each parameter. Empty lines and
+lines starting with # are ignored. Besides the config file there may be a script
+named post-up.sh which will be called when the tun/tap device comes up. 
+Furthermore there may be a directory called conf.d containing config files for 
+anytun-config. The syntax of this files is quite the same as those for anytun. 
+These files are used to configure a multi connection setup using anytun-config 
+and anytun-controld
+This is an example of how the script can be used to start anytun:
+
+# /etc/init.d/anytun start client1 p2p-a
+
+In this case the script will start 2 instances of anytun using the config files
+$CONFIG_DIR/client1/config and $CONFIG_DIR/p2p-a/config. 
+If no instance name is specified the script will use the file $CONFIG_DIR/autostart
+to determine which instances to start or stop. This file must contain a list 
+of instance names which should be used when no names are specified at the command 
+line. One line for each name. Empty lines and lines starting with # are ignored.
+
 
 
 Errors: