From cbb60e3c3a2a01ee6bef444b85da0d307294c5a3 Mon Sep 17 00:00:00 2001 From: Calum Lind Date: Fri, 14 Aug 2015 12:55:28 +0100 Subject: [PATCH] Update man pages --- docs/man/deluge-console.1 | 47 +++++++++++++++++++--------- docs/man/deluge-gtk.1 | 56 +++++++++++++++++++++++++-------- docs/man/deluge-web.1 | 57 ++++++++++++++++++++++----------- docs/man/deluge.1 | 66 +++++++++++++++++++++------------------ docs/man/deluged.1 | 61 +++++++++++++++++++----------------- 5 files changed, 182 insertions(+), 105 deletions(-) diff --git a/docs/man/deluge-console.1 b/docs/man/deluge-console.1 index 1c24b9951..ade66deba 100644 --- a/docs/man/deluge-console.1 +++ b/docs/man/deluge-console.1 @@ -1,4 +1,4 @@ -.TH DELUGE-CONSOLE 1 "January 2099" "1.3.900-dev" +.TH DELUGE-CONSOLE 1 "January 2099" "2.0-dev" .SH NAME deluge-console - a bittorrent client curses interface @@ -7,23 +7,42 @@ deluge-console - a bittorrent client curses interface .B deluge-console [options] .SH DESCRIPTION -.br -.P Deluge utilizes a client/server model, with 'deluged' being the daemon process and 'deluge-console' being used to launch a console user-interface. -.br .P -You can pass console commands directly from the command line, see `deluge-console \-\-help` for a list of commands. -Run multiple commands by separating them with a semi-colon (;). +You can pass console commands directly from the command line and run multiple commands by separating them with a semi-colon (;). +.SS Console Commands: + info quit pause help resume del plugin cache add exit connect debug rm config recheck halt .SH OPTIONS -See `deluge`. +.SS General Options +.TP +.BI -c\ path \fR,\ \fB--config= path +Set the config directory location. + +.SS Logging Options +.TP +.BI -l\ file \fR,\ \fB--logfile= file +Output to designated logfile instead of stdout +.TP +.BI -L\ loglevel \fR,\ \fB--loglevel= loglevel +Set the log level (default is error): +.B none, info, warning, error, critical, debug +.TP +.B -q, --quiet +Sets the log level to 'none', same as `\-L none` + +.SS Help Options +.TP +.B -v, --version +Show program's version number and exit. +.TP +.B -h, --help +Show help message and exit. .SH SEE ALSO -.B Homepage: -http://www.deluge-torrent.org/ +.BR deluge(1), +.BR deluged(1), +.BR deluge-web(1) -.SH AUTHOR -This manual page was written by Andrew Resch . -.br -Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 or any later version published by the Free Software Foundation -.br +.SH AUTHORS +.B Deluge Team: http://www.deluge-torrent.org diff --git a/docs/man/deluge-gtk.1 b/docs/man/deluge-gtk.1 index 8a59c3959..d7992c802 100644 --- a/docs/man/deluge-gtk.1 +++ b/docs/man/deluge-gtk.1 @@ -1,28 +1,58 @@ -.TH DELUGE-GTK 1 "January 2099" "1.3.900-dev" +.TH DELUGE-GTK 1 "January 2099" "2.0-dev" .SH NAME deluge-gtk - a bittorrent client gtk interface .SH SYNOPSIS -.B deluge-gtk [options] [torrent] +.B deluge-gtk [options] +.RI [ torrent-file\fR] .SH DESCRIPTION -.br -.P Deluge utilizes a client/server model, with 'deluged' being the daemon process and 'deluge-gtk' being used to launch a GTK+ user-interface. -.br .P By default, Deluge will run in 'Classic' mode where the daemon functionality will be hidden. You can turn this off in the Preferences dialog. .SH OPTIONS -See `deluge`. +.SS General Options +.TP +.BI -c\ path \fR,\ \fB--config= path +Set the config directory location. + +.SS UI Options +.TP +.BI -u\ ui \fR,\ \fB--ui= ui +The UI that you wish to launch, current options include: gtk, web or console +.TP +.BI -s\ default_ui \fR,\ \fB--set-default-ui= default_ui +Sets the default UI to be run when no UI is specified +.TP +.BI -a\ args \fR,\ \fB--args= args +Arguments to pass to a UI, -a '--option args' + +.SS Logging Options +.TP +.BI -l\ file \fR,\ \fB--logfile= file +Output to designated logfile instead of stdout +.TP +.BI -L\ loglevel \fR,\ \fB--loglevel= loglevel +Set the log level (default is error): +.B none, info, warning, error, critical, debug +.TP +.B -q, --quiet +Sets the log level to 'none', same as `\-L none` + +.SS Help Options +.TP +.B -v, --version +Show program's version number and exit. +.TP +.B -h, --help +Show help message and exit. .SH SEE ALSO -.B Homepage: -http://www.deluge-torrent.org/ +.BR deluged(1), +.BR deluge-web(1), +.BR deluge-console(1) -.SH AUTHOR -This manual page was written by Andrew Resch . -.br -Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 or any later version published by the Free Software Foundation -.br +.SH AUTHORS +.B Deluge Team: http://www.deluge-torrent.org diff --git a/docs/man/deluge-web.1 b/docs/man/deluge-web.1 index 0634c8447..e3605fe27 100644 --- a/docs/man/deluge-web.1 +++ b/docs/man/deluge-web.1 @@ -1,4 +1,4 @@ -.TH DELUGE-WEB 1 "January 2099" "1.3.900-dev" +.TH DELUGE-WEB 1 "January 2099" "2.0-dev" .SH NAME deluge-web - a bittorrent client ajax web interface @@ -7,25 +7,28 @@ deluge-web - a bittorrent client ajax web interface .B deluge-web [options] .SH DESCRIPTION -.br -.P -Deluge utilizes a client/server model, with 'deluged' being the daemon process and 'deluge-web' being used to launch an ajax web based user-interface. The default password is 'deluge'. -.br +Deluge utilizes a client/server model, with 'deluged' being the daemon process and 'deluge-web' being used to launch an ajax web based user-interface. .P +The default password is 'deluge'. .SH OPTIONS -See `deluge-web \-\-help` for common options, the web specific options are: +.SS General Options .TP -.B -b BASE, --base=BASE -Set the base path that the ui is running on (proxying) +.BI -c\ path \fR,\ \fB--config= path +Set the config directory location. + +.SS Web Options +.TP +.BI -b\ path \fR,\ \fB--base= path +Set the base path that the web ui is running on (proxying) .TP .B -f, --fork Fork the web interface process into the background .TP -.B -i INTERFACE, --interface=INTERFACE +.BI -i\ ip_address \fR,\ \fB--interface= ip_address Binds the webserver to a specific IP address .TP -.B -p PORT, --port=PORT +.BI -p\ port \fR,\ \fB--port= port Sets the port to be used for the webserver .TP .B --profile @@ -37,12 +40,30 @@ Forces the webserver to disable ssl .B --ssl Forces the webserver to use ssl -.SH SEE ALSO -.B Homepage: -http://www.deluge-torrent.org/ +.SS Logging Options +.TP +.BI -l\ file \fR,\ \fB--logfile= file +Output to designated logfile instead of stdout +.TP +.BI -L\ loglevel \fR,\ \fB--loglevel= loglevel +Set the log level (default is error): +.B none, info, warning, error, critical, debug +.TP +.B -q, --quiet +Sets the log level to 'none', same as `\-L none` -.SH AUTHOR -This manual page was written by Damien Churchill . -.br -Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 or any later version published by the Free Software Foundation -.br +.SS Help Options +.TP +.B -v, --version +Show program's version number and exit. +.TP +.B -h, --help +Show help message and exit. + +.SH SEE ALSO +.BR deluge(1), +.BR deluged(1), +.BR deluge-console(1) + +.SH AUTHORS +.B Deluge Team: http://www.deluge-torrent.org diff --git a/docs/man/deluge.1 b/docs/man/deluge.1 index 72b0cfc31..e60976490 100644 --- a/docs/man/deluge.1 +++ b/docs/man/deluge.1 @@ -1,54 +1,58 @@ -.TH DELUGE 1 "January 2099" "1.3.900-dev" +.TH DELUGE 1 "January 2099" "2.0-dev" .SH NAME deluge - a bittorrent client .SH SYNOPSIS -.B deluge [options] [torrent] +.B deluge [options] +.RI [ torrent-file\fR] .SH DESCRIPTION -.br -.P Deluge utilizes a client/server model, with 'deluged' being the daemon process and 'deluge' being used to launch a user-interface. -.br .P By default, Deluge will run in 'Classic' mode where the daemon functionality will be hidden and the GtkUI will automatically launch a 'deluged' process. You can turn this off in the Preferences dialog. .SH OPTIONS +.SS General Options .TP -.I [torrent] -List of ".torrent" files to add to the download queue. +.BI -c\ path \fR,\ \fB--config= path +Set the config directory location. + +.SS UI Options .TP -.I --version -Show program's version number and exit. -.TP -.I -h, --help -Show this help message and exit. -.TP -.I -c CONFIG, --config=CONFIG -Sets the configuration path. -.TP -.I -u UI, --ui=UI +.BI -u\ ui \fR,\ \fB--ui= ui The UI that you wish to launch, current options include: gtk, web or console .TP -.I -l LOGFILE, --logfile=LOGFILE +.BI -s\ default_ui \fR,\ \fB--set-default-ui= default_ui +Sets the default UI to be run when no UI is specified +.TP +.BI -a\ args \fR,\ \fB--args= args +Arguments to pass to a UI, -a '--option args' + +.SS Logging Options +.TP +.BI -l\ file \fR,\ \fB--logfile= file Output to designated logfile instead of stdout .TP -.I -L LOGLEVEL, --loglevel=LOGLEVEL -Set the log level (default is error): none, info, warning, error, critical, debug +.BI -L\ loglevel \fR,\ \fB--loglevel= loglevel +Set the log level (default is error): +.B none, info, warning, error, critical, debug .TP -.I -q --quiet -Sets the log level to 'none', this is the same as `\-L none` +.B -q, --quiet +Sets the log level to 'none', same as `\-L none` + +.SS Help Options .TP -.I -s DEFAULT_UI, --set-default-ui=DEFAULT_UI -Sets the default UI to be run when no UI is specified +.B -v, --version +Show program's version number and exit. +.TP +.B -h, --help +Show help message and exit. .SH SEE ALSO -.B Homepage: -http://www.deluge-torrent.org/ +.BR deluged(1), +.BR deluge-web(1), +.BR deluge-console(1) -.SH AUTHOR -This manual page was written by Andrew Resch . -.br -Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 or any later version published by the Free Software Foundation -.br +.SH AUTHORS +.B Deluge Team: http://www.deluge-torrent.org diff --git a/docs/man/deluged.1 b/docs/man/deluged.1 index 926044f90..31df2b6fc 100644 --- a/docs/man/deluged.1 +++ b/docs/man/deluged.1 @@ -1,4 +1,4 @@ -.TH DELUGED 1 ""January 2099" "1.3.900-dev" +.TH DELUGED 1 ""January 2099" "2.0-dev" .SH NAME deluged - a bittorrent client daemon @@ -7,54 +7,57 @@ deluged - a bittorrent client daemon .B deluged [options] .SH DESCRIPTION -.br -.P Deluge utilizes a client/server model, with 'deluged' being the daemon process and 'deluge' being used to launch a user-interface. -.br .P By default, 'deluged' will run as a daemon, to prevent this you can run deluged with the \-d option. This option is useful for running deluged with the start-stop-daemon. .SH OPTIONS +.SS General Options .TP -.I --version -Show program's version number and exit. +.BI -c\ path \fR,\ \fB--config= path +Set the config directory location. + +.SS Daemon Options .TP -.I -h, --help -Show this help message and exit. -.TP -.I -p PORT, --port=PORT +.BI -p\ port \fR,\ \fB--port= port Port daemon will listen on, default is 58846 .TP -.I -i INTERFACE, --interface=INTERFACE +.BI -i\ ip_address \fR,\ \fB--interface= ip_address Interface daemon will listen for bittorrent connections on, this should be an IP address .TP -.I -u UI_INTERFACE, --ui-interface=UI_INTERFACE +.BI -u\ ip_address \fR,\ \fB--ui-interface= ip_address Interface daemon will listen for UI connections on, this should be an IP address .TP -.I -d, --do-not-daemonize +.B -d, --do-not-daemonize Do not daemonize .TP -.I -c CONFIG, --config=CONFIG -Sets the configuration path. +.BI -P\ file \fR,\ \fB--pidfile= file +Use pidfile to store process id + +.SS Logging Options .TP -.I -l LOGFILE, --logfile=LOGFILE +.BI -l\ file \fR,\ \fB--logfile= file Output to designated logfile instead of stdout .TP -.I -P PIDFILE, --pidfile=PIDFILE -Use pidfile to store process id +.BI -L\ loglevel \fR,\ \fB--loglevel= loglevel +Set the log level (default is error): +.B none, info, warning, error, critical, debug .TP -.I -L LOGLEVEL, --loglevel=LOGLEVEL -Set the log level (default is error): none, info, warning, error, critical, debug +.B -q, --quiet +Sets the log level to 'none', same as `\-L none` + +.SS Help Options .TP -.I -q --quiet -Sets the log level to 'none', this is the same as `\-L none` +.B -v, --version +Show program's version number and exit. +.TP +.B -h, --help +Show help message and exit. .SH SEE ALSO -.B Homepage: -http://www.deluge-torrent.org/ +.BR deluge(1), +.BR deluge-web(1), +.BR deluge-console(1) -.SH AUTHOR -This manual page was written by Andrew Resch . -.br -Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 or any later version published by the Free Software Foundation -.br +.SH AUTHORS +.B Deluge Team: http://www.deluge-torrent.org