deluge.ui.console.commands package

Submodules

deluge.ui.console.commands.add module

class deluge.ui.console.commands.add.Command

Bases: deluge.ui.console.main.BaseCommand

Add a torrent

complete(line)
handle(*args, **options)
option_list = (<Option at 0x7fb147f00b48: -p/--path>,)
usage = 'Usage: add [-p <download-folder>] <torrent-file> [<torrent-file> ...]\n <torrent-file> arguments can be file paths, URLs or magnet uris'

deluge.ui.console.commands.cache module

class deluge.ui.console.commands.cache.Command

Bases: deluge.ui.console.main.BaseCommand

Show information about the disk cache

handle(*args, **options)
usage = 'Usage: cache'

deluge.ui.console.commands.config module

class deluge.ui.console.commands.config.Command

Bases: deluge.ui.console.main.BaseCommand

Show and set configuration values

complete(text)
handle(*args, **options)
option_list = (<Option at 0x7fb147603ef0: -s/--set>,)
usage = 'Usage: config [key1 [key2 ...]]"\n config --set key value'
deluge.ui.console.commands.config.atom(next, token)

taken with slight modifications from http://effbot.org/zone/simple-iterator-parser.htm

deluge.ui.console.commands.config.simple_eval(source)

evaluates the ‘source’ string into a combination of primitive python objects taken from http://effbot.org/zone/simple-iterator-parser.htm

deluge.ui.console.commands.connect module

class deluge.ui.console.commands.connect.Command

Bases: deluge.ui.console.main.BaseCommand

Connect to a new deluge server.

handle(host='127.0.0.1:58846', username='', password='', **options)
usage = 'Usage: connect <host[:port]> <username> <password>'

deluge.ui.console.commands.debug module

class deluge.ui.console.commands.debug.Command

Bases: deluge.ui.console.main.BaseCommand

Enable and disable debugging

complete(text)
handle(state='', **options)
usage = 'Usage: debug [on|off]'

deluge.ui.console.commands.gui module

class deluge.ui.console.commands.gui.Command

Bases: deluge.ui.console.main.BaseCommand

Exit this mode and go into the more ‘gui’ like mode

handle(*args, **options)
interactive_only = True
usage = 'Usage: gui'

deluge.ui.console.commands.halt module

class deluge.ui.console.commands.halt.Command

Bases: deluge.ui.console.main.BaseCommand

Shutdown the deluge server

handle(*args, **options)
usage = 'Usage: halt'

deluge.ui.console.commands.help module

class deluge.ui.console.commands.help.Command

Bases: deluge.ui.console.main.BaseCommand

displays help on other commands

complete(line)
handle(*args, **options)
usage = 'Usage: help [command]'

deluge.ui.console.commands.info module

class deluge.ui.console.commands.info.Command

Bases: deluge.ui.console.main.BaseCommand

Show information about the torrents

complete(line)
handle(*args, **options)
option_list = (<Option at 0x7fb14748b560: -v/--verbose>, <Option at 0x7fb14748b5a8: -d/--detailed>, <Option at 0x7fb14748b5f0: -s/--state>, <Option at 0x7fb14748b638: --sort>, <Option at 0x7fb14748b680: --sort-reverse>)
show_file_info(torrent_id, status)
show_info(torrent_id, status, verbose=False, detailed=False)

Writes out the torrents information to the screen.

Format depends on switches given.

show_peer_info(torrent_id, status)
sort_help = 'sort items. Possible keys: state, download_location, tracker_host, tracker_status, next_announce, name, total_size, progress, num_seeds, total_seeds, num_peers, total_peers, eta, download_payload_rate, upload_payload_rate, ratio, distributed_copies, num_pieces, piece_length, total_done, files, file_priorities, file_progress, peers, is_seed, is_finished, active_time, seeding_time'
usage = 'Usage: info [-v | -d | -s <state>] [<torrent-id> [<torrent-id> ...]]\n You can give the first few characters of a torrent-id to identify the torrent.\n info * will list all torrents.\n\n Tab Completion (info *pattern*<tab>):\n | First press of <tab> will output up to 15 matches;\n | hitting <tab> a second time, will print 15 more matches;\n | and a third press will print all remaining matches.\n | (To modify behaviour of third <tab>, set `third_tab_lists_all` to False)'
deluge.ui.console.commands.info.format_progressbar(progress, width)

