diff --git a/debian/i2pd.1 b/debian/i2pd.1 index 77e62a6e..6cd63b36 100644 --- a/debian/i2pd.1 +++ b/debian/i2pd.1 @@ -1,4 +1,4 @@ -.TH I2PD "1" "June 15, 2018" +.TH I2PD "1" "June 16, 2018" .SH NAME i2pd \- Load-balanced unspoofable packet switching network @@ -36,14 +36,14 @@ Where to write pidfile (don\'t write by default) \fB\-\-log=\fR Logs destination: \fIstdout\fR, \fIfile\fR, \fIsyslog\fR (\fIstdout\fR if not set, \fIfile\fR - otherwise, for compatibility) .TP -\fB\-\-logfile\fR +\fB\-\-logfile=\fR Path to logfile (default - autodetect) .TP \fB\-\-loglevel=\fR Log messages above this level (\fIdebug\fR, \fBinfo\fR, \fIwarn\fR, \fIerror\fR, \fInone\fR) .TP \fB\-\-logclftime\fR -Log messages with full CLF-formatted date and time +Log messages with full CLF-formatted date and time (\fIfalse\fR by default) .TP \fB\-\-datadir=\fR Path to storage of i2pd data (RI, keys, peer profiles, ...) @@ -63,14 +63,26 @@ The network interface to bind to for IPv4 connections \fB\-\-ifname6=\fR The network interface to bind to for IPv6 connections .TP +\fB\-\-ipv4\fR +Enable communication through ipv6 (\fItrue\fR by default) +.TP \fB\-\-ipv6\fR -Enable communication through ipv6 (disabled by default) +Enable communication through ipv6 (\fIfalse\fR by default) +.TP +\fB\-\-ntcp\fR +Enable usage of NTCP transport (\fItrue\fR by default) +.TP +\fB\-\-ntcpproxy\fR +Set proxy URL for NTCP transport +.TP +\fB\-\-ssu\fR +Enable usage of SSU transport (\fItrue\fR by default) .TP \fB\-\-notransit\fR -Router will not accept transit tunnels at startup +Router will not accept transit tunnels at startup (\fIfalse\fR by default) .TP \fB\-\-floodfill\fR -Router will be floodfill +Router will be floodfill (\fIfalse\fR by default) .TP \fB\-\-bandwidth=\fR Bandwidth limit: integer in KBps or letter aliases: \fBL (32KBps)\fR, \fIO (256)\fR, \fIP (2048)\fR, \fIX (>9000)\fR @@ -79,10 +91,10 @@ Bandwidth limit: integer in KBps or letter aliases: \fBL (32KBps)\fR, \fIO (256) Limit of transit traffic from max bandwidth in percents. (default: 100) .TP \fB\-\-daemon\fR -Router will go to background after start +Router will go to background after start (\fIfalse\fR by default) .TP \fB\-\-service\fR -Router will use system folders like \fI/var/lib/i2pd\fR +Router will use system folders like \fI/var/lib/i2pd\fR (\fIfalse\fR by default) .TP \fB\-\-family=\fR Name of a family, router belongs to. @@ -105,6 +117,11 @@ i2pd profile directory (when running as a system service, see \fB\-\-service\fR $HOME/.i2pd/ .RS 4 i2pd profile directory (when running as a normal user) +.Sh SEE ALSO +Documentation at +.Pa https://i2pd.readthedocs.io/en/latest/ . +.Pp + .SH AUTHOR This manual page was written by kytv for the Debian system (but may be used by others). .PP diff --git a/libi2pd/Config.cpp b/libi2pd/Config.cpp index 5f108fbb..8492601b 100644 --- a/libi2pd/Config.cpp +++ b/libi2pd/Config.cpp @@ -38,7 +38,7 @@ namespace config { ("log", value()->default_value(""), "Logs destination: stdout, file, syslog (stdout if not set)") ("logfile", value()->default_value(""), "Path to logfile (stdout if not set, autodetect if daemon)") ("loglevel", value()->default_value("info"), "Set the minimal level of log messages (debug, info, warn, error, none)") - ("logclftime", value()->zero_tokens()->default_value(false), "Write full CLF-formatted date and time to log (default: write only time)") + ("logclftime", value()->default_value(false), "Write full CLF-formatted date and time to log (default: write only time)") ("family", value()->default_value(""), "Specify a family, router belongs to") ("datadir", value()->default_value(""), "Path to storage of i2pd data (RI, keys, peer profiles, ...)") ("host", value()->default_value("0.0.0.0"), "External IP") @@ -48,21 +48,21 @@ namespace config { ("nat", value()->default_value(true), "Should we assume we are behind NAT?") ("port", value()->default_value(0), "Port to listen for incoming connections (default: auto)") ("ipv4", value()->default_value(true), "Enable communication through ipv4") - ("ipv6", value()->zero_tokens()->default_value(false), "Enable communication through ipv6") + ("ipv6", value()->default_value(false), "Enable communication through ipv6") ("netid", value()->default_value(I2PD_NET_ID), "Specify NetID. Main I2P is 2") - ("daemon", value()->zero_tokens()->default_value(false), "Router will go to background after start") - ("service", value()->zero_tokens()->default_value(false), "Router will use system folders like '/var/lib/i2pd'") - ("notransit", value()->zero_tokens()->default_value(false), "Router will not accept transit tunnels at startup") - ("floodfill", value()->zero_tokens()->default_value(false), "Router will be floodfill") + ("daemon", value()->default_value(false), "Router will go to background after start") + ("service", value()->default_value(false), "Router will use system folders like '/var/lib/i2pd'") + ("notransit", value()->default_value(false), "Router will not accept transit tunnels at startup") + ("floodfill", value()->default_value(false), "Router will be floodfill") ("bandwidth", value()->default_value(""), "Bandwidth limit: integer in KBps or letters: L (32), O (256), P (2048), X (>9000)") ("share", value()->default_value(100), "Limit of transit traffic from max bandwidth in percents. (default: 100") ("ntcp", value()->default_value(true), "Enable NTCP transport") ("ssu", value()->default_value(true), "Enable SSU transport") ("ntcpproxy", value()->default_value(""), "Proxy URL for NTCP transport") - ("ntcp2", value()->zero_tokens()->default_value(false), "Enable NTCP2 (experimental)") + ("ntcp2", value()->default_value(false), "Enable NTCP2 (experimental)") #ifdef _WIN32 ("svcctl", value()->default_value(""), "Windows service management ('install' or 'remove')") - ("insomnia", value()->zero_tokens()->default_value(false), "Prevent system from sleeping") + ("insomnia", value()->default_value(false), "Prevent system from sleeping") ("close", value()->default_value("ask"), "Action on close: minimize, exit, ask") #endif ; @@ -79,14 +79,14 @@ namespace config { options_description httpserver("HTTP Server options"); httpserver.add_options() - ("http.enabled", value()->default_value(true), "Enable or disable webconsole") - ("http.address", value()->default_value("127.0.0.1"), "Webconsole listen address") - ("http.port", value()->default_value(7070), "Webconsole listen port") - ("http.auth", value()->default_value(false), "Enable Basic HTTP auth for webconsole") - ("http.user", value()->default_value("i2pd"), "Username for basic auth") - ("http.pass", value()->default_value(""), "Password for basic auth (default: random, see logs)") - ("http.strictheaders", value()->default_value(true), "Enable strict host checking on WebUI") - ("http.hostname", value()->default_value("localhost"),"Expected hostname for WebUI") + ("http.enabled", value()->default_value(true), "Enable or disable webconsole") + ("http.address", value()->default_value("127.0.0.1"), "Webconsole listen address") + ("http.port", value()->default_value(7070), "Webconsole listen port") + ("http.auth", value()->default_value(false), "Enable Basic HTTP auth for webconsole") + ("http.user", value()->default_value("i2pd"), "Username for basic auth") + ("http.pass", value()->default_value(""), "Password for basic auth (default: random, see logs)") + ("http.strictheaders", value()->default_value(true), "Enable strict host checking on WebUI") + ("http.hostname", value()->default_value("localhost"), "Expected hostname for WebUI") ; options_description httpproxy("HTTP Proxy options");