From e4513d18b97f26c6c093f8a12b4c23fc33d4f3ac Mon Sep 17 00:00:00 2001 From: kytv <kytv@mail.i2p> Date: Thu, 19 Apr 2012 23:25:32 +0000 Subject: [PATCH] manpage updates --- installer/resources/man/eepget.1 | 27 +++++++++++++++++---------- installer/resources/man/i2prouter.1 | 24 +++++++++++++++++++----- 2 files changed, 36 insertions(+), 15 deletions(-) diff --git a/installer/resources/man/eepget.1 b/installer/resources/man/eepget.1 index d8509d4c61..f7d38d91c2 100644 --- a/installer/resources/man/eepget.1 +++ b/installer/resources/man/eepget.1 @@ -1,6 +1,4 @@ -.\"Created with GNOME Manpages Editor Wizard -.\"http://sourceforge.net/projects/gmanedit2 -.TH Eepget 1 "November 13, 2010" "" "Eepget - I2P Downloader" +.TH EEEPGET 1 "April 19, 2012" "" "Eepget - I2P Downloader" .SH NAME Eepget \- I2P downloader @@ -11,25 +9,33 @@ Eepget \- I2P downloader .br .SH DESCRIPTION -\fBEepget\fP downloads a file via HTTP through the I2P network. It handles .i2p URLs as well as URLs on the regular web such as .com. +.P +Download a file non-interactively via HTTP. Transfers through both I2P and the +regular Internet are supported. +.P +Eepget is able to cope with slow or unstable network connections; if a download +is not successful because of a network problem, it will keep retrying until the +whole file has been retrieved (by default up to three times). If supported by +the remote server, eepget will instruct the server to continue the download +from the point of interruption. .SH OPTIONS .B \fB\-p\fR proxy_host:port .TP -Sets the I2P proxy server (eeproxy) to use. The default is 127.0.0.1:4444. +Specify an I2P proxy server (eeproxy) to use. If this option is not specified, eepget will use 127.0.0.1:4444. Specify \fB\-p\fR :0 to disable the eeproxy. .TP .B \fB\-n\fR retries .TP -Sets the number of retries if the download fails. The default is 3. +Specify the number of times to retry downloading if the download isn't successful. If this option is not specified, eepget will retry downloading the file 3 times. .TP .B \fB\-o\fR file .TP -Sets the output file to write to. If this option is not given, the URL determines the output filename. +Sets the output file to write to. If this option is not given, the output filename will be determined by the URL. .TP .B @@ -42,12 +48,13 @@ Controls the progress display. \fB\ markSize \fP is the number of bytes one '#' \fB\-t\fR seconds .TP Sets the inactivity timeout. The default is 60 seconds. -.TP -.SH "EXIT STATUS" +.SH EXIT STATUS -\fB Eepget\fP always exits with the status 0. +.B eepget +exits with status zero upon successful transfer and non-zero if there were problems with the download. .SH "SEE ALSO" wget(1) + diff --git a/installer/resources/man/i2prouter.1 b/installer/resources/man/i2prouter.1 index e1ba8f6232..94c91f0e57 100644 --- a/installer/resources/man/i2prouter.1 +++ b/installer/resources/man/i2prouter.1 @@ -1,17 +1,15 @@ -.\"Created with GNOME Manpages Editor Wizard -.\"http://sourceforge.net/projects/gmanedit2 -.TH i2prouter 1 "November 13, 2010" "" "I2PRouter" +.TH i2prouter 1 "April 19, 2012" "" "I2PROUTER" .SH NAME i2prouter \- start and stop the I2P router .SH SYNOPSIS .B i2prouter -.RI { console | start | stop | restart | status | dump } +.RI { console | start | stop | graceful | restart | condrestart | status | dump | install | remove } .br .SH DESCRIPTION -\fBi2prouter\fP controls the I2P service. It takes options similar to init scripts. +Control the I2P service. .B .IP console @@ -29,6 +27,22 @@ Stops the I2P service. .IP restart Stops the I2P service and then starts it. +.B +.IP condrestart +Restart the I2P service only if it is already running. + +.B +.IP graceful +Stop I2P gracefully (may take up to 11 minutes) + +.B +.IP install +Install initscript to start I2P automatically when the system boots. + +.B +.IP remove +Uninstall initscript that was installed with \fB install\fP + .B .IP status Prints whether the I2P service is running. -- GitLab