summaryrefslogtreecommitdiffstats
path: root/docs/man/deluge-web.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man/deluge-web.1')
-rw-r--r--docs/man/deluge-web.186
1 files changed, 86 insertions, 0 deletions
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