From dd392941d0734d421d6a27bcf12c9582b5dc6b8d Mon Sep 17 00:00:00 2001 From: R4SAS Date: Wed, 20 Jun 2018 05:07:24 +0300 Subject: [PATCH] update Config.cpp, links to examples, manpage --- contrib/tunnels.conf | 3 +- debian/changelog | 5 ++-- debian/control | 2 +- debian/i2pd.1 | 70 +++++++++++++++++++------------------------- libi2pd/Config.cpp | 24 +++++++-------- 5 files changed, 47 insertions(+), 57 deletions(-) diff --git a/contrib/tunnels.conf b/contrib/tunnels.conf index cd6cc910..3358ffc4 100644 --- a/contrib/tunnels.conf +++ b/contrib/tunnels.conf @@ -30,5 +30,4 @@ keys = irc-keys.dat #destinationport = 110 #keys = pop3-keys.dat -# see more examples in /usr/share/doc/i2pd/configuration.md.gz -# or at https://i2pd.readthedocs.io/en/latest/user-guide/tunnels/ +# see more examples at https://i2pd.readthedocs.io/en/latest/user-guide/tunnels/ diff --git a/debian/changelog b/debian/changelog index 79c368a6..1b87e73c 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,10 +1,11 @@ -i2pd (2.19.0-1) unstable; urgency=low +i2pd (2.19.0-pre1) unstable; urgency=low * updated to version 2.19.0/0.9.35 * update manpage (1) + * update docfiles * fixes in systemd unit (#1089, #1142, #1154, #1155) - -- R4SAS Tue, 19 Jun 2018 18:00:00 +0000 + -- R4SAS Wed, 20 Jun 2018 02:11:00 +0000 i2pd (2.18.0-1) unstable; urgency=low diff --git a/debian/control b/debian/control index 7bd18ebb..76d753d4 100644 --- a/debian/control +++ b/debian/control @@ -13,7 +13,7 @@ Architecture: any Pre-Depends: adduser Depends: ${shlibs:Depends}, ${misc:Depends} Suggests: tor, privoxy, apparmor -Description: A full-featured C++ implementation of I2P client. +Description: Full-featured C++ implementation of I2P client. I2P (Invisible Internet Protocol) is a universal anonymous network layer. All communications over I2P are anonymous and end-to-end encrypted, participants don't reveal their real IP addresses. diff --git a/debian/i2pd.1 b/debian/i2pd.1 index 3e0a90ff..72b2c261 100644 --- a/debian/i2pd.1 +++ b/debian/i2pd.1 @@ -1,22 +1,19 @@ -.TH I2PD "1" "June 16, 2018" +.TH "I2PD" "1" "June 20, 2018" -.SH NAME -i2pd \- Load-balanced unspoofable packet switching network - -.SH SYNOPSIS +.SH "NAME" +i2pd \- Full-featured C++ implementation of I2P client. +.SH "SYNOPSIS" .B i2pd [\fIOPTION1\fR] [\fIOPTION2\fR]... - -.SH DESCRIPTION +.SH "DESCRIPTION" i2pd is a C++ implementation of the router for the I2P anonymizing network, offering a simple layer that identity-sensitive applications can use to securely communicate. All data is wrapped with several layers of encryption, and the network is both distributed and dynamic, with no trusted parties. - .PP Any of the configuration options below can be used in the \fBDAEMON_ARGS\fR variable in \fI/etc/default/i2pd\fR. -.BR +.SH "OPTIONS" .TP \fB\-\-help\fR Show available options. @@ -43,7 +40,7 @@ Path to logfile (default - autodetect) 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 (\fIfalse\fR by default) +Log messages with full CLF-formatted date and time (\fIdisabled\fR by default) .TP \fB\-\-datadir=\fR Path to storage of i2pd data (RI, keys, peer profiles, ...) @@ -64,25 +61,25 @@ The network interface to bind to for IPv4 connections The network interface to bind to for IPv6 connections .TP \fB\-\-ipv4\fR -Enable communication through ipv6 (\fItrue\fR by default) +Enable communication through ipv6 (\fIenabled\fR by default) .TP \fB\-\-ipv6\fR -Enable communication through ipv6 (\fIfalse\fR by default) +Enable communication through ipv6 (\fIdisabled\fR by default) .TP \fB\-\-ntcp\fR -Enable usage of NTCP transport (\fItrue\fR by default) +Enable usage of NTCP transport (\fIenabled\fR by default) .TP -\fB\-\-ntcpproxy\fR +\fB\-\-ntcpproxy=\fR Set proxy URL for NTCP transport .TP \fB\-\-ssu\fR -Enable usage of SSU transport (\fItrue\fR by default) +Enable usage of SSU transport (\fIenabled\fR by default) .TP \fB\-\-notransit\fR -Router will not accept transit tunnels at startup (\fIfalse\fR by default) +Router will not accept transit tunnels at startup (\fIdisabled\fR by default) .TP \fB\-\-floodfill\fR -Router will be floodfill (\fIfalse\fR by default) +Router will be floodfill (\fIdisabled\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 @@ -91,22 +88,21 @@ 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 (\fIfalse\fR by default) +Router will go to background after start (\fIdisabled\fR by default) .TP \fB\-\-service\fR -Router will use system folders like \fI/var/lib/i2pd\fR (\fIfalse\fR by default) +Router will use system folders like \fI/var/lib/i2pd\fR (\fIdisabled\fR by default) .TP \fB\-\-family=\fR Name of a family, router belongs to. .PP -See service-specific parameters in example config file \fIcontrib/i2pd.conf\fR - -.SH FILES -.PP +Switchs, which enabled by default (like \fB\-\-ssu\fR, \fB\-\-ntcp\fR, etc.), can be disabled in config file. +.RE +See service-specific parameters in example config file \fI/usr/share/doc/i2pd/i2pd.conf.gz\fR +.SH "FILES" /etc/i2pd/i2pd.conf, /etc/i2pd/tunnels.conf, /etc/default/i2pd .RS 4 i2pd configuration files (when running as a system service) - .RE .PP /var/lib/i2pd/ @@ -117,21 +113,15 @@ 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 -.PP -Documentation at -.UR https://i2pd.readthedocs.io/en/latest/ -Read the Docs -.UE . -.PP - -.SH AUTHOR -This manual page was written by kytv for the Debian system (but may be used by others). -.PP -Updated by hagen in 2016. -.PP -Updated by R4SAS in 2018. +.SH "SEE ALSO" +Documentation at Read the Docs: \m[blue]\fBhttps://i2pd\&.readthedocs\&.io/en/latest/\fR\m[] +.SH "AUTHOR" +This manual page was written by kytv <\m[blue]\fBkillyourtv@i2pmail\&.org\fR\m[]> for the Debian system (but may be used by others). +.RE +Updated by hagen <\m[blue]\fBhagen@i2pmail\&.org\fR\m[]> in 2016. +.RE +Updated by R4SAS <\m[blue]\fBr4sas@i2pmail\&.org\fR\m[]> in 2018. .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 +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. +.RE On Debian systems, the complete text of the GNU General Public License can be found in \fI/usr/share/common-licenses/GPL\fR diff --git a/libi2pd/Config.cpp b/libi2pd/Config.cpp index 2e6d40bb..251e91df 100644 --- a/libi2pd/Config.cpp +++ b/libi2pd/Config.cpp @@ -38,31 +38,31 @@ 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()->default_value(false), "Write full CLF-formatted date and time to log (default: write only time)") + ("logclftime", bool_switch()->default_value(false), "Write full CLF-formatted date and time to log (default: disabled, 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") ("ifname", value()->default_value(""), "Network interface to bind to") ("ifname4", value()->default_value(""), "Network interface to bind to for ipv4") ("ifname6", value()->default_value(""), "Network interface to bind to for ipv6") - ("nat", value()->default_value(true), "Should we assume we are behind NAT?") + ("nat", bool_switch()->default_value(true), "Should we assume we are behind NAT? (default: enabled)") ("port", value()->default_value(0), "Port to listen for incoming connections (default: auto)") - ("ipv4", value()->default_value(true), "Enable communication through ipv4") - ("ipv6", value()->default_value(false), "Enable communication through ipv6") + ("ipv4", bool_switch()->default_value(true), "Enable communication through ipv4 (default: enabled)") + ("ipv6", bool_switch()->default_value(false), "Enable communication through ipv6 (default: disabled)") ("netid", value()->default_value(I2PD_NET_ID), "Specify NetID. Main I2P is 2") - ("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") + ("daemon", bool_switch()->default_value(false), "Router will go to background after start (default: disabled)") + ("service", bool_switch()->default_value(false), "Router will use system folders like '/var/lib/i2pd' (default: disabled)") + ("notransit", bool_switch()->default_value(false), "Router will not accept transit tunnels at startup (default: disabled)") + ("floodfill", bool_switch()->default_value(false), "Router will be floodfill (default: disabled)") ("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") + ("ntcp", bool_switch()->default_value(true), "Enable NTCP transport (default: enabled)") + ("ssu", bool_switch()->default_value(true), "Enable SSU transport (default: enabled)") ("ntcpproxy", value()->default_value(""), "Proxy URL for NTCP transport") - ("ntcp2", value()->default_value(false), "Enable NTCP2 (experimental)") + ("ntcp2", bool_switch()->default_value(false), "Enable NTCP2 (experimental, default: disabled)") #ifdef _WIN32 ("svcctl", value()->default_value(""), "Windows service management ('install' or 'remove')") - ("insomnia", value()->default_value(false), "Prevent system from sleeping") + ("insomnia", bool_switch()->default_value(false), "Prevent system from sleeping (default: disabled)") ("close", value()->default_value("ask"), "Action on close: minimize, exit, ask") #endif ;