1  .TH "I2PD" "1" "June 20, 2018"
  2  
  3  .SH "NAME"
  4  i2pd \- Full-featured C++ implementation of I2P client.
  5  .SH "SYNOPSIS"
  6  .B i2pd
  7  [\fIOPTION1\fR] [\fIOPTION2\fR]...
  8  .SH "DESCRIPTION"
  9  i2pd
 10  is a C++ implementation of the router for the I2P anonymizing network, offering
 11  a simple layer that identity-sensitive applications can use to securely
 12  communicate. All data is wrapped with several layers of encryption, and the
 13  network is both distributed and dynamic, with no trusted parties.
 14  .PP
 15  Any of the configuration options below can be used in the \fBDAEMON_ARGS\fR variable in \fI/etc/default/i2pd\fR.
 16  .SH "OPTIONS"
 17  .TP
 18  \fB\-\-help\fR
 19  Show available options.
 20  .TP
 21  \fB\-\-conf=\fR
 22  Config file (default: \fI~/.i2pd/i2pd.conf\fR or \fI/var/lib/i2pd/i2pd.conf\fR)
 23  .BR
 24  This parameter will be silently ignored if the specified config file does not exist.
 25  Options specified on the command line take precedence over those in the config file.
 26  .TP
 27  \fB\-\-tunconf=\fR
 28  Tunnels config file (default: \fI~/.i2pd/tunnels.conf\fR or \fI/var/lib/i2pd/tunnels.conf\fR)
 29  .TP
 30  \fB\-\-pidfile=\fR
 31  Where to write pidfile (don\'t write by default)
 32  .TP
 33  \fB\-\-log=\fR
 34  Logs destination: \fIstdout\fR, \fIfile\fR, \fIsyslog\fR (\fIstdout\fR if not set, \fIfile\fR - otherwise, for compatibility)
 35  .TP
 36  \fB\-\-logfile=\fR
 37  Path to logfile (default - autodetect)
 38  .TP
 39  \fB\-\-loglevel=\fR
 40  Log messages above this level (\fIdebug\fR, \fBinfo\fR, \fIwarn\fR, \fIerror\fR, \fInone\fR)
 41  .TP
 42  \fB\-\-logclftime\fR
 43  Log messages with full CLF-formatted date and time (\fIdisabled\fR by default)
 44  .TP
 45  \fB\-\-datadir=\fR
 46  Path to storage of i2pd data (RI, keys, peer profiles, ...)
 47  .TP
 48  \fB\-\-tunnelsdir=\fR
 49  Path to tunnels configuration files (default: \fI~/.i2pd/tunnels.d\fR or \fI/var/lib/i2pd/tunnels.d\fR)
 50  .TP
 51  \fB\-\-host=\fR
 52  The external IP address
 53  .TP
 54  \fB\-\-port=\fR
 55  The port to listen on for incoming connections
 56  .TP
 57  \fB\-\-ifname=\fR
 58  The network interface to bind to
 59  .TP
 60  \fB\-\-ifname4=\fR
 61  The network interface to bind to for IPv4 connections
 62  .TP
 63  \fB\-\-ifname6=\fR
 64  The network interface to bind to for IPv6 connections
 65  .TP
 66  \fB\-\-ipv4=\fR
 67  Enable communication through ipv4 (\fIenabled\fR by default)
 68  .TP
 69  \fB\-\-ipv6\fR
 70  Enable communication through ipv6 (\fIdisabled\fR by default)
 71  .TP
 72  \fB\-\-ntcp=\fR
 73  Enable usage of NTCP transport (\fIenabled\fR by default)
 74  .TP
 75  \fB\-\-ntcpproxy=\fR
 76  Set proxy URL for NTCP transport
 77  .TP
 78  \fB\-\-ssu=\fR
 79  Enable usage of SSU transport (\fIenabled\fR by default)
 80  .TP
 81  \fB\-\-notransit\fR
 82  Router will not accept transit tunnels at startup (\fIdisabled\fR by default)
 83  .TP
 84  \fB\-\-floodfill\fR
 85  Router will be floodfill (\fIdisabled\fR by default)
 86  .TP
 87  \fB\-\-bandwidth=\fR
 88  Bandwidth limit: integer in KBps or letter aliases: \fBL (32KBps)\fR, \fIO (256)\fR, \fIP (2048)\fR, \fIX (>9000)\fR
 89  .TP
 90  \fB\-\-share=\fR
 91  Limit of transit traffic from max bandwidth in percents. (default: 100)
 92  .TP
 93  \fB\-\-daemon\fR
 94  Router will go to background after start (\fIdisabled\fR by default)
 95  .TP
 96  \fB\-\-service\fR
 97  Router will use system folders like \fI/var/lib/i2pd\fR (\fIdisabled\fR by default)
 98  .TP
 99  \fB\-\-family=\fR
100  Name of a family, router belongs to.
101  .PP
102  Switches, which enabled by default (like \fB\-\-ssu\fR, \fB\-\-ntcp\fR, etc.), can be disabled in config file.
103  .RE
104  See service-specific parameters in example config file \fI/usr/share/doc/i2pd/i2pd.conf.gz\fR
105  .SH "FILES"
106  /etc/i2pd/i2pd.conf, /etc/i2pd/tunnels.conf, /etc/default/i2pd
107  .RS 4
108  i2pd configuration files (when running as a system service)
109  .RE
110  .PP
111  /var/lib/i2pd/
112  .RS 4
113  i2pd profile directory (when running as a system service, see \fB\-\-service\fR above)
114  .RE
115  .PP
116  $HOME/.i2pd/
117  .RS 4
118  i2pd profile directory (when running as a normal user)
119  .SH "SEE ALSO"
120  Documentation at Read the Docs: \m[blue]\fBhttps://i2pd\&.readthedocs\&.io/en/latest/\fR\m[]
121  .SH "AUTHOR"
122  This manual page was written by kytv <\m[blue]\fBkillyourtv@i2pmail\&.org\fR\m[]> for the Debian system (but may be used by others).
123  .RE
124  Updated by hagen <\m[blue]\fBhagen@i2pmail\&.org\fR\m[]> in 2016.
125  .RE
126  Updated by R4SAS <\m[blue]\fBr4sas@i2pmail\&.org\fR\m[]> in 2018.
127  .PP
128  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.
129  .RE
130  On Debian systems, the complete text of the GNU General Public License can be found in \fI/usr/share/common-licenses/GPL\fR