Update man pages

This commit is contained in:
Calum Lind 2015-08-14 12:55:28 +01:00
parent 6020809462
commit cbb60e3c3a
5 changed files with 182 additions and 105 deletions

View File

@ -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 .SH NAME
deluge-console - a bittorrent client curses interface deluge-console - a bittorrent client curses interface
@ -7,23 +7,42 @@ deluge-console - a bittorrent client curses interface
.B deluge-console [options] .B deluge-console [options]
.SH DESCRIPTION .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. 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 .P
You can pass console commands directly from the command line, see `deluge-console \-\-help` for a list of commands. You can pass console commands directly from the command line and run multiple commands by separating them with a semi-colon (;).
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 .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 .SH SEE ALSO
.B Homepage: .BR deluge(1),
http://www.deluge-torrent.org/ .BR deluged(1),
.BR deluge-web(1)
.SH AUTHOR .SH AUTHORS
This manual page was written by Andrew Resch <andrewresch@gmail.com>. .B Deluge Team: http://www.deluge-torrent.org
.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

View File

@ -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 .SH NAME
deluge-gtk - a bittorrent client gtk interface deluge-gtk - a bittorrent client gtk interface
.SH SYNOPSIS .SH SYNOPSIS
.B deluge-gtk [options] [torrent] .B deluge-gtk [options]
.RI [ torrent-file\fR]
.SH DESCRIPTION .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. 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 .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 'Classic' mode where the daemon functionality will be hidden. You can turn this off in the Preferences dialog.
.SH OPTIONS .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 .SH SEE ALSO
.B Homepage: .BR deluged(1),
http://www.deluge-torrent.org/ .BR deluge-web(1),
.BR deluge-console(1)
.SH AUTHOR .SH AUTHORS
This manual page was written by Andrew Resch <andrewresch@gmail.com>. .B Deluge Team: http://www.deluge-torrent.org
.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

View File

@ -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 .SH NAME
deluge-web - a bittorrent client ajax web interface deluge-web - a bittorrent client ajax web interface
@ -7,25 +7,28 @@ deluge-web - a bittorrent client ajax web interface
.B deluge-web [options] .B deluge-web [options]
.SH DESCRIPTION .SH DESCRIPTION
.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
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
.P .P
The default password is 'deluge'.
.SH OPTIONS .SH OPTIONS
See `deluge-web \-\-help` for common options, the web specific options are: .SS General Options
.TP .TP
.B -b BASE, --base=BASE .BI -c\ path \fR,\ \fB--config= path
Set the base path that the ui is running on (proxying) 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 .TP
.B -f, --fork .B -f, --fork
Fork the web interface process into the background Fork the web interface process into the background
.TP .TP
.B -i INTERFACE, --interface=INTERFACE .BI -i\ ip_address \fR,\ \fB--interface= ip_address
Binds the webserver to a specific IP address Binds the webserver to a specific IP address
.TP .TP
.B -p PORT, --port=PORT .BI -p\ port \fR,\ \fB--port= port
Sets the port to be used for the webserver Sets the port to be used for the webserver
.TP .TP
.B --profile .B --profile
@ -37,12 +40,30 @@ Forces the webserver to disable ssl
.B --ssl .B --ssl
Forces the webserver to use ssl Forces the webserver to use ssl
.SH SEE ALSO .SS Logging Options
.B Homepage: .TP
http://www.deluge-torrent.org/ .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 .SS Help Options
This manual page was written by Damien Churchill <damoxc@gmail.com>. .TP
.br .B -v, --version
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 Show program's version number and exit.
.br .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

View File

