[X2serv-cvs] CVS: x2/doc chanformat.txt,NONE,1.1
Brought to you by:
sirvulcan
From: Alex S. <ru...@us...> - 2001-03-21 08:47:19
|
Update of /cvsroot/x2serv/x2/doc In directory usw-pr-cvs1:/tmp/cvs-serv26655 Added Files: chanformat.txt Log Message: Documented the channel data file system --- NEW FILE --- This is a quick attempt to document the X2 5.1 file formats. The channel system makes use of the following files and directories: chan.dat - file - a flat list of channel names, one per line. CHANS/ - directory - In it each of the channel configs are stored. CHANS/CHANNAME - file - There is a file in the CHANS/ directory for every registered channel. The filename is the uppercase name of the channel (without the #) tmp/ - directory - This directory is where x2 does its scratchwork x2 will fail if its not writable. chan.dat: --------- One channel per line, case is irrelevent (i think) includes the #. Basically all this file is used for anymore is to get a list of files to open in the CHANS/ directory. (they are uppercased and the # removed automatically) CHANS/CHANNAME: --------------- Each line in the channel data files has a key, and a string. This was done to keep it somewhat human readable, because from time to time its necessary to modify a channel by hand. The keys are as follows: VERSION - describes what version this channel file is. When chagnes are made, x2 will "detect" old files with this and upgrade them seamlessly. CHANNEL - This is the name of the channel, with # and capitalized as desired. TOPIC - This is the default topic of the chan EMAIL - This is the channel owner's email address DESCRIPTION - This is the description of the channel WEB - The URL (from .set) thats sent to joining folks MODES - These are the enforced modes, both positive and negitive enforcements. Modes not listed as either + or - are completely ignored in the channel. SETTINGS - This is the settings from .set in int form. topicfreq,strictop,autoop,protect,enfmodes,bantimeout,voice, userinfo,inchan,nodelete and some reserved spots. Deleting this line (should) reset the channel to default state. LASTVISITED - The last time an owner or coowner was in the channel. 0 for "now". Its stored in the unixtime 32bit int format. REGEDBY - The nick of the IRCOP who registered the channel, and timestamp. HANDLE - A user definition format is: handle levelchar autoop lastseen password userinfo K - A host-masK for the previously listed handle's un-password-protected use. BAN - A "lamer" format is: timestamp ? hostmask arbitrary text It is required that VERSION and CHANNEL come first, in that order. The rest of the order is (i think) unimportant. |