mirrors/deluge
1
0
Fork 0
mirror of https://git.deluge-torrent.org/deluge synced 2025-04-20 11:35:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update man pages to reflect ui arg changes

Browse source 
- Also fixup help output details
This commit is contained in:
Calum Lind 2017-03-13 23:34:41 +00:00
parent 8232505961
commit 50c476c41d
10 changed files with 223 additions and 134 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
deluge/ui/console/cmdline/commands/connect.py
View file

@ -21,7 +21,7 @@ log = logging.getLogger(__name__)
class Command(BaseCommand):
"""Connect to a new deluge server."""
"""Connect to a new deluge server"""
usage = _('Usage: connect <host[:port]> [<username>] [<password>]')

2
deluge/ui/console/cmdline/commands/help.py
View file

@ -22,7 +22,7 @@ log = logging.getLogger(__name__)
class Command(BaseCommand):
"""displays help on other commands"""
"""Displays help on other commands"""
def add_arguments(self, parser):
parser.add_argument('commands', metavar='<command>', nargs='*', help=_('One or more commands'))

2
deluge/ui/console/cmdline/commands/quit.py
View file

@ -18,7 +18,7 @@ from . import BaseCommand
class Command(BaseCommand):
"""Exit the client."""
"""Exit the client"""
aliases = ['exit']
interactive_only = True

2
deluge/ui/console/cmdline/commands/status.py
View file

@ -23,7 +23,7 @@ log = logging.getLogger(__name__)
class Command(BaseCommand):
"""Shows a various status information from the daemon."""
"""Shows various status information from the daemon"""
def add_arguments(self, parser):
parser.add_argument('-r', '--raw', action='store_true', default=False, dest='raw',

15
deluge/ui/console/console.py
View file

@ -70,11 +70,14 @@ class Console(UI):
group = self.parser.add_argument_group(_('Console Options'),
_('These daemon connect options will be '
'used for commands, or if console ui autoconnect is enabled.'))
group.add_argument('-d', '--daemon', dest='daemon_addr', required=False, default='127.0.0.1')
group.add_argument('-p', '--port', dest='daemon_port', type=int, required=False, default='58846')
group.add_argument('-U', '--username', dest='daemon_user', required=False)
group.add_argument('-P', '--password', dest='daemon_pass', required=False)
group.add_argument('-d', '--daemon', metavar='<ip_addr>', dest='daemon_addr',
help=_('Deluge daemon IP address to connect to (default 127.0.0.1)'), default='127.0.0.1')
group.add_argument('-p', '--port', metavar='<port>', dest='daemon_port', type=int,
help=_('Deluge daemon port to connect to (default 58846)'), default='58846')
group.add_argument('-U', '--username', metavar='<user>', dest='daemon_user',
help=_('Deluge daemon username to use when connecting'))
group.add_argument('-P', '--password', metavar='<pass>', dest='daemon_pass',
help=_('Deluge daemon password to use when connecting'))
# To properly print help message for the console commands ( e.g. deluge-console info -h),
# we add a subparser for each command which will trigger the help/usage when given
from deluge.ui.console.parser import ConsoleCommandParser # import here because (see top)
@ -84,7 +87,7 @@ class Console(UI):
DelugeTextHelpFormatter(prog, max_help_position=33, width=90))
self.parser.subparser = self.console_parser
self.console_parser.base_parser = self.parser
subparsers = self.console_parser.add_subparsers(title=_('Console commands'), help=_('Description'),
subparsers = self.console_parser.add_subparsers(title=_('Console Commands'), help=_('Description'),
description=_('The following console commands are available:'),
metavar=_('Command'), dest='command')
from deluge.ui.console import UI_PATH # Must import here

88
docs/man/deluge-console.1
View file

@ -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, --quiet
Sets the log level to 'none', same as `\-L none`
.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, --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

53
docs/man/deluge-gtk.1
View file

@ -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, --quiet
Sets the log level to 'none', same as `\-L none`
.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, --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

85
docs/man/deluge-web.1
View file

@ -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
.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 -f, --fork
Fork the web interface process into the background
.TP
.BI -i\ ip_address \fR,\ \fB--interface= ip_address
Binds the webserver to a specific IP address
.TP
.BI -p\ port \fR,\ \fB--port= port
Sets the port to be used for the webserver
.TP
.B --profile
Profile the webserver code
.TP
.B --no-ssl
Forces the webserver to disable ssl
.TP
.B --ssl
.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 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, --quiet
Sets the log level to 'none', same as `\-L none`
.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, --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

49
docs/man/deluge.1
View file

@ -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, --quiet
Sets the log level to 'none', same as `\-L none`
.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, --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

59
docs/man/deluged.1
View file

@ -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, --quiet
Sets the log level to 'none', same as `\-L none`
.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, --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