@ -1,54 +1,58 @@
.TH DELUGE 1 "January 2099" "1.3.900-dev" .TH DELUGE 1 "January 2099" "2.0-dev"
.SH NAME .SH NAME
deluge - a bittorrent client deluge - a bittorrent client
.SH SYNOPSIS .SH SYNOPSIS
.B deluge [options] [torrent] .B deluge [options]
.RI [ torrent-file\fR]
.SH DESCRIPTION .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. Deluge utilizes a client/server model, with 'deluged' being the daemon process and 'deluge' being used to launch a user-interface.
.br
.P .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 '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 .SH OPTIONS
.SS General Options
.TP .TP
.I [torrent] .BI -c\ path \fR,\ \fB--config= path
List of ".torrent" files to add to the download queue. Set the config directory location.
.SS UI Options
.TP .TP
.I --version .BI -u\ ui \fR,\ \fB--ui= ui
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
The UI that you wish to launch, current options include: gtk, web or console The UI that you wish to launch, current options include: gtk, web or console
.TP .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 Output to designated logfile instead of stdout
.TP .TP
.I -L LOGLEVEL, --loglevel=LOGLEVEL .BI -L\ loglevel \fR,\ \fB--loglevel= loglevel
Set the log level (default is error): none, info, warning, error, critical, debug Set the log level (default is error):
.B none, info, warning, error, critical, debug
.TP .TP
.I -q --quiet .B -q, --quiet
Sets the log level to 'none', this is the same as `\-L none` Sets the log level to 'none', same as `\-L none`
.SS Help Options
.TP .TP
.I -s DEFAULT_UI, --set-default-ui=DEFAULT_UI .B -v, --version
Sets the default UI to be run when no UI is specified Show program's version number and exit.
.TP
.B -h, --help
Show help message and exit.
.SH SEE ALSO .SH SEE ALSO
.B Homepage: .BR deluged(1),
http://www.deluge-torrent.org/ .BR deluge-web(1),
.BR deluge-console(1)
.SH AUTHOR .SH AUTHORS
This manual page was written by Andrew Resch <andrewresch@gmail.com>. .B Deluge Team: http://www.deluge-torrent.org
.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

View File

@ -1,4 +1,4 @@
.TH DELUGED 1 ""January 2099" "1.3.900-dev" .TH DELUGED 1 ""January 2099" "2.0-dev"
.SH NAME .SH NAME
deluged - a bittorrent client daemon deluged - a bittorrent client daemon
@ -7,54 +7,57 @@ deluged - a bittorrent client daemon
.B deluged [options] .B deluged [options]
.SH DESCRIPTION .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. Deluge utilizes a client/server model, with 'deluged' being the daemon process and 'deluge' being used to launch a user-interface.
.br
.P .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, '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 .SH OPTIONS
.SS General Options
.TP .TP
.I --version .BI -c\ path \fR,\ \fB--config= path
Show program's version number and exit. Set the config directory location.
.SS Daemon Options
.TP .TP
.I -h, --help .BI -p\ port \fR,\ \fB--port= port
Show this help message and exit.
.TP
.I -p PORT, --port=PORT
Port daemon will listen on, default is 58846 Port daemon will listen on, default is 58846
.TP .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 Interface daemon will listen for bittorrent connections on, this should be an IP address
.TP .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 Interface daemon will listen for UI connections on, this should be an IP address
.TP .TP
.I -d, --do-not-daemonize .B -d, --do-not-daemonize
Do not daemonize Do not daemonize
.TP .TP
.I -c CONFIG, --config=CONFIG .BI -P\ file \fR,\ \fB--pidfile= file
Sets the configuration path. Use pidfile to store process id
.SS Logging Options
.TP .TP
.I -l LOGFILE, --logfile=LOGFILE .BI -l\ file \fR,\ \fB--logfile= file
Output to designated logfile instead of stdout Output to designated logfile instead of stdout
.TP .TP
.I -P PIDFILE, --pidfile=PIDFILE .BI -L\ loglevel \fR,\ \fB--loglevel= loglevel
Use pidfile to store process id Set the log level (default is error):
.B none, info, warning, error, critical, debug
.TP .TP
.I -L LOGLEVEL, --loglevel=LOGLEVEL .B -q, --quiet
Set the log level (default is error): none, info, warning, error, critical, debug Sets the log level to 'none', same as `\-L none`
.SS Help Options
.TP .TP
.I -q --quiet .B -v, --version
Sets the log level to 'none', this is the same as `\-L none` Show program's version number and exit.
.TP
.B -h, --help
Show help message and exit.
.SH SEE ALSO .SH SEE ALSO
.B Homepage: .BR deluge(1),
http://www.deluge-torrent.org/ .BR deluge-web(1),
.BR deluge-console(1)
.SH AUTHOR .SH AUTHORS
This manual page was written by Andrew Resch <andrewresch@gmail.com>. .B Deluge Team: http://www.deluge-torrent.org
.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