summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorCalum Lind <calumlind+deluge@gmail.com>2017-03-13 23:34:41 +0000
committerCalum Lind <calumlind+deluge@gmail.com>2017-03-14 14:58:59 +0000
commit50c476c41d26533a6663e003eee900b66cff7966 (patch)
tree72d726ded1922165c8396bdd0f146ad3e652c69b /docs
parent82325059618142697ca59ccbc83763bc77619281 (diff)
downloaddeluge-50c476c41d26533a6663e003eee900b66cff7966.tar.gz
deluge-50c476c41d26533a6663e003eee900b66cff7966.tar.bz2
deluge-50c476c41d26533a6663e003eee900b66cff7966.zip
Update man pages to reflect ui arg changes
- Also fixup help output details
Diffstat (limited to 'docs')
-rw-r--r--docs/man/deluge-console.188
-rw-r--r--docs/man/deluge-gtk.153
-rw-r--r--docs/man/deluge-web.181
-rw-r--r--docs/man/deluge.149
-rw-r--r--docs/man/deluged.159
5 files changed, 208 insertions, 122 deletions
diff --git a/docs/man/deluge-console.1 b/docs/man/deluge-console.1
index ade66deba..8e6652aa8 100644
--- a/docs/man/deluge-console.1
+++ b/docs/man/deluge-console.1
@@ -1,48 +1,100 @@
-.TH DELUGE-CONSOLE 1 "January 2099" "2.0-dev"
+.TH DELUGE-CONSOLE 1 "January 2017" "2.0-dev"
.SH NAME
-deluge-console - a bittorrent client curses interface
+deluge-console - A BitTorrent client console interface
.SH SYNOPSIS
.B deluge-console [options]
.SH DESCRIPTION
-Deluge utilizes a client/server model, with 'deluged' being the daemon process and 'deluge-console' being used to launch a console user-interface.
+Deluge utilizes a client/server model, with \fBdeluged\fR being the daemon process and \fBdeluge-console\fR being used to launch a curses console user-interface.
.P
-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
+You can pass console commands directly from the command line and use semi-colon (\fB;\fR) seperator to run multiple commands. Enclosing the commands with quotes may also be required
+for example:
+
+ \fBdeluge-console 'add <torrent>; info <torrent_id>'\fR
+
+The following console commands are available:
+.TS
+tab (@);
+lB lx.
+add@Add torrents
+cache@Show information about the disk cache
+config@Show and set configuration values
+connect@Connect to a new deluge server
+debug@Enable and disable debugging
+del@Alias for \fBrm\fR
+exit@Alias for \fBquit\fR
+gui@Enable interactive mode
+halt@Shutdown the deluge server
+help@Displays help on other commands
+info@Show information about the torrents
+manage@Show and manage per-torrent options
+move@Move torrents' storage location
+pause@Pause torrents
+plugin@Manage plugins
+quit@Exit the client
+reannounce@Alias for \fBupdate_tracker\fR
+recheck@Forces a recheck of the torrent data
+resume@Resume torrents
+rm@Remove a torrent
+status@Shows a various status information from the daemon
+update_tracker@Update tracker for torrent(s)
+.TE
.SH OPTIONS
-.SS General Options
+.SS Config Options
.TP
-.BI -c\ path \fR,\ \fB--config= path
+.BI \-c\ path \fR,\ \fB\-\-config= path
Set the config directory location.
+.SS Console Options
+These daemon connect options will be used for commands, or if console ui autoconnect is enabled.
+.TP
+.BI \-d\ ip_addr \fR,\ \fB\-\-daemon= ip_addr
+Deluge daemon IP address to connect to (default 127.0.0.1)
+.TP
+.BI \-p\ port \fR,\ \fB\-\-port= port
+Deluge daemon port to connect to (default 58846)
+.TP
+.BI \-U\ user \fR,\ \fB\-\-username= user
+Deluge daemon username to use when connecting
+.TP
+.BI \-P\ pass \fR,\ \fB\-\-password= pass
+Deluge daemon password to use when connecting
+
.SS Logging Options
.TP
-.BI -l\ file \fR,\ \fB--logfile= file
-Output to designated logfile instead of stdout
+.BI \-l\ file \fR,\ \fB\-\-logfile= file
+Output to specified logfile instead of stdout
.TP
-.BI -L\ loglevel \fR,\ \fB--loglevel= loglevel
+.BI \-L\ loglevel \fR,\ \fB\-\-loglevel= loglevel
Set the log level (default is error):
-.B none, info, warning, error, critical, debug
+.B none, info, warning, error, debug
+.TP
+.B \-q\fR,\ \fB\-\-quiet
+Sets the log level to \fBnone\fR, same as \fB\-L none
+.TP
+.BI \-\-logrotate\fR[\fB=\fImax-size\fR]
+Enable logfile rotation, with optional maximum logfile
+size, default: 2M (Logfile rotation count is 5)
.TP
-.B -q, --quiet
-Sets the log level to 'none', same as `\-L none`
+.BI \-\-profile\fR[\fB=\fIfile\fR]
+Profile with cProfile. Outputs to stdout unless a filename is specified
.SS Help Options
.TP
-.B -v, --version
+.B \-V\fR,\ \fB\-\-version
Show program's version number and exit.
.TP
-.B -h, --help
+.B \-h\fR,\ \fB\-\-help
Show help message and exit.
.SH SEE ALSO
-.BR deluge(1),
-.BR deluged(1),
-.BR deluge-web(1)
+.BR deluge (1),
+.BR deluged (1),
+.BR deluge-web (1)
.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 d7992c802..e1a72abec 100644
--- a/docs/man/deluge-gtk.1
+++ b/docs/man/deluge-gtk.1
@@ -1,58 +1,55 @@
-.TH DELUGE-GTK 1 "January 2099" "2.0-dev"
+.TH DELUGE-GTK 1 "January 2017" "2.0-dev"
.SH NAME
-deluge-gtk - a bittorrent client gtk interface
+deluge-gtk - A BitTorrent client Gtk interface
.SH SYNOPSIS
.B deluge-gtk [options]
.RI [ torrent-file\fR]
.SH DESCRIPTION
-Deluge utilizes a client/server model, with 'deluged' being the daemon process and 'deluge-gtk' being used to launch a GTK+ user-interface.
+Deluge utilizes a client/server model, with \fBdeluged\fR being the daemon process and \fBdeluge-gtk\fR being used to launch a Gtk user-interface.
.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.
+By default, Deluge will run in \fIStandalone\fR mode where the daemon functionality will be hidden.
+You can switch to \fIThinclient\fR mode in the Preferences dialog.
.SH OPTIONS
-.SS General Options
+.SS Config Options
.TP
-.BI -c\ path \fR,\ \fB--config= path
+.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
+.BI \-l\ file \fR,\ \fB\-\-logfile= file
+Output to specified logfile instead of stdout
.TP
-.BI -L\ loglevel \fR,\ \fB--loglevel= loglevel
+.BI \-L\ loglevel \fR,\ \fB\-\-loglevel= loglevel
Set the log level (default is error):
-.B none, info, warning, error, critical, debug
+.B none, info, warning, error, debug
+.TP
+.B \-q\fR,\ \fB\-\-quiet
+Sets the log level to \fBnone\fR, same as \fB\-L none
+.TP
+.BI \-\-logrotate\fR[\fB=\fImax-size\fR]
+Enable logfile rotation, with optional maximum logfile
+size, default: 2M (Logfile rotation count is 5)
.TP
-.B -q, --quiet
-Sets the log level to 'none', same as `\-L none`
+.BI \-\-profile\fR[\fB=\fIfile\fR]
+Profile with cProfile. Outputs to stdout unless a filename is specified
.SS Help Options
.TP
-.B -v, --version
+.B \-V\fR,\ \fB\-\-version
Show program's version number and exit.
.TP
-.B -h, --help
+.B \-h\fR,\ \fB\-\-help
Show help message and exit.
.SH SEE ALSO
-.BR deluged(1),
-.BR deluge-web(1),
-.BR deluge-console(1)
+.BR deluged (1),
+.BR deluge-web (1)
+.BR deluge-console (1),
.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 e3605fe27..da73991de 100644
--- a/docs/man/deluge-web.1
+++ b/docs/man/deluge-web.1
@@ -1,69 +1,86 @@
-.TH DELUGE-WEB 1 "January 2099" "2.0-dev"
+.TH DELUGE-WEB 1 "January 2017" "2.0-dev"
.SH NAME
-deluge-web - a bittorrent client ajax web interface
+deluge-web - A BitTorrent client web interface
.SH SYNOPSIS
.B deluge-web [options]
.SH DESCRIPTION
-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.
+Deluge utilizes a client/server model, with \fBdeluged\fR being the daemon process and \fBdeluge-web\fR being used to launch an ajax web based user-interface.
.P
-The default password is 'deluge'.
+By default \fBdeluge-web\fR will run as a background daemon, use the \fB\-d\fR option to run process in foreground.
+
+The default password is \fBdeluge\fR and serves \fBhttp:\\\\localhost:8112\fR web page.
.SH OPTIONS
-.SS General Options
+.SS Config Options
.TP
-.BI -c\ path \fR,\ \fB--config= path
+.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
+.BI \-i\ ip_address \fR,\ \fB\-\-interface= ip_address
+IP address for web server to listen on
.TP
-.BI -i\ ip_address \fR,\ \fB--interface= ip_address
-Binds the webserver to a specific IP address
+.BI \-p\ port \fR,\ \fB\-\-port= port
+Port for web server to listen on
.TP
-.BI -p\ port \fR,\ \fB--port= port
-Sets the port to be used for the webserver
+.BI \-b\ path \fR,\ \fB\-\-base= path
+Set the base path that the web ui is running on (proxying)
.TP
-.B --profile
-Profile the webserver code
+.B \-\-ssl
+Forces the webserver to use ssl
.TP
-.B --no-ssl
+.B \-\-no-ssl
Forces the webserver to disable ssl
-.TP
-.B --ssl
-Forces the webserver to use ssl
.SS Logging Options
.TP
-.BI -l\ file \fR,\ \fB--logfile= file
-Output to designated logfile instead of stdout
+.BI \-l\ file \fR,\ \fB\-\-logfile= file
+Output to specified logfile instead of stdout
.TP
-.BI -L\ loglevel \fR,\ \fB--loglevel= loglevel
+.BI \-L\ loglevel \fR,\ \fB\-\-loglevel= loglevel
Set the log level (default is error):
-.B none, info, warning, error, critical, debug
+.B none, info, warning, error, debug
+.TP
+.B \-q\fR,\ \fB\-\-quiet
+Sets the log level to \fBnone\fR, same as \fB\-L none
+.TP
+.BI \-\-logrotate\fR[\fB=\fImax-size\fR]
+Enable logfile rotation, with optional maximum logfile
+size, default: 2M (Logfile rotation count is 5)
+.TP
+.BI \-\-profile\fR[\fB=\fIfile\fR]
+Profile with cProfile. Outputs to stdout unless a filename is specified
+
+.SS Process Control Options:
+.TP
+.BI \-P\ file \fR,\ \fB\-\-pidfile= file
+Pidfile to store the process id
+.TP
+.B -d\fR,\ \fB\-\-do-not-daemonize
+Do not daemonize (fork) this process
+.TP
+.BI \-U\fR,\ \fB\-\-user= user
+Change to this user on startup (Requires root)
.TP
-.B -q, --quiet
-Sets the log level to 'none', same as `\-L none`
+.BI \-g\fR,\ \fB\-\-group= group
+Change to this group on startup (Requires root)
.SS Help Options
.TP
-.B -v, --version
+.B \-V\fR,\ \fB\-\-version
Show program's version number and exit.
.TP
-.B -h, --help
+.B \-h\fR,\ \fB\-\-help
Show help message and exit.
.SH SEE ALSO
-.BR deluge(1),
-.BR deluged(1),
-.BR deluge-console(1)
+.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 e60976490..c0acae088 100644
--- a/docs/man/deluge.1
+++ b/docs/man/deluge.1
@@ -1,58 +1,63 @@
-.TH DELUGE 1 "January 2099" "2.0-dev"
+.TH DELUGE 1 "January 2017" "2.0-dev"
.SH NAME
-deluge - a bittorrent client
+deluge - A BitTorrent client
.SH SYNOPSIS
.B deluge [options]
.RI [ torrent-file\fR]
.SH DESCRIPTION
-Deluge utilizes a client/server model, with 'deluged' being the daemon process and 'deluge' being used to launch a user-interface.
+Deluge utilizes a client/server model, with \fBdeluged\fR being the daemon process and \fBdeluge\fR being used to launch a user-interface.
.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.
+By default, Deluge will run in \fIStandalone\fR mode where the daemon functionality will be hidden.
+You can switch to \fIThinclient\fR mode in the Preferences dialog.
.SH OPTIONS
-.SS General Options
+.SS Config Options
.TP
-.BI -c\ path \fR,\ \fB--config= path
+.BI \-c\ path \fR,\ \fB\-\-config= path
Set the config directory location.
.SS UI Options
+See \fBdeluge -h\fR for available user interfaces.
.TP
-.BI -u\ ui \fR,\ \fB--ui= ui
-The UI that you wish to launch, current options include: gtk, web or console
+.I user_interface \fR[\fIui-args\fR] Alternative UI to launch, with optional ui args
.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
+.BI \-l\ file \fR,\ \fB\-\-logfile= file
+Output to specified logfile instead of stdout
.TP
-.BI -L\ loglevel \fR,\ \fB--loglevel= loglevel
+.BI \-L\ loglevel \fR,\ \fB\-\-loglevel= loglevel
Set the log level (default is error):
-.B none, info, warning, error, critical, debug
+.B none, info, warning, error, debug
+.TP
+.B \-q\fR,\ \fB\-\-quiet
+Sets the log level to \fBnone\fR, same as \fB\-L none
+.TP
+.BI \-\-logrotate\fR[\fB=\fImax-size\fR]
+Enable logfile rotation, with optional maximum logfile
+size, default: 2M (Logfile rotation count is 5)
.TP
-.B -q, --quiet
-Sets the log level to 'none', same as `\-L none`
+.BI \-\-profile\fR[\fB=\fIfile\fR]
+Profile with cProfile. Outputs to stdout unless a filename is specified
.SS Help Options
.TP
-.B -v, --version
+.B \-V\fR,\ \fB\-\-version
Show program's version number and exit.
.TP
-.B -h, --help
+.B \-h\fR,\ \fB\-\-help
Show help message and exit.
.SH SEE ALSO
-.BR deluged(1),
-.BR deluge-web(1),
-.BR deluge-console(1)
+.BR deluged (1),
+.BR deluge-web (1)
+.BR deluge-console (1),
.SH AUTHORS
.B Deluge Team: http://www.deluge-torrent.org
diff --git a/docs/man/deluged.1 b/docs/man/deluged.1
index 31df2b6fc..2e1c17d04 100644
--- a/docs/man/deluged.1
+++ b/docs/man/deluged.1
@@ -1,20 +1,20 @@
.TH DELUGED 1 ""January 2099" "2.0-dev"
.SH NAME
-deluged - a bittorrent client daemon
+deluged - A BitTorrent client daemon
.SH SYNOPSIS
.B deluged [options]
.SH DESCRIPTION
-Deluge utilizes a client/server model, with 'deluged' being the daemon process and 'deluge' being used to launch a user-interface.
+Deluge utilizes a client/server model, with \fBdeluged\fR being the daemon process and \fBdeluge\fR being used to launch a user-interface.
.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.
+By default \fBdeluged\fR will run as a background daemon, use the \fB\-d\fR option to run process in foreground.
.SH OPTIONS
-.SS General Options
+.SS Config Options
.TP
-.BI -c\ path \fR,\ \fB--config= path
+.BI \-c\ path ,\ \fB\-\-config= path
Set the config directory location.
.SS Daemon Options
@@ -27,37 +27,52 @@ Interface daemon will listen for bittorrent connections on, this should be an IP
.TP
.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
-.B -d, --do-not-daemonize
-Do not daemonize
-.TP
-.BI -P\ file \fR,\ \fB--pidfile= file
-Use pidfile to store process id
.SS Logging Options
.TP
-.BI -l\ file \fR,\ \fB--logfile= file
-Output to designated logfile instead of stdout
+.BI \-l\ file \fR,\ \fB\-\-logfile= file
+Output to specified logfile instead of stdout
.TP
-.BI -L\ loglevel \fR,\ \fB--loglevel= loglevel
+.BI \-L\ loglevel \fR,\ \fB\-\-loglevel= loglevel
Set the log level (default is error):
-.B none, info, warning, error, critical, debug
+.B none, info, warning, error, debug
+.TP
+.B \-q\fR,\ \fB\-\-quiet
+Sets the log level to \fBnone\fR, same as \fB\-L none
+.TP
+.BI \-\-logrotate\fR[\fB=\fImax-size\fR]
+Enable logfile rotation, with optional maximum logfile
+size, default: 2M (Logfile rotation count is 5)
+.TP
+.BI \-\-profile\fR[\fB=\fIfile\fR]
+Profile with cProfile. Outputs to stdout unless a filename is specified
+
+.SS Process Control Options:
+.TP
+.BI \-P\ file \fR,\ \fB\-\-pidfile= file
+Pidfile to store the process id
+.TP
+.B -d\fR,\ \fB\-\-do-not-daemonize
+Do not daemonize (fork) this process
+.TP
+.BI \-U\fR,\ \fB\-\-user= user
+Change to this user on startup (Requires root)
.TP
-.B -q, --quiet
-Sets the log level to 'none', same as `\-L none`
+.BI \-g\fR,\ \fB\-\-group= group
+Change to this group on startup (Requires root)
.SS Help Options
.TP
-.B -v, --version
+.B \-V\fR,\ \fB\-\-version
Show program's version number and exit.
.TP
-.B -h, --help
+.B \-h\fR,\ \fB\-\-help
Show help message and exit.
.SH SEE ALSO
-.BR deluge(1),
-.BR deluge-web(1),
-.BR deluge-console(1)
+.BR deluge (1),
+.BR deluge-web (1),
+.BR deluge-console (1)
.SH AUTHORS
.B Deluge Team: http://www.deluge-torrent.org