[irc/evilnet/x3.git] / UPGRADE

**************************************
***        X3 IRC Services         ***
**************************************
*** IMPORTANT UPGRADE INSTRUCTIONS ***
**************************************
Generally version-to-version upgrades can be done without trouble. The code
for the most part aims to be backward-compatable. You should back up the .db
files first (but you back those up anyway, dont you?)

Sometimes when upgrading, some commands may have changed. When you upgrade
your .db file may not have command bindings for new commands added.
There is now a command to assist with this: rebindall.
If you don't have the 'rebindall' command bound, first bind it:
    /msg O3 bind o3 * *modcmd.*
Then, after any upgrade, or after adding modules, or changing command effecting settings
such as 'email', you can simply run:
    /msg O3 rebindall
to ensure you have all the latest commands bound on all services.

You may do: 'bind nick * *module.*' to re-bind ALL builtin commands on a givin module,
(chanserv, opserv, nickserv, modcmd, etc) if you prefer to update them individually
(if you unbind some default commands, and want them to stay unbound).  
Alternatively you can edit the .db by hand or using the 'bind' command on irc. 
NOTE: You will need to shut down x3 gracefully (using the die or restart commands)
after binding in order for 'set' and 'uset' subcommand changes to function properly since
the listings are cached.
Commit	Line	Data
c8ca69a0	1	**************************************
ca3486a2	2	* X3 IRC Services *
c8ca69a0	3	**************************************
	4	* IMPORTANT UPGRADE INSTRUCTIONS *
	5	**************************************
2f21ad2c R	6	Generally version-to-version upgrades can be done without trouble. The code
	7	for the most part aims to be backward-compatable. You should back up the .db
	8	files first (but you back those up anyway, dont you?)
1136f709	9
2f21ad2c R	10	Sometimes when upgrading, some commands may have changed. When you upgrade
	11	your .db file may not have command bindings for new commands added.
	12	There is now a command to assist with this: rebindall.
c8273589	13	If you don't have the 'rebindall' command bound, first bind it:
	14	/msg O3 bind o3 * modcmd.
	15	Then, after any upgrade, or after adding modules, or changing command effecting settings
	16	such as 'email', you can simply run:
	17	/msg O3 rebindall
	18	to ensure you have all the latest commands bound on all services.
	19
	20	You may do: 'bind nick * module.' to re-bind ALL builtin commands on a givin module,
	21	(chanserv, opserv, nickserv, modcmd, etc) if you prefer to update them individually
	22	(if you unbind some default commands, and want them to stay unbound).
c8ca69a0	23	Alternatively you can edit the .db by hand or using the 'bind' command on irc.
c8273589	24	NOTE: You will need to shut down x3 gracefully (using the die or restart commands)
c8ca69a0	25	after binding in order for 'set' and 'uset' subcommand changes to function properly since
c8273589	26	the listings are cached.
c8273589	27