Browse Source

remove zero_tokens(), update manpage

pull/1197/head
R4SAS 7 years ago
parent
commit
bdc7acffbe
  1. 33
      debian/i2pd.1
  2. 18
      libi2pd/Config.cpp

33
debian/i2pd.1 vendored

@ -1,4 +1,4 @@
.TH I2PD "1" "June 15, 2018" .TH I2PD "1" "June 16, 2018"
.SH NAME .SH NAME
i2pd \- Load-balanced unspoofable packet switching network i2pd \- Load-balanced unspoofable packet switching network
@ -36,14 +36,14 @@ Where to write pidfile (don\'t write by default)
\fB\-\-log=\fR \fB\-\-log=\fR
Logs destination: \fIstdout\fR, \fIfile\fR, \fIsyslog\fR (\fIstdout\fR if not set, \fIfile\fR - otherwise, for compatibility) Logs destination: \fIstdout\fR, \fIfile\fR, \fIsyslog\fR (\fIstdout\fR if not set, \fIfile\fR - otherwise, for compatibility)
.TP .TP
\fB\-\-logfile\fR \fB\-\-logfile=\fR
Path to logfile (default - autodetect) Path to logfile (default - autodetect)
.TP .TP
\fB\-\-loglevel=\fR \fB\-\-loglevel=\fR
Log messages above this level (\fIdebug\fR, \fBinfo\fR, \fIwarn\fR, \fIerror\fR, \fInone\fR) Log messages above this level (\fIdebug\fR, \fBinfo\fR, \fIwarn\fR, \fIerror\fR, \fInone\fR)
.TP .TP
\fB\-\-logclftime\fR \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 .TP
\fB\-\-datadir=\fR \fB\-\-datadir=\fR
Path to storage of i2pd data (RI, keys, peer profiles, ...) 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 \fB\-\-ifname6=\fR
The network interface to bind to for IPv6 connections The network interface to bind to for IPv6 connections
.TP .TP
\fB\-\-ipv4\fR
Enable communication through ipv6 (\fItrue\fR by default)
.TP
\fB\-\-ipv6\fR \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 .TP
\fB\-\-notransit\fR \fB\-\-notransit\fR
Router will not accept transit tunnels at startup Router will not accept transit tunnels at startup (\fIfalse\fR by default)
.TP .TP
\fB\-\-floodfill\fR \fB\-\-floodfill\fR
Router will be floodfill Router will be floodfill (\fIfalse\fR by default)
.TP .TP
\fB\-\-bandwidth=\fR \fB\-\-bandwidth=\fR
Bandwidth limit: integer in KBps or letter aliases: \fBL (32KBps)\fR, \fIO (256)\fR, \fIP (2048)\fR, \fIX (>9000)\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) Limit of transit traffic from max bandwidth in percents. (default: 100)
.TP .TP
\fB\-\-daemon\fR \fB\-\-daemon\fR
Router will go to background after start Router will go to background after start (\fIfalse\fR by default)
.TP .TP
\fB\-\-service\fR \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 .TP
\fB\-\-family=\fR \fB\-\-family=\fR
Name of a family, router belongs to. 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/ $HOME/.i2pd/
.RS 4 .RS 4
i2pd profile directory (when running as a normal user) i2pd profile directory (when running as a normal user)
.Sh SEE ALSO
Documentation at
.Pa https://i2pd.readthedocs.io/en/latest/ .
.Pp
.SH AUTHOR .SH AUTHOR
This manual page was written by kytv <killyourtv@i2pmail.org> for the Debian system (but may be used by others). This manual page was written by kytv <killyourtv@i2pmail.org> for the Debian system (but may be used by others).
.PP .PP

18
libi2pd/Config.cpp

