diff --git a/Config.cpp b/Config.cpp index 60f6b51d..337477a0 100644 --- a/Config.cpp +++ b/Config.cpp @@ -109,18 +109,21 @@ namespace config { ("help", "Show this message") ("conf", value()->default_value(""), "Path to main i2pd config file (default: try ~/.i2pd/i2p.conf or /var/lib/i2pd/i2p.conf)") ("tunconf", value()->default_value(""), "Path to config with tunnels list and options (default: try ~/.i2pd/tunnels.cfg or /var/lib/i2pd/tunnels.cfg)") - ("pidfile", value()->default_value(""), "Write pidfile to given path") - ("log", value()->default_value(""), "Write logs to file instead stdout") + ("pidfile", value()->default_value(""), "Path to pidfile (default: ~/i2pd/i2pd.pid or /var/lib/i2pd/i2pd.pid)") + ("log", value()->default_value(""), "Logs destination: stdout, file (stdout if not set, file - otherwise, for compatibility)") ("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)") - ("host", value()->default_value(""), "External IP (deprecated)") - ("port", value()->default_value(0), "Port to listen for incoming connections") + ("host", value()->default_value(""), "External IP") + ("port", value()->default_value(0), "Port to listen for incoming connections (default: auto)") ("ipv6", value()->zero_tokens()->default_value(false), "Enable communication through ipv6") ("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 forward transit traffic") - ("floodfill", value()->zero_tokens()->default_value(false), "Router will try to become floodfill") + ("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") ("bandwidth", value()->default_value('-'), "Bandwidth limiting: L - 32kbps, O - 256Kbps, P - unlimited") +#ifdef _WIN32 + ("svcctl", value()->default_value(""), "Windows service management ('install' or 'remove')") +#endif ; options_description httpserver("HTTP Server options"); diff --git a/docs/configuration.md b/docs/configuration.md index 56d57bc1..3f3c5386 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -7,21 +7,20 @@ Command line options * --conf= - Config file (default: ~/.i2pd/i2p.conf or /var/lib/i2pd/i2p.conf) 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. -* --tunconf= - Tunnels Config file (default: ~/.i2pd/tunnels.cfg or /var/lib/i2pd/tunnels.cfg) +* --tunconf= - Tunnels config file (default: ~/.i2pd/tunnels.cfg or /var/lib/i2pd/tunnels.cfg) * --pidfile= - Where to write pidfile (dont write by default) -* --log - Enable or disable logging to file. 1 for yes, 0 for no. -* --logfile= - Path to logfile (stdout if not set, autodetect if daemon) +* --log= - Logs destination: stdout, file (stdout if not set, file - otherwise, for compatibility) +* --logfile= - Path to logfile (default - autodetect) * --loglevel= - Log messages above this level (debug, *info, warn, error) -* --host= - The external IP (deprecated) +* --host= - The external IP * --port= - The port to listen on -* --daemon - Enable or disable daemon mode. 1 for yes, 0 for no. -* --svcctl= - Windows service management (--svcctl="install" or --svcctl="remove") -* --service - Use system folders (/var/run/i2pd.pid, /var/log/i2pd.log, /var/lib/i2pd). -* --ipv6 - Enable communication through ipv6, off by default -* --notransit - Router will not accept transit tunnels at startup. 0 by default -* --floodfill - Router will be floodfill, off by default +* --daemon - Router will go to background after start +* --service - Router will use system folders like '/var/lib/i2pd' +* --ipv6 - Enable communication through ipv6 +* --notransit - Router will not accept transit tunnels at startup +* --floodfill - Router will be floodfill * --bandwidth= - L if bandwidth is limited to 32Kbs/sec, O - to 256Kbs/sec, P - unlimited - This option will be ignored if --floodfill given +* --svcctl= - Windows service management (--svcctl="install" or --svcctl="remove") * --http.address= - The address to listen on (HTTP server) * --http.port= - The port to listen on (HTTP server)