5 files changed, 382 insertions, 0 deletions
diff --git a/docs/man/deluge-console.1 b/docs/man/deluge-console.1
new file mode 100644
index 0000000..75ab1f0
--- /dev/null
+++ b/docs/man/deluge-console.1
@@ -0,0 +1,100 @@
+.TH DELUGE-CONSOLE 1
+
+.SH NAME
+deluge-console - A BitTorrent client console interface
+
+.SH SYNOPSIS
+.B deluge-console [options]
+
+.SH DESCRIPTION
+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
+.SS Console Commands:
+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 various status information from the daemon
+update_tracker@Update tracker for torrent(s)
+.TE
+
+.SH OPTIONS
+.SS Config Options
+.TP
+.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 specified logfile instead of stdout
+.TP
+.BI \-L\  loglevel \fR,\ \fB\-\-loglevel= loglevel
+Set the log level (default is error):
+.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 Help Options
+.TP
+.B \-V\fR,\ \fB\-\-version
+Show program's version number and exit.
+.TP
+.B \-h\fR,\ \fB\-\-help
+Show help message and exit.
+
+.SH SEE ALSO
+.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
new file mode 100644
index 0000000..a27b0c9
--- /dev/null
+++ b/docs/man/deluge-gtk.1
@@ -0,0 +1,55 @@
+.TH DELUGE-GTK 1
+
+.SH NAME
+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 \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 \fIStandalone\fR mode where the daemon functionality will be hidden.
+You can switch to \fIThinclient\fR mode in the Preferences dialog.
+
+.SH OPTIONS
+.SS Config 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 specified logfile instead of stdout
+.TP
+.BI \-L\  loglevel \fR,\ \fB\-\-loglevel= loglevel
+Set the log level (default is error):
+.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 Help Options
+.TP
+.B \-V\fR,\ \fB\-\-version
+Show program's version number and exit.
+.TP
+.B \-h\fR,\ \fB\-\-help
+Show help message and exit.
+
+.SH SEE ALSO
+.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
new file mode 100644
index 0000000..f9f83ae
--- /dev/null
+++ b/docs/man/deluge-web.1
@@ -0,0 +1,86 @@
+.TH DELUGE-WEB 1
+
+.SH NAME
+deluge-web - A BitTorrent client web interface
+
+.SH SYNOPSIS
+.B deluge-web [options]
+
+.SH DESCRIPTION
+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
+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 Config Options
+.TP
+.BI \-c\  path \fR,\ \fB\-\-config= path
+Set the config directory location.
+
+.SS Web Options
+.TP
+.BI \-i\  ip_address \fR,\ \fB\-\-interface= ip_address
+IP address for web server to listen on
+.TP
+.BI \-p\  port \fR,\ \fB\-\-port= port
+Port for web server to listen on
+.TP
+.BI \-b\  path \fR,\ \fB\-\-base= path
+Set the base path that the web ui is running on (proxying)
+.TP
+.B \-\-ssl
+Forces the webserver to use ssl
+.TP
+.B \-\-no-ssl
+Forces the webserver to disable ssl
+
+.SS Logging Options
+.TP
+.BI \-l\  file \fR,\ \fB\-\-logfile= file
+Output to specified logfile instead of stdout
+.TP
+.BI \-L\  loglevel \fR,\ \fB\-\-loglevel= loglevel
+Set the log level (default is error):
+.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
+.BI \-g\fR,\ \fB\-\-group= group
+Change to this group on startup (Requires root)
+
+.SS Help Options
+.TP
+.B \-V\fR,\ \fB\-\-version
+Show program's version number and exit.
+.TP
+.B \-h\fR,\ \fB\-\-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
new file mode 100644
index 0000000..19aef4f
--- /dev/null
+++ b/docs/man/deluge.1
@@ -0,0 +1,63 @@
+.TH DELUGE 1
+
+.SH NAME
+deluge - A BitTorrent client
+
+.SH SYNOPSIS
+.B deluge [options]
+.RI [ torrent-file\fR]
+
+.SH DESCRIPTION
+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 \fIStandalone\fR mode where the daemon functionality will be hidden.
+You can switch to \fIThinclient\fR mode in the Preferences dialog.
+
+.SH OPTIONS
+.SS Config Options
+.TP
+.BI \-c\  path \fR,\ \fB\-\-config= path
+Set the config directory location.
+
+.SS UI Options
+See \fBdeluge -h\fR for available user interfaces.
+.TP
+.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
+
+.SS Logging Options
+.TP
+.BI \-l\  file \fR,\ \fB\-\-logfile= file
+Output to specified logfile instead of stdout
+.TP
+.BI \-L\  loglevel \fR,\ \fB\-\-loglevel= loglevel
+Set the log level (default is error):
+.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 Help Options
+.TP
+.B \-V\fR,\ \fB\-\-version
+Show program's version number and exit.
+.TP
+.B \-h\fR,\ \fB\-\-help
+Show help message and exit.
+
+.SH SEE ALSO
+.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
new file mode 100644
index 0000000..a1877a4
--- /dev/null
+++ b/docs/man/deluged.1
@@ -0,0 +1,78 @@
+.TH DELUGED 1
+
+.SH NAME
+deluged - A BitTorrent client daemon
+
+.SH SYNOPSIS
+.B deluged [options]
+
+.SH DESCRIPTION
+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 \fBdeluged\fR will run as a background daemon, use the \fB\-d\fR option to run process in foreground.
+
+.SH OPTIONS
+.SS Config Options
+.TP
+.BI \-c\  path ,\ \fB\-\-config= path
+Set the config directory location.
+
+.SS Daemon Options
+.TP
+.BI -p\  port \fR,\ \fB--port= port
+Port daemon will listen on, default is 58846
+.TP
+.BI -i\  ip_address \fR,\ \fB--interface= ip_address
+Interface daemon will listen for bittorrent connections on, this should be an IP address
+.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
+
+.SS Logging Options
+.TP
+.BI \-l\  file \fR,\ \fB\-\-logfile= file
+Output to specified logfile instead of stdout
+.TP
+.BI \-L\  loglevel \fR,\ \fB\-\-loglevel= loglevel
+Set the log level (default is error):
+.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
+.BI \-g\fR,\ \fB\-\-group= group
+Change to this group on startup (Requires root)
+
+.SS Help Options
+.TP
+.B \-V\fR,\ \fB\-\-version
+Show program's version number and exit.
+.TP
+.B \-h\fR,\ \fB\-\-help
+Show help message and exit.
+
+.SH SEE ALSO
+.BR deluge (1),
+.BR deluge-web (1),
+.BR deluge-console (1)
+
+.SH AUTHORS
+.B Deluge Team: http://www.deluge-torrent.org