* fix comments in default config (#311)

README.md

@@ -30,9 +30,9 @@ Supported OS
 
 [![Build status](https://ci.appveyor.com/api/projects/status/458fhbki14gaplyj/branch/openssl?svg=true)](https://ci.appveyor.com/project/mlt/i2pd/branch/openssl)
 
--- Linux x86/x64  - Proved working.
+* Linux x86/x64  - Proved working.
--- Mac OS X       - Not well tested. (Only works with clang, not GCC)
+* Mac OS X       - Not well tested. (Only works with clang, not GCC)
--- Windows        - At least builds and runs.
+* Windows        - At least builds and runs.
 
 More documentation
 ------------------

debian/i2pd.conf

@@ -8,13 +8,13 @@ ircaddress=127.0.0.1
 ircport=6668
 ircdest=irc.postman.i2p
 
-; other services (disabled by default)
+# other services (disabled by default)
-;
+#
-; samaddress=127.0.0.1
+# samaddress=127.0.0.1
-; samport=7656
+# samport=7656
-;
+#
-; bobaddress=127.0.0.1
+# bobaddress=127.0.0.1
-; bobport=2827
+# bobport=2827
-;
+#
-; i2pcontroladdress=127.0.0.1
+# i2pcontroladdress=127.0.0.1
-; i2pcontrolport=7650
+# i2pcontrolport=7650

debian/tunnels.conf

@@ -1 +1 @@
-; see examples in /usr/share/doc/i2pd/configuration.md.gz
+# see examples in /usr/share/doc/i2pd/configuration.md.gz

docs/configuration.md

@@ -39,46 +39,47 @@ Config files
 ------------
 
 INI-like, syntax is the following : <key> = <value>.
+Comments are "#", not ";" as you may expect. See [boost ticket](https://svn.boost.org/trac/boost/ticket/808)
 All command-line parameters are allowed as keys, for example:
 
 i2p.conf:
 
-	log = 1
+    log = 1
-	v6 = 0
+    v6 = 0
-	ircdest = irc.postman.i2p
+    ircdest = irc.postman.i2p
 
 tunnels.cfg (filename of this config is subject of change):
 
-  ; outgoing tunnel sample, to remote service
+    # outgoing tunnel sample, to remote service
-  ; mandatory parameters:
+    # mandatory parameters:
-  ; * type -- always "client"
+    # * type -- always "client"
-  ; * port -- local port to listen to
+    # * port -- local port to listen to
-  ; * destination -- i2p hostname
+    # * destination -- i2p hostname
-  ; optional parameters (may be omitted)
+    # optional parameters (may be omitted)
-  ; * keys -- our identity, if unset, will be generated on every startup,
+    # * keys -- our identity, if unset, will be generated on every startup,
-  ;     if set and file missing, keys will be generated and placed to this file
+    #     if set and file missing, keys will be generated and placed to this file
-	[IRC]
+    [IRC]
-	type = client
+    type = client
-	port = 6668
+    port = 6668
-	destination = irc.echelon.i2p
+    destination = irc.echelon.i2p
-	keys = irc-keys.dat
+    keys = irc-keys.dat
-	;
+    #
-  ; incoming tunnel sample, for local service
+    # incoming tunnel sample, for local service
-  ; mandatory parameters:
+    # mandatory parameters:
-  ; * type -- always "server"
+    # * type -- always "server"
-  ; * host -- ip address of our service
+    # * host -- ip address of our service
-  ; * port -- port of our service
+    # * port -- port of our service
-  ; * keys -- file with LeaseSet of address in i2p
+    # * keys -- file with LeaseSet of address in i2p
-  ; optional parameters (may be omitted)
+    # optional parameters (may be omitted)
-  ; * inport -- optional, i2p service port, if unset - the same as 'port'
+    # * inport -- optional, i2p service port, if unset - the same as 'port'
-  ; * accesslist -- comma-separated list of i2p addresses, allowed to connect
+    # * accesslist -- comma-separated list of i2p addresses, allowed to connect
-  ;    every address is b32 without '.b32.i2p' part
+    #    every address is b32 without '.b32.i2p' part
-	[LOCALSITE]
+    [LOCALSITE]
-	type = server
+    type = server
-	host = 127.0.0.1
+    host = 127.0.0.1
-	port = 80
+    port = 80
-	keys = site-keys.dat
+    keys = site-keys.dat
-	inport = 81
+    inport = 81
-	accesslist = <b32>[,<b32>]
+    accesslist = <b32>[,<b32>]
 
 Also see [this page](https://github.com/PurpleI2P/i2pd/wiki/tunnels.cfg) for more tunnel examples.