@ -38,7 +38,7 @@ namespace config {
("log", value<std::string>()->default_value(""), "Logs destination: stdout, file, syslog (stdout if not set)") ("log", value<std::string>()->default_value(""), "Logs destination: stdout, file, syslog (stdout if not set)")
("logfile", value<std::string>()->default_value(""), "Path to logfile (stdout if not set, autodetect if daemon)") ("logfile", value<std::string>()->default_value(""), "Path to logfile (stdout if not set, autodetect if daemon)")
("loglevel", value<std::string>()->default_value("info"), "Set the minimal level of log messages (debug, info, warn, error, none)") ("loglevel", value<std::string>()->default_value("info"), "Set the minimal level of log messages (debug, info, warn, error, none)")
("logclftime", value<bool>()->zero_tokens()->default_value(false), "Write full CLF-formatted date and time to log (default: write only time)") ("logclftime", value<bool>()->default_value(false), "Write full CLF-formatted date and time to log (default: write only time)")
("family", value<std::string>()->default_value(""), "Specify a family, router belongs to") ("family", value<std::string>()->default_value(""), "Specify a family, router belongs to")
("datadir", value<std::string>()->default_value(""), "Path to storage of i2pd data (RI, keys, peer profiles, ...)") ("datadir", value<std::string>()->default_value(""), "Path to storage of i2pd data (RI, keys, peer profiles, ...)")
("host", value<std::string>()->default_value("0.0.0.0"), "External IP") ("host", value<std::string>()->default_value("0.0.0.0"), "External IP")
@ -48,21 +48,21 @@ namespace config {
("nat", value<bool>()->default_value(true), "Should we assume we are behind NAT?") ("nat", value<bool>()->default_value(true), "Should we assume we are behind NAT?")
("port", value<uint16_t>()->default_value(0), "Port to listen for incoming connections (default: auto)") ("port", value<uint16_t>()->default_value(0), "Port to listen for incoming connections (default: auto)")
("ipv4", value<bool>()->default_value(true), "Enable communication through ipv4") ("ipv4", value<bool>()->default_value(true), "Enable communication through ipv4")
("ipv6", value<bool>()->zero_tokens()->default_value(false), "Enable communication through ipv6") ("ipv6", value<bool>()->default_value(false), "Enable communication through ipv6")
("netid", value<int>()->default_value(I2PD_NET_ID), "Specify NetID. Main I2P is 2") ("netid", value<int>()->default_value(I2PD_NET_ID), "Specify NetID. Main I2P is 2")
("daemon", value<bool>()->zero_tokens()->default_value(false), "Router will go to background after start") ("daemon", value<bool>()->default_value(false), "Router will go to background after start")
("service", value<bool>()->zero_tokens()->default_value(false), "Router will use system folders like '/var/lib/i2pd'") ("service", value<bool>()->default_value(false), "Router will use system folders like '/var/lib/i2pd'")
("notransit", value<bool>()->zero_tokens()->default_value(false), "Router will not accept transit tunnels at startup") ("notransit", value<bool>()->default_value(false), "Router will not accept transit tunnels at startup")
("floodfill", value<bool>()->zero_tokens()->default_value(false), "Router will be floodfill") ("floodfill", value<bool>()->default_value(false), "Router will be floodfill")
("bandwidth", value<std::string>()->default_value(""), "Bandwidth limit: integer in KBps or letters: L (32), O (256), P (2048), X (>9000)") ("bandwidth", value<std::string>()->default_value(""), "Bandwidth limit: integer in KBps or letters: L (32), O (256), P (2048), X (>9000)")
("share", value<int>()->default_value(100), "Limit of transit traffic from max bandwidth in percents. (default: 100") ("share", value<int>()->default_value(100), "Limit of transit traffic from max bandwidth in percents. (default: 100")
("ntcp", value<bool>()->default_value(true), "Enable NTCP transport") ("ntcp", value<bool>()->default_value(true), "Enable NTCP transport")
("ssu", value<bool>()->default_value(true), "Enable SSU transport") ("ssu", value<bool>()->default_value(true), "Enable SSU transport")
("ntcpproxy", value<std::string>()->default_value(""), "Proxy URL for NTCP transport") ("ntcpproxy", value<std::string>()->default_value(""), "Proxy URL for NTCP transport")
("ntcp2", value<bool>()->zero_tokens()->default_value(false), "Enable NTCP2 (experimental)") ("ntcp2", value<bool>()->default_value(false), "Enable NTCP2 (experimental)")
#ifdef _WIN32 #ifdef _WIN32
("svcctl", value<std::string>()->default_value(""), "Windows service management ('install' or 'remove')") ("svcctl", value<std::string>()->default_value(""), "Windows service management ('install' or 'remove')")
("insomnia", value<bool>()->zero_tokens()->default_value(false), "Prevent system from sleeping") ("insomnia", value<bool>()->default_value(false), "Prevent system from sleeping")
("close", value<std::string>()->default_value("ask"), "Action on close: minimize, exit, ask") ("close", value<std::string>()->default_value("ask"), "Action on close: minimize, exit, ask")
#endif #endif
; ;
@ -86,7 +86,7 @@ namespace config {
("http.user", value<std::string>()->default_value("i2pd"), "Username for basic auth") ("http.user", value<std::string>()->default_value("i2pd"), "Username for basic auth")
("http.pass", value<std::string>()->default_value(""), "Password for basic auth (default: random, see logs)") ("http.pass", value<std::string>()->default_value(""), "Password for basic auth (default: random, see logs)")
("http.strictheaders", value<bool>()->default_value(true), "Enable strict host checking on WebUI") ("http.strictheaders", value<bool>()->default_value(true), "Enable strict host checking on WebUI")
("http.hostname", value<std::string>()->default_value("localhost"),"Expected hostname for WebUI") ("http.hostname", value<std::string>()->default_value("localhost"), "Expected hostname for WebUI")
; ;
options_description httpproxy("HTTP Proxy options"); options_description httpproxy("HTTP Proxy options");

Loading…
Cancel
Save