Returns a string of a progress bar.

Parameters:progress – float, a value between 0-100
Returns:str, a progress bar based on width
deluge.ui.console.commands.info.format_time(seconds)

deluge.ui.console.commands.manage module

class deluge.ui.console.commands.manage.Command

Bases: deluge.ui.console.main.BaseCommand

Show and manage per-torrent options

complete(line)
handle(*args, **options)
option_list = (<Option at 0x7fb1468a9ea8: -s/--set>,)
usage = 'Usage: manage <torrent-id> [<key1> [<key2> ...]]\n manage <torrent-id> --set <key> <value>'

deluge.ui.console.commands.move module

class deluge.ui.console.commands.move.Command

Bases: deluge.ui.console.main.BaseCommand

Move torrents’ storage location

complete(line)
handle(*args, **options)
usage = 'Usage: move <torrent-id> [<torrent-id> ...] <path>'

deluge.ui.console.commands.pause module

class deluge.ui.console.commands.pause.Command

Bases: deluge.ui.console.main.BaseCommand

Pause a torrent

complete(line)
handle(*args, **options)
usage = 'Usage: pause [ * | <torrent-id> [<torrent-id> ...] ]'

deluge.ui.console.commands.plugin module

class deluge.ui.console.commands.plugin.Command

Bases: deluge.ui.console.main.BaseCommand

Manage plugins with this command

complete(line)
handle(*args, **options)
option_list = (<Option at 0x7fb1467487e8: -l/--list>, <Option at 0x7fb1467488c0: -s/--show>, <Option at 0x7fb146748908: -e/--enable>, <Option at 0x7fb146748950: -d/--disable>, <Option at 0x7fb146748998: -r/--reload>, <Option at 0x7fb1467489e0: -i/--install>)
usage = 'Usage: plugin [ -l | --list ]\n plugin [ -s | --show ]\n plugin [ -e | --enable ] <plugin-name>\n plugin [ -d | --disable ] <plugin-name>\n plugin [ -i | --install ] <plugin-file>\n plugin [ -r | --reload]'

deluge.ui.console.commands.quit module

class deluge.ui.console.commands.quit.Command

Bases: deluge.ui.console.main.BaseCommand

Exit from the client.

aliases = ['exit']
handle(*args, **options)
interactive_only = True

deluge.ui.console.commands.recheck module

class deluge.ui.console.commands.recheck.Command

Bases: deluge.ui.console.main.BaseCommand

Forces a recheck of the torrent data

complete(line)
handle(*args, **options)
usage = 'Usage: recheck [ * | <torrent-id> [<torrent-id> ...] ]'

deluge.ui.console.commands.resume module

class deluge.ui.console.commands.resume.Command

Bases: deluge.ui.console.main.BaseCommand

Resume a torrent

complete(line)
handle(*args, **options)
usage = 'Usage: resume [ * | <torrent-id> [<torrent-id> ...] ]'

deluge.ui.console.commands.rm module

class deluge.ui.console.commands.rm.Command

Bases: deluge.ui.console.main.BaseCommand

Remove a torrent

aliases = ['del']
complete(line)
handle(*args, **options)
option_list = (<Option at 0x7fb146671908: --remove_data>,)
usage = 'Usage: rm <torrent-id>'

deluge.ui.console.commands.status module

class deluge.ui.console.commands.status.Command

Bases: deluge.ui.console.main.BaseCommand

Shows a various status information from the daemon.

handle(*args, **options)
option_list = (<Option at 0x7fb1466eae60: -r/--raw>, <Option at 0x7fb1466ea830: -n/--no-torrents>)
print_status()
usage = 'Usage: status [-r] [-n]'

deluge.ui.console.commands.update-tracker module

class deluge.ui.console.commands.update_tracker.Command

Bases: deluge.ui.console.main.BaseCommand

Update tracker for torrent(s)

aliases = ['reannounce']
complete(line)
handle(*args, **options)
usage = 'Usage: update_tracker [ * | <torrent-id> [<torrent-id> ...] ]'

Module contents