diff --git a/docs/build/html/_sources/core/index.txt b/docs/build/html/_sources/core/index.txt
index f276a1b2d..1a45bd549 100644
--- a/docs/build/html/_sources/core/index.txt
+++ b/docs/build/html/_sources/core/index.txt
@@ -1,2 +1,6 @@
The Deluge Core
-===============
\ No newline at end of file
+===============
+
+.. toctree::
+
+ DelugeRPC
\ No newline at end of file
diff --git a/docs/build/html/_sources/core/rpc.txt b/docs/build/html/_sources/core/rpc.txt
new file mode 100644
index 000000000..8c25f874c
--- /dev/null
+++ b/docs/build/html/_sources/core/rpc.txt
@@ -0,0 +1,104 @@
+Deluge RPC
+==========
+---------------
+Message Formats
+---------------
+DelugeRPC is a protocol used for daemon/client communication. There are four
+types of messages involved in the protocol: RPC Request, RPC Response,
+RPC Error and Event. All messages are zlib compressed rencoded strings and
+their data formats are detailed below.
+
+"""""""""""
+RPC Request
+"""""""""""
+This message is created and sent by the client to the server requesting that a
+remote method be called. Multiple requests can be bundled in a list.
+
+**[[request_id, method, [args], {kwargs}], ...]**
+
+**request_id** (int)
+ An integer determined by the client that is used in replies from the server.
+ This is used to ensure the client knows which request the data is in
+ response to. Another alternative would be to respond in the same order the
+ requests come in, but this could cause lag if an earlier request takes
+ longer to process.
+
+**method** (str)
+ The name of the remote method to call. This name can be in dotted format to
+ call other objects or plugins methods.
+
+**args** (list)
+ The arguments to call the method with.
+
+**kwargs** (dict)
+ The keyword arguments to call the method with.
+
+""""""""""""
+RPC Response
+""""""""""""
+This message is created and sent in response to a RPC Request from a client. It
+will hold the return value of the requested method call. In the case of an
+error, a RPC Error message will be sent instead.
+
+**[message_type, request_id, [return_value]]**
+
+**message_type** (int)
+ This will be a RPC_RESPONSE type id. This is used on the client side to
+ determine what kind of message is being received from the daemon.
+
+**request_id** (int)
+ The request_id is the same as the one sent by the client in the initial
+ request. It used on the client side to determine what message this is in
+ response to.
+
+**return_value** (list)
+ The return value of the method call.
+
+"""""""""
+RPC Error
+"""""""""
+This message is created in response to an error generated while processing a
+RPC Request and will serve as a replacement for a RPC Response message.
+
+**[message_type, request_id, exception_type, exception_msg, traceback]**
+
+**message_type** (int)
+ This will be a RPC_ERROR type id.
+
+**request_id** (int)
+ The request_id is the same as the one sent by the client in the initial
+ request.
+
+**exception_type** (str)
+ The type of exception raised.
+
+**exception_msg** (str)
+ The message as to why the exception was raised.
+
+**traceback** (str)
+ The traceback of the generated exception.
+
+"""""
+Event
+"""""
+This message is created by the daemon and sent to the clients without being in
+response to a RPC Request. Events are generally sent for changes in the
+daemon's state that the clients need to be made aware of.
+
+**[message_type, event_name, data]**
+
+**message_type** (int)
+ This will be a RPC_EVENT type id.
+
+**event_name** (str)
+ This is the name of the event being emitted by the daemon.
+
+**data** (list)
+ Additional data to be sent with the event. This is dependent upon the event
+ being emitted.
+
+----------
+Remote API
+----------
+
+TODO
\ No newline at end of file
diff --git a/docs/build/html/core/index.html b/docs/build/html/core/index.html
index c3a84fa7e..0fdaff74d 100644
--- a/docs/build/html/core/index.html
+++ b/docs/build/html/core/index.html
@@ -5,7 +5,7 @@
- The Deluge Core — deluge v1.2.0-dev documentation
+ The Deluge Core — Deluge v1.2.0-dev documentation
-
-
+
+
@@ -34,12 +34,12 @@
modules |
diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js
index 3a797cbb7..053aef1a3 100644
--- a/docs/build/html/searchindex.js
+++ b/docs/build/html/searchindex.js
@@ -1 +1 @@
-Search.setIndex({desctypes:{"0":"method","1":"function","2":"attribute","3":"class"},terms:{represent:7,all:1,mib:7,config_fil:1,func:1,get_pixmap:7,show:7,when:[1,4],overrid:4,fpeer:7,human:7,follow:1,disk:1,speed:7,paramet:[1,7],content:[0,1],onli:[1,7],ratio:7,monitor:1,easi:7,is_magnet:7,gtk:[0,6,3],readabl:7,set_item:1,param:1,should:[0,1],platform:7,window:[4,7],program:7,register_change_callback:1,bittorr:7,folder:7,save:1,local:7,take:1,liter:[1,7],"return":[1,7],string:[1,7],variou:[1,7],format:[1,7],fals:[1,7],initi:1,util:7,print:1,nov:0,get_item:1,like:0,daemon:4,register_set_funct:1,name:[1,7],anyth:1,docutil:[1,7],list:7,magnet:7,item:1,common:[0,7],have:1,contain:0,urn:7,create_magnet_uri:7,page:0,input_rang:1,certif:4,www:[],num_peer:7,some:1,direct:0,percentag:7,realli:1,fspeed:7,intern:1,signifi:1,connect:7,toctre:0,download:7,run:[1,4],simpl:7,config_dir:1,index:0,shown:7,total:7,space:7,is_url:7,someth:1,abl:4,below:1,per:7,your:[0,4],access:[1,4,7],written:1,version:[1,7],ftime:7,adapt:0,total_p:7,get_default_config_dir:7,output_vers:1,open_fil:7,metadata:7,core:[0,5],full:4,hash:7,kei:[1,4],pixmap:7,usag:[1,7],privat:4,free:7,"__setitem__":1,succeed:1,web:[0,4,3],dictionari:1,peer:7,path:[1,7],along:1,modifi:1,tue:0,valu:[1,4,7],open_url_in_brows:7,search:0,callback:1,convers:1,ssl:[3,4],rtype:1,via:4,similar:1,could:1,current:[1,7],torrent:7,base:[1,7],place:7,def:1,osx_check:7,dict:1,desktop:7,chang:1,timezon:7,infohash:7,apply_set_funct:1,load:1,control:1,rang:[1,7],configur:[3,1,4,7],simpli:1,is_ip:7,directli:1,within:7,modul:[0,1],"float":7,prefer:4,number:7,system:7,filenam:[1,7],initiliaz:1,set:1,done:1,org:7,owner:1,announc:7,open:7,"byte":7,unit:7,size:7,regex:7,differ:[1,4],fetch_url:7,span:[1,7],object:1,wai:[1,4],transfer:7,top:4,enabl:4,regist:1,add:4,least:0,sinc:[1,7],avail:7,type:[1,7],call:1,includ:7,which:[1,4],master:0,intend:4,valueerror:1,gib:7,"function":[1,7],from:7,consol:[0,2,3],option:7,form:7,fsize_b:7,su5225urmtueqldxqwrb2eqwn6kltykn:7,provid:7,convert:1,specifi:4,wish:4,decim:7,part:7,accept:1,newer:1,input:1,apply_al:1,line:1,given:7,"true":[1,7],than:1,those:1,must:1,info:7,none:[1,7],look:7,augment:1,whether:1,free_spac:7,second:7,windows_check:7,directori:[1,7],fpcnt:7,displai:7,can:[0,1],str:1,fdate:7,dec:7,root:0,fetch:7,vista_check:7,browser:7,pre:[1,7],files:7,would:1,conf:1,creat:[0,1,4,7],quickstart:0,"int":[1,7],get_default_download_dir:7,tabl:0,argument:1,indic:0,repres:7,twist:4,"default":[1,4,7],exist:7,file:[0,1,7],interfac:[0,4,3],need:1,revis:7,featur:4,check:7,get_vers:7,vista:7,encrypt:4,"__getitem__":1,want:[1,4],inform:4,allow:1,get:[1,7],fsize:7,same:[1,4],get_revis:7,note:1,how:4,epoch:7,other:4,bool:[1,7],build:7,fname:7,tupl:1,test:[1,7],you:[0,1,4],tracker:7,config:[0,1,7],complet:0,"23m":7,http:7,webserv:4,see:[1,4,7],less:1,after:1,what:1,keyerror:1,befor:1,mac:7,rais:1,two:7,thi:[0,1],date:7,kib:7,unless:1,"class":[1,7],serial:1,welcom:0,svn:7,sphinx:0,run_convert:1,framework:4,url:7,com:[],valid:7,filepath:7,delug:[0,1,2,3,4,5,6,7],uri:7,data:7,doe:[1,7],btih:7,extj:4,exampl:1,yatblog:[],determin:7,time:7,apply_now:1,built:4,egg:7,get_path_s:7,document:0},titles:["Welcome to Deluge’s documentation!","deluge.config","Deluge Console UI","Deluge’s Interfaces","Deluge Web UI","The Deluge Core","Deluge GTK UI","deluge.common"],modules:{"deluge.config":1,"deluge.common":7},descrefs:{"deluge.common":{is_ip:[7,1],get_pixmap:[7,1],get_default_download_dir:[7,1],fspeed:[7,1],fpeer:[7,1],get_revision:[7,1],is_url:[7,1],vista_check:[7,1],fetch_url:[7,1],open_file:[7,1],get_version:[7,1],fsize:[7,1],ftime:[7,1],get_default_config_dir:[7,1],open_url_in_browser:[7,1],get_path_size:[7,1],free_space:[7,1],windows_check:[7,1],fpcnt:[7,1],osx_check:[7,1],fdate:[7,1],create_magnet_uri:[7,1],is_magnet:[7,1]},"deluge.config.Config":{apply_set_functions:[1,0],apply_all:[1,0],config_file:[1,2],"__getitem__":[1,0],run_converter:[1,0],set_item:[1,0],load:[1,0],"__setitem__":[1,0],register_change_callback:[1,0],register_set_function:[1,0],save:[1,0],config:[1,2],get_item:[1,0]},"deluge.config":{Config:[1,3]}},filenames:["index","modules/config","interfaces/console","interfaces/index","interfaces/web","core/index","interfaces/gtk","modules/common"]})
\ No newline at end of file
+Search.setIndex({desctypes:{"0":"method","1":"class","2":"function","3":"attribute"},terms:{represent:8,all:[6,1],is_ip:8,four:6,follow:1,disk:1,dht:[],output_vers:1,privat:4,exception_typ:6,base64:[],readabl:8,send:[],program:8,sent:6,liter:[1,8],string:[6,1,8],fals:[1,8],util:8,stop_at_ratio:[],list:[6,8],upload:[],magnet:8,item:1,create_magnet_uri:8,rpc_respons:6,direct:0,second:8,download:8,config_dir:1,port:[],index:0,what:[6,1],repli:6,abl:4,access:[1,4,8],version:[1,8],"new":[],method:6,metadata:8,slot:[],full:4,hash:8,filter_dict:[],gener:6,get_health:[],rename_fil:[],path:[1,8],along:1,modifi:1,sinc:[1,8],valu:[6,1,4,8],open_url_in_brows:8,search:0,purpos:[],convers:1,get_download_r:[],queue:[],prior:[],osx_check:8,chang:[6,1],infohash:8,overrid:4,decim:8,appli:[],modul:[0,1],prefer:4,filenam:[1,8],initiliaz:1,api:[6,5],rename_fold:[],instal:[],total:8,establish:[],unit:8,regex:8,from:[6,8],would:[6,1],commun:6,regist:1,two:8,call:[6,1],type:[6,1,8],flag:[],accept:1,hold:6,cach:[],dot:6,must:1,none:[1,8],augment:1,can:[0,1,6],dec:8,root:0,fetch:8,def:1,control:1,defer:[],quickstart:0,process:6,get_default_download_dir:8,indic:0,want:[1,4],serial:1,multipl:6,filepath:8,anoth:6,add_torrent_url:[],how:4,set_item:1,instead:6,simpl:8,"23m":8,set_torrent_max_connect:[],get_filter_tre:[],max:[],lag:6,befor:1,mac:8,date:8,data:[6,8],attempt:[],add_torrent_magnet:[],caus:6,callback:1,su5225urmtueqldxqwrb2eqwn6kltykn:8,allow:1,enter:[],egg:8,order:6,config_fil:1,get_pixmap:8,move:[],rpc_event:6,paramet:[1,8],pixmap:8,monitor:1,set_torrent_track:[],gtk:[0,7,3],set_torrent_move_complet:[],platform:8,window:[4,8],bittorr:8,non:[],within:8,"return":[6,1,8],"__getitem__":1,auto:[],set_torrent_auto_manag:[],initi:[6,1],framework:4,new_fold:[],nov:0,register_set_funct:1,name:[6,1,8],anyth:1,config:[0,1,8],stop_ratio:[],request_id:6,delugerpc:[0,5,6],higher:[],event_nam:6,extj:4,replac:6,realli:1,filedump:[],connect:8,todo:6,event:[6,5],shown:8,space:8,payload:[],content:[0,1],adapt:0,print:1,get_default_config_dir:8,unaccess:[],sphinx:0,earlier:6,given:8,free:8,"__setitem__":1,base:[1,8],rencod:6,dictionari:1,org:8,"byte":8,could:[6,1],traceback:6,set_torrent_remove_at_ratio:[],set_config:[],filter:[],get_config:[],place:8,timezon:8,first:[],rang:[1,8],directli:1,onc:[],number:8,tier:[],done:1,messag:[6,5],owner:1,open:8,add_torrent_fil:[],size:8,prioriti:[],differ:[1,4],fetch_url:8,top:4,get_session_st:[],system:8,least:0,get_upload_r:[],master:0,interfac:[0,4,3],listen:[],consol:[0,2,3],option:8,specifi:4,part:8,than:1,serv:6,kind:6,keyword:6,remot:[6,5],free_spac:8,remov:[],rate:[],fpcnt:8,str:[6,1],is_magnet:8,torrent:8,recheck:[],browser:8,pre:[1,8],test_listen_port:[],arg:6,argument:[6,1],set_torrent_file_prior:[],have:1,tabl:0,need:[6,1],built:4,inform:4,mib:8,fsize:8,get_revis:8,note:1,without:6,take:[6,1],which:[6,1,4],fsize_b:8,unless:1,get_stat:[],object:[6,1],compress:6,pair:[],"class":[1,8],apply_al:1,url:8,urn:8,request:[6,5],uri:8,doe:[1,8],btih:8,set_torrent_max_upload_slot:[],determin:[6,8],apply_now:1,get_enabled_plugin:[],get_torrents_statu:[],show:8,upload_plugin:[],session:[],is_url:8,priv:[],involv:6,current:[1,8],onli:[1,8],ratio:8,configur:[3,1,4,8],activ:[],state:6,should:[0,1],dict:[6,1],get_num_connect:[],get_listen_port:[],get_dht_nod:[],folder:8,local:8,count:[],get_vers:8,variou:[1,8],get:[1,8],stop:[],ssl:[3,4],enabl:4,provid:8,fpeer:8,common:[0,8],contain:0,respond:6,certif:4,set:1,fspeed:8,delug:[0,1,2,3,4,5,6,7,8],signifi:1,respons:[6,5],awar:6,statu:[],someth:1,listen_interfac:[],set_torrent_prioritize_first_last:[],written:1,ftime:8,altern:6,kei:[1,4],vista_check:8,succeed:1,come:6,tue:0,addit:6,last:[],rtype:1,rescan_plugin:[],rpc_error:6,com:[],load:1,simpli:1,point:[],rescan:[],set_torrent_move_completed_path:[],header:[],rpc:[6,5],been:[],insuffici:[],valueerror:1,plugin_data:[],files:8,fire:[],convert:1,ani:[],func:1,those:1,"case":6,look:8,exception_msg:6,zlib:6,windows_check:8,"while":6,error:[6,5],get_available_plugin:[],"default":[1,4,8],kwarg:6,set_torrent_stop_ratio:[],conf:1,incom:[],revis:8,"_statu":[],welcom:0,receiv:6,get_status_kei:[],same:[6,1,4],binari:[],epoch:8,document:0,complet:0,http:8,webserv:4,see:[1,4,8],upon:6,get_cache_statu:[],rais:[6,1],apply_set_funct:1,kib:8,resume_all_torr:[],exampl:1,thi:[0,1,6],plugin:6,show_zero_hit:[],protocol:6,paus:[],less:1,hide_cat:[],via:4,human:8,sidebar:[],speed:8,web:[0,4,3],run_convert:1,easi:8,except:6,param:1,desktop:8,add:4,valid:8,register_change_callback:1,input:1,save:1,build:8,fname:8,xmlrpc:[],format:[6,1,5,8],read:[],piec:[],set_torrent_max_download_spe:[],know:6,get_item:1,daemon:[6,4],like:0,docutil:[1,8],get_session_statu:[],integ:6,server:6,page:0,depend:6,"function":[1,8],www:[],num_peer:8,set_torrent_max_upload_spe:[],some:1,percentag:8,intern:1,toctre:0,get_torr:[],save_dht_st:[],per:8,tracker:8,total_p:8,core:[0,5],set_torrent_stop_at_ratio:[],run:[1,4],usag:[1,8],peer:8,after:1,plugin_fil:[],side:6,includ:8,input_rang:1,client:6,"float":8,encod:[],ensur:6,announc:8,your:[0,4],manag:[],span:[1,8],wai:[1,4],transfer:8,force_recheck:[],why:6,avail:8,start:[],return_valu:6,gib:8,resum:[],pause_all_torr:[],torrent_id:[],form:8,forc:[],tupl:1,bundl:6,message_typ:6,keyerror:1,link:[],newer:1,renam:[],line:1,"true":[1,8],info:8,made:6,possibl:[],whether:1,wish:4,displai:8,below:[6,1],fdate:8,similar:1,emit:6,featur:4,creat:[0,1,8,4,6],"int":[6,1,8],get_config_valu:[],repres:8,twist:4,exist:8,file:[0,1,8],check:8,vista:8,encrypt:4,set_torrent_opt:[],when:[1,4],detail:6,field:[],other:[6,4],bool:[1,8],test:[1,8],you:[0,1,4],node:[],intend:4,svn:8,open_fil:8,longer:6,directori:[1,8],yatblog:[],time:8,get_path_s:8},titles:["Welcome to Deluge’s documentation!","deluge.config","Deluge Console UI","Deluge’s Interfaces","Deluge Web UI","The Deluge Core","Deluge RPC","Deluge GTK UI","deluge.common"],modules:{"deluge.config":1,"deluge.common":8},descrefs:{"deluge.config":{Config:[1,1]},"deluge.common":{is_ip:[8,2],get_pixmap:[8,2],get_default_download_dir:[8,2],fspeed:[8,2],fpeer:[8,2],get_revision:[8,2],is_url:[8,2],vista_check:[8,2],fetch_url:[8,2],open_file:[8,2],get_version:[8,2],fsize:[8,2],ftime:[8,2],get_default_config_dir:[8,2],open_url_in_browser:[8,2],get_path_size:[8,2],free_space:[8,2],windows_check:[8,2],fpcnt:[8,2],osx_check:[8,2],fdate:[8,2],create_magnet_uri:[8,2],is_magnet:[8,2]},"deluge.config.Config":{apply_set_functions:[1,0],apply_all:[1,0],config_file:[1,3],"__getitem__":[1,0],run_converter:[1,0],set_item:[1,0],load:[1,0],"__setitem__":[1,0],register_change_callback:[1,0],register_set_function:[1,0],save:[1,0],config:[1,3],get_item:[1,0]}},filenames:["index","modules/config","interfaces/console","interfaces/index","interfaces/web","core/index","core/rpc","interfaces/gtk","modules/common"]})
\ No newline at end of file