* update manpage

debian/i2pd.1

@@ -5,7 +5,7 @@ i2pd \- Load-balanced unspoofable packet switching network
 
 .SH SYNOPSIS
 .B i2pd
-[\fIOPTION1\fR) [\fIOPTION2\fR]...
+[\fIOPTION1\fR] [\fIOPTION2\fR]...
 
 .SH DESCRIPTION
 i2pd
@@ -18,59 +18,58 @@ network is both distributed and dynamic, with no trusted parties.
 Any of the configuration options below can be used in the \fBDAEMON_ARGS\fR variable in \fI/etc/default/i2pd\fR.
 .BR
 .TP
-\fB\-\-host=\fR
+\fB\-\-help\fR
-The external IP (deprecated)
+Show available options.
-.TP
-\fB\-\-port=\fR
-The external port to listen on
-.TP
-\fB\-\-httpport=\fR
-The HTTP port to listen on
-.TP
-\fB\-\-log=\fR[\fI1\fR|\fI0\fR]
-.br
-Enable of disable logging to a file. \fI1\fR for yes, \fI0\fR for no. (default: \fI0\fR, off)
-.TP
-\fB\-\-daemon=\fR[\fI1\fR|\fI0\fR]
-Enable or disable daemon mode. Daemon mode is enabled with \fI1\fR  and disabled with \fI0\fR. (default: \fI0\fR, off)
-.TP
-\fB\-\-service=\fR[\fI1\fR|\fI0\fR]
-If enabled, system folders (\fB/var/run/i2pd.pid\fR, \fB/var/log/i2pd.log\fR, \fB/var/lib/i2pd\fR) will be used. If off, \fB$HOME/.i2pd\fR will be used instead. (default: \fI0\fR, off).
-.TP
-\fB\-\-unreachable=\fR[\fI1\fR|\fI0\fR]
-\fI1\fR if router is declared as unreachable and works through introducers. (default: \fI0\fR, off)
-.TP
-\fB\-\-v6=\fR[\fI1\fR|\fI0\fR]
-\fI1\fR if \fBi2pd\fR should communicate via IPv6. (default: \fI0\fR, off)
-.TP
-\fB\-\-floodfill=\fR[\fI1\fR|\fI0\fR]
-\fI1\fR if \fBi2pd\fR should become a floodfill. (default: \fI0\fR, off)
-.TP
-\fB\-\-bandwidth=\fR[\fI1\fR|\fI0\fR]
-\fIL\fR if \fBi2pd\fR should be limited to 32KiB/s. Enabling floodfill will automatically set this to \fI0\fR (default: \fI0\fR, no limit)
-.TP
-\fB\-\-httpproxyport=\fR
-The local port for the HTTP Proxy to listen on (default: \fI4446\fR)
-.TP
-\fB\-\-socksproxyport=\fR
-The local port for the SOCKS proxy to listen on (default: \fI4447\fR)
-.TP
-\fB\-\-proxykeys=\fR
-An optional keys file for tunnel local destination (both HTTP and SOCKS)
-.TP
-\fB\-\-samport=\fR
-Port of SAM bridge. Usually \fI7656\fR. SAM will not be enabled if this is not set. (default: unset)
-.TP
-\fB\-\-bobport=\fR
-Port of BOB command channel. Usually \fI2827\fR. BOB will not be enabled if this is not set. (default: unset)
-.TP
-\fB\-\-i2pcontrolport=\fR
-Port of I2P control service. Usually \fI7650\fR. I2PControl will not be enabled if this is not set. (default: unset)
 .TP
 \fB\-\-conf=\fR
 Config file (default: \fI~/.i2pd/i2pd.conf\fR or \fI/var/lib/i2pd/i2pd.conf\fR)
+.BR
 This parameter will be silently ignored if the specified config file does not exist.
 Options specified on the command line take precedence over those in the config file.
+.TP
+\fB\-\-tunconf=\fR
+Tunnels config file (default: \fI~/.i2pd/tunnels.conf\fR or \fI/var/lib/i2pd/tunnels.conf\fR)
+.TP
+\fB\-\-pidfile=\fR
+Where to write pidfile (don\'t write by default)
+.TP
+\fB\-\-log=\fR
+Logs destination: \fIstdout\fR, \fIfile\fR, \fIsyslog\fR (\fIstdout\fR if not set, \fIfile\fR - otherwise, for compatibility)
+.TP
+\fB\-\-loglevel=\fR
+Log messages above this level (\fIdebug\fR, \fBinfo\fR, \fIwarn\fR, \fIerror\fR)
+.TP
+\fB\-\-datadir=\fR
+Path to storage of i2pd data (RI, keys, peer profiles, ...)
+.TP
+\fB\-\-host=\fR
+The external IP address
+.TP
+\fB\-\-port=\fR
+The port to listen on for incoming connections
+.TP
+\fB\-\-daemon\fR
+Router will go to background after start
+.TP
+\fB\-\-service\fR
+Router will use system folders like \fI/var/lib/i2pd\fR
+.TP
+\fB\-\-ipv6\fR
+Enable communication through ipv6. false by default
+.TP
+\fB\-\-notransit\fR
+Router will not accept transit tunnels at startup
+.TP
+\fB\-\-floodfill\fR
+Router will be floodfill
+.TP
+\fB\-\-bandwidth=\fR
+Bandwidth limit: integer in KBps or letter aliases: \fIL (32KBps)\fR, O (256), P (2048), X (>9000)
+.TP
+\fB\-\-family=\fR
+Name of a family, router belongs to.
+.PP
+See service-specific parameters in page \fIdocs/configuration.md\fR or in example config file \fIdocs/i2pd.conf\fR
 
 .SH FILES
 .PP
@@ -82,10 +81,10 @@ i2pd configuration files (when running as a system service)
 .PP
 /var/lib/i2pd/
 .RS 4
-i2pd profile directory (when running as a system service, see \fB\-\-service=\fR above)
+i2pd profile directory (when running as a system service, see \fB\-\-service\fR above)
 .RE
 .PP
-$HOME/.i2pd
+$HOME/.i2pd/
 .RS 4
 i2pd profile directory (when running as a normal user)
 .RE
@@ -95,7 +94,9 @@ i2pd profile directory (when running as a normal user)
 default I2P hosts file
 .SH AUTHOR
 This manual page was written by kytv <killyourtv@i2pmail.org> for the Debian system (but may be used by others).
-.BR
+.PP
+Updated by hagen <hagen@i2pmail.org> in 2016.
+.PP
 Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation
 .BR
-On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL
+On Debian systems, the complete text of the GNU General Public License can be found in \fI/usr/share/common-licenses/GPL\fR