help.txt 87 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012
  1. ::+ban
  2. ### $b+ban$b <hostmask> [channel] [%%<XdXhXm>] [comment]
  3. Adds a ban to the list of bans stored on the bot, with optional comment and
  4. ban time. This ban is stored with your handle as the creator, and will be
  5. in effect for every channel if no channel is specified. Prefixing a comment
  6. with '*' will set the ban sticky. Prefixing a comment with '@' will make the
  7. comment only visible within the bot, and not used as the ban reason. Ban
  8. time has to be expressed in days, hours, and/or minutes.
  9. See also: bans, -ban, stick, unstick
  10. ::+chan
  11. ### $b+chan$b <channel> [options]
  12. Adds a channel to the bot's channel list. If options are specified, the
  13. channel will be configured with the options.
  14. See also: -chan, chanset, chaninfo
  15. ::+chrec
  16. ### $b+chrec$b <handle> [channel]
  17. Adds an empty channel record for the specified user so that channel lastons
  18. and info lines can be saved. No flags are associated with the channel.
  19. See also: -chrec, chattr%{+n}, +chan, -chan%{-}
  20. ::+exempt
  21. ### $b+exempt$b <hostmask> [channel] [%%<XdXhXm>] [comment]
  22. Adds an exempt to the list of exempts stored on the bot, with optional
  23. comment and exempt time. This exempt is stored with your handle as the
  24. creator, and will be in effect for every channel if no channel is specified.
  25. Exempt time has to be expressed in days, hours, and/or minutes.
  26. See also: exempts, -exempt, stick, unstick
  27. ::+host
  28. ### $b+host$b [handle] <hostmask> [anotherhostmask] ...
  29. Adds a hostmask to a user's user record. Hostmasks are used to identify your
  30. handle on IRC. If a handle is not specified, the hostmask will be added to
  31. YOUR user record. List as many hosts as wanted.
  32. See also: -host, clearhosts
  33. ::+ignore
  34. ### $b+ignore$b <hostmask> [%%<XdXhXm>] [comment]
  35. Adds an ignore to the list of ignores stored on the bot, with optional
  36. comment and ignore time. This ignore is stored with your handle as the
  37. creator. Ignore time has to be expressed in days, hours, and/or minutes.
  38. See also: -ignore, ignores
  39. ::+invite
  40. ### $b+invite$b <hostmask> [channel] [%%<XdXhXm>] [comment]
  41. Adds an invite to the list of invites stored on the bot, with optional
  42. comment and invite time. This invite is stored with your handle as the
  43. creator, and will be in effect for every channel if no channel is specified.
  44. Invite time has to be expressed in days, hours, and/or minutes.
  45. See also: invites, -invite, stick, unstick
  46. ::+user
  47. ### $b+user$b <handle> [hostmask] [anotherhostmask] ...
  48. Creates a new user record for the handle given. The new user record will
  49. have no flags, an optional hostmask, and a random pass/secpass.
  50. List as many hosts as needed.
  51. See also: -user, +host, -host, cleearhosts%{+ni}, newleaf%{-}
  52. ::-ban
  53. ### $b-ban$b <banmask or number> [channel]
  54. Removes the specified ban from the list of bans stored on the bot. You may
  55. also reference the ban by the number shown by the 'bans' command.
  56. See also: bans, +ban, stick, unstick
  57. :hub:-bot
  58. ### $b-bot$b <bot>
  59. This is exactly the same as $b'%d-user'$b (it removes a user record). It is
  60. included for convenience.
  61. See also: +user, -user%{+n}, newleaf%{-}
  62. ::-chan
  63. ### $b-chan$b <channel>
  64. This removes ALL information about a channel from the bot.
  65. $f*** IMPORTANT ***$f
  66. This erases ALL information about the channel, including channel settings,
  67. bans, exempts, invites, and channel records for users -- $bEVERYTHING$b.
  68. $bDO NOT$b use it to have the bot temporarily leave a channel. This
  69. command is for abandoning a channel (e.g. the channel will have to be
  70. redefined and all user flags for that channel will have to be redone.
  71. If you want to do this try '%dcycle' or '%ddown'
  72. See also: +chan, chanset, chaninfo, cycle, down
  73. ::-chrec
  74. ### $b-chrec$b <handle> [channel]
  75. Removes a channel record for the specified user, including channel lastons,
  76. info lines, and flags.
  77. See also: +chrec, chattr
  78. ::-exempt
  79. Removes the specified exempt from the list of exempts stored on the bot. You
  80. may also reference the exempt by the number shown by the 'exempts' command.
  81. See also: exempts, +exempt, stick, unstick
  82. ::-host
  83. ### $b-host$b <hostmask>
  84. Removes a host from your handle.
  85. %{+m|m}
  86. ### $b-host$b <handle> <hostmask> [anotherhostmask] ...
  87. Removes a hostmask from a user's user record.
  88. %{-}
  89. See also: +host, clearhosts
  90. ::-ignore
  91. ### $b-ignore$b <hostmask/number>
  92. Removes the specified ignore from the list of ignores stored on the bot. You
  93. may also reference the ignore by the number shown by the 'ignores' command.
  94. See also: +ignore, ignores
  95. ::-invite
  96. ### $b-invite$b <hostmask or number>
  97. Removes the specified invite from the list of invites stored on the bot. You
  98. may also reference the invite by the number shown by the 'invites' command.
  99. See also: invites, +invite, stick, unstick
  100. ::-user
  101. ### $b-user$b <handle>
  102. Removes the specified handle's user record.
  103. See also: +user%{+ai}, -bot%{-}%{+nai}, newleaf%{-}
  104. ::about:
  105. ### $babout$b
  106. If you feel you are missing from the list feel free to contact bryan.
  107. :leaf:act
  108. ### $bact$b [channel] <text>
  109. Performs an action on the current console channel (or otherwise
  110. specified channel), as if the bot did it. Just like the /me
  111. command in IRC.
  112. See also: console
  113. ::addline
  114. ### $baddline$b <username>
  115. Shows you a simple line for adding a user to another botnet with the
  116. same hostmasks.
  117. See also: whois
  118. ::addlog
  119. ### $baddlog$b <text>
  120. Adds your comment to the bot's logfile. Bot masters can go back later and
  121. review the log, and will see your comment (with your handle attached). This
  122. is useful for explaining confusing activity.
  123. :leaf:adduser
  124. ### $badduser$b [!]<nickname> [handle]
  125. Creates a new user record for a user on the channel, using their
  126. current hostname. It's similar to a user msg'ing the bot 'hello'
  127. except that no information is sent to that user. If the bot
  128. already knows someone by that nickname, and the user on the channel
  129. doesn't have a bot record, then it does the equivalent of an
  130. 'ident' for that user -- except that, again, no information is
  131. sent to the user telling them that anything was done.
  132. If the user is using a different nickname than the bot normally
  133. knows her by, you can specify her "handle" (the nickname that the
  134. bot remembers).
  135. If you want to add a user using a static hostmask, prefix their nick
  136. with a '!'. i.e. '%dadduser !Lamer'
  137. The user being added is sent a NOTICE with their initial password.
  138. See also: +host, -host, clearhosts%{+m}, +user, -user%{-}
  139. :leaf:authed:
  140. ### $bauthed$b
  141. Displays users who are authed on the bot for chan/msg cmds.
  142. ::away
  143. ### $baway$b [reason]
  144. Marks you as "away" on the party line. Your away message will show up in
  145. the $b'%dwho'$b list. Saying something on the party line will automatically
  146. remove your "away" status, or you can type $b'%dback'$b or $b'%daway'$b by
  147. itself.
  148. See also: back
  149. ::back
  150. ### $bback$b
  151. This marks you as no longer away on the party line.
  152. See also: away
  153. :hub:backup
  154. ### $bbackup$b
  155. This makes the bot write a backup of its entire user list to the disk.
  156. This is useful if you feel the need to backup the userfile and channel
  157. settings.
  158. See also: reload, save
  159. ::bans
  160. ### $bbans$b [[channel/all/global]/wildcard]
  161. Shows you a list of the global bans active on the current channel, and the
  162. list of channel-specific bans, as well as any bans that are on the channel
  163. but weren't placed by the bot.
  164. Here's a sample entry;
  165. [ 5] *!*habib@*frys.com (perm)
  166. paulie: revolving check policy
  167. Created 15:10
  168. The number (5) can be used to reference the ban if you wish to remove it
  169. (see $b'-ban'$b). Next is the actual hostmask being banned. The "(perm)"
  170. means that the ban is "permanent": that is, it doesn't automatically expire.
  171. If there is an elapsed time showing instead, the time displayed is how long
  172. the ban has been active. These types of bans expire after two hours. The
  173. second line of the ban entry is the comment ("revolving check policy"), and
  174. who set the ban (paulie). The last line shows when the ban was added, and
  175. possibly the last time the ban was activated on the channel (if it's
  176. different from the creation time).
  177. Sometimes there will be a "!" or "*" right before the number. A "!" means
  178. the ban is in the bot's ban list, but is not currently on the channel. A "*"
  179. marks a ban which is NOT in the bot's ban list but IS on the channel.
  180. If you use 'bans' without an argument, it will show you only the bans which
  181. are currently active on the channel. If you use 'bans all', it will show you
  182. every ban in the global ban list and on the channel. If you use 'bans
  183. <wildcard>', it will list all bans (active or not) that match against your
  184. wildcard. Consider it a 'bans all' list matched against your wildcard.
  185. If you use 'bans global', a full list of bans for EVERY channel will be
  186. displayed, including inactive/active bans on each channel.
  187. The ban list may change according to which channel you're currently viewing
  188. in the console. Different bans may be active on different channels. If you
  189. specify a channel name, that channel will be used instead of your current
  190. console channel.
  191. See also: -ban, +ban, console%{+m|m}, chanset, chaninfo%{-}, stick, unstick
  192. :hub:bc:
  193. ### $bbc$b <bot> <cmd> [params]
  194. See: botcmd
  195. :hub:boot
  196. ### $bboot$b <handle[@bot]> [reason]
  197. Kicks a user off the party line and displays the reason, if you specify
  198. one. You can also specify a bot, and attempt to boot someone from another
  199. bot on the botnet. You can not boot a bot owner.
  200. :hub:botcmd:
  201. ### $bbotcmd$b <bot> <cmd> [params]
  202. The specified cmd and optional parameters are executed on the specified bot,
  203. all results are displayed back on DCC. For example:
  204. [19:29] #bryan# botcmd wtest whom ...
  205. [19:29] (wtest) #bryan# whom
  206. [wtest] Nick
  207. [wtest] ----------
  208. [wtest] ^bryan
  209. [wtest] ^bryan [idle 1h22m]
  210. [wtest] ^bryan [idle 1h22m]
  211. [wtest] Total users: 3
  212. The bot specified can also have wildcards in it. '*' for 1 or more chars, and
  213. '?' for exactly 1 char. Use this cmd carefuly, and even think about placing
  214. a cmdpass on it.
  215. Just using '?' for 'bot' will choose a random leaf bot.
  216. Just using '&' for 'bot' will do the cmd on all localhub bots. (first bot in config).
  217. This cmd cannot be chained over the botnet, ie, no: '%dbotcmd [bot] botcmd [bot2] ...'
  218. There are two default aliases added for this cmd:
  219. bc -> botcmd
  220. bl -> botcmd ?
  221. See also: cmdpass
  222. ::botjoin
  223. ### $bbotjoin$b <bot> <channel> [options]
  224. Adds a channel to the bot's channel list. If options are specified, the
  225. channel will be configured with the options.
  226. $bTHIS CMD IS CURRENTLY EXPERIMENTAL AND WILL NOT ACTUALLY SAVE STATE$b
  227. $bMEANING, ALL BOTS WILL JOIN EVENTUALLY AFTER DOING BOTJOIN$b
  228. See also: botpart, +chan, -chan, chanset, chaninfo
  229. :hub:botjump:
  230. ### $bbotjump$b <bot> [server [port [pass]]]
  231. Makes the bot jump to another server. If you don't specify a
  232. server, it will jump to the next server in its internal list (see
  233. $b'%dhelp set'$b). If you specify a server, it will jump to that
  234. server (default port is 6667), and if that server is not in the
  235. internal list already, it will add it (until the bot relinks).
  236. Jumping servers ALWAYS makes the bot lose ops! be careful!
  237. See also: jump, servers, botserver
  238. :hub:botmsg:
  239. ### $bbotmsg$b <bot> <nickname|#chan> <text>
  240. sends a private message to someone from the bot, just as if the
  241. bot had typed /msg.
  242. See also: msg%{+n}
  243. :hub:botnick:
  244. ### $bbotnick$b <bot>
  245. The specified bot will display its current nick over DCC.
  246. See also: netnick, nick
  247. ::botpart
  248. ### $bbotpart$b <bot> <channel>
  249. Removes bot from the specified channel
  250. See also: botjoin, +chan, -chan, chanset, chaninfo
  251. :hub:bots
  252. ### $bbots$b [nodename]
  253. Shows the list of bots currently on the botnet.
  254. Example:
  255. Bots: cEvin, ruthie, Killa1
  256. There is no indication of which bots are directly connected to this current
  257. bot. %{+n}Use $b'%dwho'$b or $b'%dbottree'$b for that information.%{-}
  258. Specifying a nodename will display all bots up/down on that nodename.
  259. Bots with a * preceeding its name is down.
  260. See also: downbots%{+n}, bottree%{-}
  261. :hub:botserver:
  262. ### $bbotserver$b <bot>
  263. The bot will display its current server and lag over DCC.
  264. See also: netserver, servers%{+n}, set%{-}
  265. :hub:botset:
  266. ### $bbotset$b <bot> [<+/->list] [<var> [data|-]]
  267. Set's a bot specific entry.
  268. NOTE: 'set' and 'botset' have different entries.
  269. If there is a botset entry for 'name' and a set entry for 'name',
  270. the bot will use the 'botset' entry. Otherwise, the 'set' entry
  271. will be used for all options.
  272. The <var> may have wildcards. Wildcards will only be used for listing
  273. variable, not for setting.
  274. See 'set' for a full help listing.
  275. See also: set
  276. :hub:bottree
  277. ### $bbottree$b
  278. Shows a tree-format diagram of the bots currently on the botnet. It's just a
  279. nice way to get a feel for how the bots are physically connected. If 2 bots
  280. are sharing, a + will be indicated, or a ? if nothing is known.
  281. Some bots are colored if you have colors on (see '%dhelp color')
  282. Yellow: hubs (Do not come on IRC)
  283. Red: localhubs (first bot in binary, see '%dhelp conf')
  284. Other: normal leaf bots
  285. See also: bots, downbots
  286. ::botversion:
  287. ### $bbotversion$b <bot>
  288. The bot will display its pack version and uname.
  289. See also: version, netversion, about%{+m|m}, status%{-}
  290. :hub:chaddr
  291. ### $bchaddr$b <bot> <address[:bot port[/user port]]>
  292. Changes the address for a bot. This is the address your bot will try to
  293. connect to when linking. If the bot has a separate port for bots and users,
  294. they should be separated by a slash (/).
  295. %{+a}
  296. It is not recommneded that this is used, you should change your source,
  297. and update all bots instead.
  298. %{-}
  299. See also: link
  300. ::chaninfo:
  301. ### $bchaninfo$b <channel>
  302. This lists all the settings for the bot on the given channel.
  303. It shows any of the following:
  304. $bchanmode$b These modes are enforced on the channel. Both + and -
  305. modes can be enforced.
  306. %{+m|m}
  307. $bauto-delay$b Amount of seconds to wait before auto opping,
  308. or auto voicing a client based on flags or
  309. +voice
  310. $blimit$b If this is set, the +l bot will raise the limit
  311. to the users in the channel + this ammount. Set to
  312. 0 to disable.
  313. $bclosed-ban$b Set this to 1 to ban users who join +closed
  314. channels. This is probably not needed though, as
  315. +closed maintains +i.
  316. $bclosed-invite$b If a channel is set +closed and this is set
  317. force the channel to always be +i, otherwise don't.
  318. $bclosed-private$b If a channel is set +closed, the bots will
  319. enforce +p as well. The point is to notice the chan
  320. and bots when an /invite is done. This is useful in
  321. seeing when a shell is hijacked ;)
  322. $bban-time$b Set here how long temporary bans will last (in
  323. minutes). If you set this setting to 0, the bot will
  324. never remove them. (This also requires +dynamicbans)
  325. $bban-type$b
  326. This setting defines what type of bans should be
  327. placed. Available types are:
  328. 0 *!user@host
  329. 1 *!*user@host
  330. 2 *!*@host
  331. 3 *!*user@*.host
  332. 4 *!*@*.host
  333. 5 nick!user@host
  334. 6 nick!*user@host
  335. 7 nick!*@host
  336. 8 nick!*user@*.host
  337. 9 nick!*@*.host
  338. You can also specify types from 10 to 19 which correspond
  339. to types 0 to 9, with the exception that numbers in hostnames
  340. are replaced with the '?' wildcard, or 20 to 29, which works
  341. like 10 to 19 but using '*' for numbers, instead of '?'.
  342. $bexempt-time$b Set here how long temporary exempts will last (in
  343. minutes). If you set this setting to 0, the bot will
  344. never remove them. The bot will check the exempts
  345. every X minutes, but will not remove the exempt if a
  346. ban is set on the channel that matches that exempt.
  347. Once the ban is removed, then the exempt will be
  348. removed the next time the bot checks. Please note
  349. that this is an IRCnet feature.
  350. $bknock$b Allow auto-inviting on /KNOCK?
  351. None/0 Don't invite on /KNOCK
  352. Op/1 Ops (+o) are invited on /KNOCK
  353. Voice/2 Voices (+v) are invited on /KNOCK
  354. User/3 Users (not +dk) are invited on /KNOCK
  355. $bflood-exempt$b Should clients be exempt from flood checks based
  356. on their channel status? (not deop/kick floods)
  357. Valid values are:
  358. None/0 Stick to regular checking (+x)
  359. Op/1 Ops are exempt from flood checks
  360. Voice/2 Voices are exempt from flood checks
  361. $bflood-lock-time$b How long in seconds to keep the channel locked
  362. during drone floods.
  363. $binvite-time$b Set here how long temporary invites will last (in
  364. minutes). If you set this setting to 0, the bot will
  365. never remove them. The bot will check the invites
  366. every X minutes, but will not remove the invite if a
  367. channel is set to +i. Once the channel is -i then the
  368. invite will be removed the next time the bot checks.
  369. Please note that this is an IRCnet feature.
  370. $bvoice-non-ident$b If channel is +voice, clients without an ident will
  371. be voiced. Set to 0 to not voice clients without ident.
  372. The following options chose how to respond to specific events.
  373. Each can be set as any of the specified options.
  374. ignore/0 Ignore
  375. deop/1 Deop (chattr +d)
  376. kick/2 Kick (chattr +k)
  377. delete/remove/3 Remove user
  378. $bbad-cookie$b Missing or invalid cookie in bot op line.
  379. $bmanop$b Users who op manually.
  380. $bmdop$b Users who mass deop.
  381. $bmop$b Users who mass op in a -mop chan.
  382. The following can be set + or - (e.g. '%dchanset #channel -enforcebans')
  383. $bautoop$b Bots that are +y will auto-op all users with
  384. op access to the channel.
  385. $bbackup$b Make backup-bots (+B) join when set.
  386. $bbitch$b Only let users with the +o flag have op on the
  387. channel?
  388. $bbotbitch$b Only let $bbots$b with the +o flag have op on the
  389. channel?
  390. $bclosed$b Kick all people who join channel unless they have
  391. op access for the channel.
  392. $bcycle$b Bot will attempt to cycle the channel when opless
  393. or during splits to gain ops.
  394. $benforcebans$b When a ban is set, kick people who are on the channel
  395. and match the ban?
  396. $bfastop$b Setting this will disable cookie-ops. You may
  397. know cookie-ops as an annoying way of bots opping
  398. themselves with +o-b bot *!*@fjdifgjdsgiufufdhgfudghfdgfdg,
  399. but, with -fastop (cookie-ops enabled), opping is much
  400. more secure and the chances of someone hijacking the bot
  401. for ops in your channel are much much less. This is
  402. highly recommened to always be set.
  403. $binactive$b This prevents the bot from joining the channel (or
  404. makes it leave the channel if it is already there). It
  405. can be useful to make the bot leave a channel without
  406. losing its settings, channel-specific user flags,
  407. channel bans, and without affecting sharing.
  408. $bmeankicks$b Use mean/offensive kicks/bans in the channel.
  409. $bnodesynch$b Allow non-ops to perform channel modes? This can stop
  410. the bot from fighting with services such as ChanServ, or
  411. from kicking IRCops when setting channel modes without
  412. having ops.
  413. $bnomassjoin$b If more than 6 clients join in 1 second, set +im
  414. for 2 minutes. (Could be triggered from net-split
  415. rejoin if clients hop servers and change nicks)
  416. $bprivate$b This by far is probably the single most unique and
  417. important feature of this pack. With this set, users with
  418. global +o will not implicitly have access to the channel.
  419. They will need to have channel |o flag to have access.
  420. Users with global +n override this as they should have
  421. control over the entire botnet and where it goes.
  422. Users who lose access to a channel because of this setting
  423. will see no reference to it over the botnet in any place.
  424. The +o restriction goes for +v as well.
  425. $brbl$b Do RBL lookups on clients and ban on matches.
  426. Uses 'rbl-servers'. See also '%dhelp set'
  427. $btake$b Once a bot is opped, it will mass op all other bots
  428. in the channel. After that, they will all attempt to
  429. mass deop in hopes 'taking' the channel. :)
  430. $bvoice$b This feature is somewhat experimental. With it set
  431. the +y bot will voice ALL people who join the channel
  432. unless they are +q globally or +q for the channel.
  433. If a botnet master devoices them, they will remain
  434. devoiced no matter who voices them.
  435. $bdynamicbans$b Only activate bans on the channel when necessary?
  436. This keeps the channel's ban list from getting
  437. excessively long. The bot still remembers every ban,
  438. but it only activates a ban on the channel when it sees
  439. someone join who matches that ban.
  440. $buserbans$b Allow bans to be made by users directly? If turned
  441. off, the bot will require all bans to be made through
  442. the bot's console.
  443. $bdynamicexempts$b Only activate exempts on the channel when
  444. necessary? This keeps the channel's exempt list from
  445. getting excessively long. The bot still remembers every
  446. exempt, but it only activates an exempt on the channel
  447. when it sees a ban set that matches the exempt. The
  448. exempt remains active on the channel for as long as the
  449. ban is still active.
  450. $buserexempts$b Allow exempts to be made by users directly? If
  451. turned off, the bot will require all exempts to be made
  452. through the bot's console.
  453. $bdynamicinvites$b Only activate invites on the channel when necessary?
  454. This keeps the channel's invite list from getting
  455. excessively long. The bot still remembers every invite,
  456. but the invites are only activated when the channel is
  457. set to invite only and a user joins after requesting an
  458. invite. Once set, the invite remains until the channel
  459. goes to -i.
  460. $buserinvites$b Allow invites to be made by users directly? If turned
  461. off, the bot will require all invites to be made through
  462. the bot's console.
  463. The following are flood settings, they are set via '%dchanset <channel>
  464. flood-type number:seconds', where number and second are integers
  465. indicating the number of times in how many seconds the flood will be
  466. triggered. Setting one of these to 0:0, 0:1, or 1:0 will deactivate the
  467. respective flood setting.
  468. $bflood-chan$b Set here how many channel messages in how many seconds
  469. from one host constitutes a flood. Setting this to 0 or 0:0
  470. disables text flood protection for the channel.
  471. $bflood-ctcp$b Set here how many channel ctcps in how many seconds from
  472. one host constitutes a flood. Setting this to 0 or 0:0
  473. disables ctcp flood protection for the channel.
  474. $bflood-join$b Set here how many joins in how many seconds from one
  475. host constitutes a flood. Setting this to 0 or 0:0 disables
  476. join flood protection for the channel.
  477. $bflood-kick$b Set here how many kicks in how many seconds from one
  478. host constitutes a flood. Setting this to 0 or 0:0 disables
  479. kick flood protection for the channel.
  480. $bflood-deop$b Set here how many deops in how many seconds from one
  481. host constitutes a flood. Setting this to 0 or 0:0 disables
  482. deop flood protection for the channel.
  483. $bflood-nick$b Set here how many nick changes in how many seconds from
  484. one host constitutes a flood. Setting this to 0 or 0:0
  485. disables nick flood protection for the channel.
  486. $bflood-mjoin$b Set how many joins in how many seconds before triggering
  487. a lockdown for mass join. ($bnomassjoin$b must be set).
  488. These can all be changed simultaneously with $bflood-*$b
  489. See also: %{-}%{+n}+chan, -chan%{-}%{+m|m}, chanset%{-}
  490. :leaf:channel
  491. ### $bchannel$b [channel-name]
  492. Shows you an extensive display of the users on a channel, and
  493. the current channel attributes. By default, it shows you the
  494. channel you are currently viewing on the console, but you can
  495. specify another channel if you wish.
  496. The first line will look like:
  497. Channel #hiya, 8 members, 45 users, mode +tn:
  498. This means that the bot is sitting on channel #hiya, where 8
  499. other irc'ers are. There are 45 people that the bot knows by
  500. hostmask, and the channel mode is +tn. If the bot isn't on
  501. the channel it is supposed to be on, it will say "Desiring
  502. channel #hiya" instead. Next is a list of the users on the
  503. channel, with each entry looking like this:
  504. NICKNAME HANDLE JOIN HOPS IDLE USER@HOST
  505. @kantSF kantSF 14:53 o 2 6m josh@random.edu
  506. The "@kantSF" means that the user's nickname is kantSF and that
  507. he is a chanop. The second "kantSF" is the nickname that the
  508. bot knows him by. Sometimes this will differ from the nickname
  509. a person is using. The time displayed is the time the user
  510. joined the channel. The next field is the attributes:
  511. n - bot owner o - can get ops (+o)
  512. m - bot master or owner b - another bot
  513. d - cannot get ops (+d)
  514. The last field is the user@host he is using irc from.
  515. See also: status, whois
  516. ::channels:
  517. ### $bchannels$b %{+m}[user]%{-}
  518. Displays channels that you have access to, and any important
  519. flags that are set on them.
  520. %{+m}
  521. Masters: You can specify other users to see what channels their
  522. flags grant them access to.%{-}
  523. See also: whois%{+m}, chattr, chaninfo%{-}
  524. ::chanset
  525. ### $bchanset$b [#&!+channel|*|default] <settings>
  526. Allows you to change the channel settings (see $b'chaninfo'$b for the
  527. settings) for one specific channel or all channels. Use '*' to to apply the
  528. change to all channels.
  529. Changes are used until the next restart, and are saved
  530. whenever the userfile is saved.
  531. Modifying 'default' will change what new channels get when they are created.
  532. See also: %{+n}+chan, -chan%{-}, chaninfo
  533. ::chat
  534. ### $bchat$b <on/off>
  535. ### $bchat$b <[*]channel number/name>
  536. Changes your current channel on the partyline. When you first connect to
  537. the partyline, it places you on channel 0 (the main party line).
  538. Some channels may have assigned names if the assoc module is loaded. For
  539. these, you can specify the channel by name instead of channel number if
  540. you wish.
  541. $b'%dchat off'$b removes you from all channels, including the main party line.
  542. You can still use bot commands and see the console, but you can't talk to
  543. anyone. $b'%dchat on'$b returns you to the main party
  544. line (channel 0) if you were elsewhere.
  545. If you prefix the channel with a '*', you will join a local channel.
  546. See also: console
  547. ::chattr
  548. ### $bchattr$b <handle> [flags] [channel]
  549. This lets you view and change the flags for a user.
  550. For example, to give Lamer the p and f flags:
  551. '%dchattr Lamer +pf'
  552. To remove Denali from the global op list:
  553. '%dchattr Denali -o'
  554. You may also do any combination of the above:
  555. '%dchattr Fred1 -m+xj-o'
  556. You can also change the flags for Usagi on a specific channel by supplying
  557. the channel after the attributes:
  558. '%dchattr Usagi -m+dk-o #blah'
  559. Changing global and channel specific flags within the same command line is
  560. also possible (global +o #lamer):
  561. '%dchattr Bill f|o #lamer'
  562. Whether or not you change any flags, it will show you the user's attributes
  563. afterwards. To get a list of all possible flags, see $b'%dhelp whois'$b.
  564. $bNOTES:$b Only the owner may add or remove the 'a' (admin) or 'n' (owner) flags.
  565. It is pointless to -a a permanent owner.
  566. You must remove the permanent owner in the binary.
  567. See also: whois
  568. :hub:checkchannels
  569. ### $bcheckchannels$b
  570. This will make all leaf bots display which channels they are currently
  571. not in but *should* be in. This command will not show channels which
  572. the bot is not active in due to '$bbotpart$b'.
  573. See also: botcmd, channels, channel, status
  574. :hub:chhandle
  575. ### $bchhandle$b <oldhandle> <newhandle>
  576. Changes the handle of a user. For example, to change the handle of user
  577. 'gavroche' to 'jamie', you would use 'chhandle gavroche jamie'.
  578. Perm owners may not change their handle without recompiling binaries first.
  579. Bot handles cannot be changed from partyline.
  580. See also: chpass%{+n}, chsecpass%{-}
  581. ::chinfo
  582. ### $bchinfo$b <user> [channel] [info-line/none]
  583. Sets the information line for a user. This line is shown via the /msg
  584. commands $b'who'$b and $b'whois'$b.
  585. If the info line begins with an '@', then it is "locked", and that user
  586. may no longer change it. If the channel name is omitted, the default info
  587. line is changed. If you specify 'none' as the info-line, it will be erased.
  588. See also: info
  589. :hub:chnick
  590. See: chhandle
  591. :hub:chpass
  592. ### $bchpass$b <handle> [newpassword|rand]
  593. Changes a user's password. If you do not specify the new password, the user
  594. effectively no longer has a password set. A password is needed to get ops,
  595. join the party line, etc. If the newpassword is 'rand', a random password
  596. will be used.
  597. This has no affect on bots.
  598. See also: chhandle%{+n}, chsecpass%{-}
  599. :hub:chsecpass:
  600. ### $bchsecpass$b <handle> [newpassword|rand]
  601. Changes a user's secpass. If you do not specify the new password, the user
  602. effectively no longer has a password set. A secpass is needed to auth and
  603. login via DCC chat. If the newpassword is 'rand', a random password
  604. will be used.
  605. See also: chhandle, chpass
  606. ::clearhosts
  607. ### $bclearhosts$b
  608. Removes all hosts from your handle.
  609. %{+m|m}
  610. ### $bclearhosts$b <handle>
  611. Removes all hosts from a user's user record.
  612. %{-}
  613. See also: +host, -host
  614. :leaf:clearqueue
  615. ### $bclearqueue$b <queue>
  616. Removes all msgs from the specified queue (mode/server/help/all)
  617. :hub:cmdpass:
  618. ### $bcmdpass$b <command> <pass> [newpassword]
  619. Places the specified pass on the cmd so that the cmd will need to be
  620. followed by the specified pass whenever it is called. For example:
  621. '%dcmdpass whoami BLAH'
  622. [19:32] #bryan# cmdpass whoami ...
  623. Set command password for whoami to 'BLAH'
  624. '%dwhoami'
  625. Invalid command password. Use !command password arguments
  626. [19:33] bryan attempted !whoami with missing or incorrect command password
  627. '%dwhoami BLAH'
  628. You are bryan@hub.
  629. [19:33] #bryan# whoami
  630. To remove a cmdpass for a cmd, specify the old pass and do not specify a new pass
  631. ** Only permanent owners specified in the binary COMPILE config file **
  632. ** can use this cmd. **
  633. ::color:
  634. ### $bcolor$b <on/off>
  635. Enables or disables misc coloring over DCC. mIRC or ANSI method is
  636. chosen automatically.
  637. See also: console, echo, login, page, strip
  638. ::comment
  639. ### $bcomment$b <user> <comment>
  640. Creates or changes the comment field for a user. The comment field can only
  641. be seen via 'whois' or 'match'. Non-masters cannot see the comment field.
  642. Using the comment 'none' will clear a user's comment.
  643. ::conf:
  644. ### $bconf$b <add|del|change|disable|enable|list|set> [options]
  645. This command is used to modify the bot's local shell config. Only
  646. the first bot listed will be able to perform this command. Using the cmd
  647. on a non-'localhub' will result in an error similar to:
  648. [16:42] #bryan# botcmd wtest2 conf list
  649. [wtest2] Please use 'wtest' for this login/shell.
  650. Simply use the command on the bot specified.
  651. 'add' uses the same syntax as the conf file:
  652. add <bot> [<ip|.> <[+]host|.> [ipv6-ip]]
  653. ip/host/ipv6-ip are all optional and/or can be replaced with '.'
  654. Newly added bots will start immediately, don't forget to 'newleaf'.
  655. 'del' syntax is:
  656. del <bot>
  657. Deleted bots that are running will be killed.
  658. 'change' syntax is the same as 'add'
  659. 'disable' syntax is:
  660. disable <bot>
  661. The bot will be killed, but not removed from userlist. It will not start again
  662. until you use 'enable' on it.
  663. 'enable' syntax is:
  664. enable <bot>
  665. The bot is enabled. (Only relevant for disabled bots designated via a prefix of '/')
  666. 'list' shows all the bots currently in the config.
  667. 'set' allows changing some variables in the config.
  668. Using with no parameters will show all changable options.
  669. Simply specifiy the option and new setting as follows:
  670. set <what> [option]
  671. WARNING: Options changed MAY OR MAY NOT affect bots already running,
  672. it is a good idea to restart all bots on the shell
  673. if you change any of the following:
  674. $bhomedir$b, $bbinpath$b, $bbinname$b, $bportmin$b, $bportmax$b
  675. See also: newleaf
  676. ::console:
  677. ### $bconsole$b [channel] [modes]
  678. Changes your console level so that you will see only the types of console
  679. messages that you want to. Your current console channel is the channel (that
  680. the bot is on) from which you can view from the party line, and which
  681. channel-specific commands (like 'say' and 'op') take affect on.
  682. Valid flags are:
  683. $bj$b joins, parts, quits, and netsplits on the channel
  684. $bk$b kicks, bans, and mode changes on the channel
  685. $bm$b private msgs, notices and ctcps to the bot
  686. $bp$b public text on the channel
  687. $bs$b server connects, disconnects, and notices
  688. %{+m}
  689. Masters only:
  690. $bb$b information about bot linking and userfile sharing
  691. $bd$b misc debug information
  692. $bc$b commands
  693. $bo$b misc info, etc (IMPORTANT STUFF)
  694. $bw$b wallops
  695. %{-}
  696. %{+n}
  697. Owners only (these have to be enabled in the config file via "set raw-log"):
  698. $be$b errors
  699. $bg$b (getin) botnet op/invite/key requests
  700. $bh$b raw share traffic
  701. $br$b raw incoming server traffic
  702. $bt$b raw botnet traffic
  703. $bu$b warnings
  704. $bv$b raw outgoing server traffic
  705. %{-}
  706. %{+o|o}
  707. The mode can also be a modifier like '+p' or '-jk' or '+mp-b'. If you omit
  708. the channel and modes, your current console channel and flags will be shown.
  709. %{-}
  710. %{+m|m}
  711. ### $bconsole$b <user> [channel] [modes]
  712. This is used to set the console level of another user. This can even be used
  713. on users who normally would not be able to set their own console mode.%{-}
  714. See also: color, echo, login, page, strip
  715. ::crontab:
  716. ### $bcrontab$b <status|delete|show|new> [interval]
  717. This command is used to manipulate the crontab entries for the user
  718. that the bot is running on.
  719. 'status' will display the status of the crontab entry for the bot,
  720. for example:
  721. [18:59] #bryan# crontab status
  722. Crontabbed
  723. 'show' will display the current crontab entries, for example:
  724. [18:59] #bryan# crontab show
  725. Showing current crontab:
  726. Result:
  727. 3,8,13,18,23,28,33,38,43,48,53,58 * * * * /usr/home/bryan/hub/hub > /dev/null 2>&1
  728. 1,6,11,16,21,26,31,36,41,46,51,56 * * * * /usr/home/bryan/hub/newhub > /dev/null 2>&1
  729. 'delete' will remove the bot's own crontab entry from the crontab list.
  730. 'new' will make the bot add itself to the crontab list, although this is done
  731. automatically on startup.
  732. ::cycle:
  733. ### $bcycle$b <channel> [delay]
  734. If done on the hub, makes all linked bots cycle the specified channel.
  735. Otherwise, only the bot it is done on will cycle.
  736. Delay defaults to 10 seconds, which means bots will part and not rejoin
  737. until that time has passed.
  738. See also: down
  739. ::date
  740. ### $bdate$b
  741. Displays the time/date in local and GMT. Also displays which time zone
  742. is being used by the bot for internal logging.
  743. :hub:dccstat
  744. ### $bdccstat$b
  745. Displays a table-format list of all "dcc" connections in use on the bot.
  746. Dcc stands for "Direct Client-to-client Communication", and Eggdrop expands
  747. this to cover every open socket. Any type of network connection to the bot
  748. is considered a "dcc" connection.
  749. The headings of the table are:
  750. $bSOCK$b the socket number of this connection (always unique)
  751. $bADDR$b the ip address mask of the host the bot is connected to, if
  752. applicable
  753. $bPORT$b the port number being used for this connection
  754. $bNICK$b the handle of the user or bot, if applicable
  755. $bHOST$b the hostname corresponding to the IP address, if available
  756. $bTYPE$b the type of dcc connection (see below)
  757. The types of connections currently possible are as follows (but more are
  758. being added all the time):
  759. $bCHAT$b dcc-chat partyline user
  760. $bPASS$b user entering dcc chat (being asked for password)
  761. $bSEND$b user sending a file
  762. $bGET$b sending a file to a user
  763. $bGETP$b pending get (waiting for the user to acknowledge)
  764. $bLSTN$b telnet listening port (in place of a hostname, it will show the
  765. callback procedure name, or a mask of acceptable handles)
  766. $bT-IN$b incoming telnet user (being asked for handle)
  767. $bFILE$b user in dcc-chat file area
  768. $bBOT$b connected bot (botnet connection)
  769. $bBOT*$b pending bot link (waiting for acknowledgement)
  770. $bRELA$b user in relay connection to another bot
  771. $b>RLY$b bot being relay'd to (one for each "RELA")
  772. $bCONN$b pending telnet connection (chat, relay, bot-link, etc)
  773. $bNEW$b new user via telnet (entering a handle)
  774. $bNEWP$b new user via telnet (entering a password)
  775. In addition, 'CHAT' and 'BOT' have flags listed for each connection. Capital
  776. letters mean that the flag is on, and lowercase letters mean that the flag
  777. is off. The flags for 'CHAT' are:
  778. $bC$b in file area, but allowed to return to party line
  779. $bK$b color is on
  780. $bP$b party line access only
  781. $bT$b telnet connection (instead of dcc chat)
  782. $bE$b echo is on
  783. $bP$b paging is on
  784. $b6$b socket is ipv6
  785. The flags for 'BOT' are:
  786. $bP$b ping sent, waiting for reply
  787. $bU$b user-file sharing is active
  788. $bC$b local bot initiated the connection
  789. $bO$b user-file offered, waiting for reply
  790. $bS$b in the process of sending the user-file
  791. $bG$b in the process of getting the user-file
  792. $bW$b warned this bot to stop hubbing
  793. $bL$b leaf-only bot (not allowed to be a hub)
  794. $bI$b bot is currently in the 'linking' stage
  795. $bA$b bot is being aggressively shared with
  796. For 'CHAT' users, the party-line channel is also listed.
  797. ::debug
  798. ### $bdebug$b
  799. Display a dump of memory allocation information, assuming the bot was
  800. compiled with memory debugging. It's useless to anyone but developers
  801. trying to find memory leaks.
  802. ::decrypt
  803. ### $bdecrypt$b <key> <string>
  804. Decrypts the string using the specified key.
  805. See also: decrypt_fish, encrypt, encrypt_fish, randstring, md5, sha1, sha256, hash
  806. ::decrypt_fish
  807. ### $bdecrypt_fish$b <key> <string>
  808. Decrypts the string using the specified key.
  809. This algorithm is eggdrop's blowfish, same as FiSH.
  810. See also: decrypt, encrypt, encrypt_fish, randstring, md5, sha1, sha256, hash
  811. :leaf:deluser
  812. ### $bdeluser$b <nickname>
  813. Deletes a user record for a user on the channel, using their
  814. current hostname. Channel masters can remove users so long as
  815. the user isn't a bot master.
  816. Channel masters may only delete users which they added.
  817. see also: adduser%{+m}, +user, -user%{-}
  818. :leaf:deop
  819. ### $bdeop$b <nickname> [channel|*]
  820. Will remove chanop from the person you specify, so long as the
  821. bot is opped on that channel, and the person you specify isn't
  822. on the bot's list of authorized chanops. Specify * for all
  823. channels.
  824. See also: op, console
  825. :leaf:devoice
  826. ### $bdevoice$b <nickname> [channel|*]
  827. Will remove the +v voice from the person you specify, so long as
  828. the bot is opped on that channel. Specify * for all channels.
  829. ::die
  830. ### $bdie$b [reason]
  831. This kills the bot. The bot goes offline immediately, logging who issued
  832. the 'die' command. You shouldn't have to use this too often. If you specify
  833. a reason, it is logged, otherwise the reason is "authorized by <handle>".
  834. See also: suicide, conf
  835. ::dns
  836. ### $bdns$b <hostname/ip/flush>
  837. Resolves the given hostname/ip
  838. If "flush" is the specified hostname, the cache will be flushed.
  839. ::down:
  840. ### $bdown$b <channel>
  841. All linked bots will deop themselves in the specified channel. They
  842. will not reop for 10 seconds.
  843. See also: cycle
  844. :hub:downbots
  845. ### $bdownbots$b
  846. Shows the list of bots that are NOT currently linked to the botnet.
  847. Example:
  848. Down bots: cEvin, ruthie, Killa1
  849. See also: bots
  850. :leaf:dump
  851. ### $bdump$b <text>
  852. dumps the text to the server. keep in mind that this bot doesn't
  853. run through ircII, so ircII commands will most likely not work this
  854. way. they need to be raw irc codes. read rfc1459 from ftp.internic.net
  855. for more help.
  856. '$n' is replaced with the bot's irc nickname.
  857. ** Only permanent owners specified in the binary COMPILE config file **
  858. ** can use this cmd. **
  859. ::echo
  860. ### $becho$b <on/off>
  861. Specifies whether you want your messages echoed back to you. If it's on,
  862. then when you say something on the party line, it will be displayed to you
  863. just like everyone else will see it. If it's off, then it won't happen.
  864. See also: color, console, login, page, strip
  865. ::encrypt
  866. ### $bencrypt$b <key> <string>
  867. Encrypts the string using the specified key.
  868. See also: encrypt_fish, decrypt, decrypt_fish, randstring, md5, sha1, sha256, hash
  869. ::encrypt_fish
  870. ### $bencrypt_fish$b <key> <string>
  871. Encrypts the string using the specified key.
  872. This algorithm is eggdrop's blowfish, same as FiSH.
  873. See also: encrypt, decrypt, decrypt_fish, randstring, md5, sha1, sha256, hash
  874. ::exec:
  875. ### $bexec$b <params>
  876. The bot will execute the specified program with each param specified,
  877. and display the results over DCC.
  878. ::exempts
  879. ### $bexempts$b [[channel/all/global]/wildcard]
  880. Shows you a list of the global exempts active on the current channel, and
  881. the list of channel-specific exempts, as well as any exempts that are on the
  882. channel but weren't placed by the bot.
  883. Here's a sample entry;
  884. ! [ 3] *!test@test.com (perm)
  885. bryan: requested
  886. Created 01:15
  887. The number (3) can be used to reference the exempt if you wish to remove it
  888. (see $b'-exempt'$b). Next is the actual hostmask being exempted. The "(perm)"
  889. means that the exempt is "permanent": that is, it doesn't automatically
  890. expire. If there is an elapsed time showing instead, the time displayed is
  891. how long the exempt has been active. These types of exempts expire after one
  892. hour. The second line of the exempt entry is the comment ("requested"), and
  893. who set the exempt (bryan). The last line shows when the exempt was added, and
  894. possibly the last time the exempt was activated on the channel (if it's
  895. different from the creation time).
  896. Sometimes there will be a "!" or "*" right before the number. A "!" means
  897. the exempt is in the bot's exempt list, but is not currently on the channel.
  898. A "*" marks an exempt which is NOT in the bot's exempt list but IS on the
  899. channel.
  900. If you use 'exempts' without an argument, it will show you only the exempts
  901. which are currently active on the channel. If you use 'exempts all', it will
  902. show you every exempt in the global exempt list and on the channel. If you
  903. use 'exempts <wildcard>', it will list all exempts (active or not) that
  904. match against your wildcard. Consider it a 'exempts all' list matched
  905. against your wildcard.
  906. If you use 'exempts global', a full list of exempts for EVERY channel will be
  907. displayed, including inactive/active exempts on each channel.
  908. The exempt list may change according to which channel you're currently
  909. viewing in the console. Different exempts may be active on different
  910. channels. If you specify a channel name, that channel will be used instead
  911. of your current console channel.
  912. See also: -exempt, +exempt, console%{+m|m}, chanset, chaninfo%{-}, stick, unstick
  913. :leaf:find:
  914. ### $bfind$b <nick!ident@host.com>|<user>
  915. The bot will search through all of its channel records and look
  916. for the specified hostmask. Wildcards are accepted; '*' for 1 or more
  917. characters, or '?' for exactly 1 character.
  918. If a username is specified, then the user is searched for in all the channel
  919. lists.
  920. ::fixcodes
  921. ### $bfixcodes$b
  922. This is for use in situations where the bot gets mixed up about the type
  923. of connection you have with it. For example, you /CTCP CHAT the bot and
  924. it thinks you are connecting via telnet, and you see text displayed as
  925. "Local time is now 17:17" for example instead of "Local time is
  926. now 17:17". Use this to turn telnet codes on or off/change the display
  927. mode.
  928. :leaf:getkey:
  929. ### $bgetkey$b [channel]
  930. If there is a key set for channel, it is displayed. If channel is not
  931. specified, your console channel is used.
  932. See also: console, channels%{+m}, status%{-}
  933. ::handle
  934. ### $bhandle$b <new-handle>
  935. Changes your handle on the bot. This is the handle (nickname) that the
  936. bot will know you as from this point forward. It is used to log into the
  937. bot.
  938. Perm owners may not change their handle without recompiling binaries first.
  939. See also: newpass%{+mi}, chhandle, chpass%{-}%{+n}, chsecpass%{-}
  940. ::hash
  941. ### $bhash$b <string>
  942. Returns the MD5, SHA1, and SHA256 hash of the specified string.
  943. See also: randstring, md5, sha1, sha256, encrypt, encrypt_fish, decrypt, decrypt_fish
  944. ::help:
  945. ### $bhelp$b [cmd]
  946. Alone, will show all cmds that match your flags. With a cmd it will show
  947. the help entry, such as you see here. Specifying a wildcard will display
  948. a list of cmds (matching your flags) that match that wildcard. Use '*'
  949. to match 1 or more characters, and '?' to match exactly one character.
  950. This will only show the commands available on the current type of bot
  951. you are on. Ie, hubs and leafs have different cmds shown in '%dhelp'
  952. :hub:hublevel:
  953. ### $bhublevel$b <hub-bot> <level>
  954. Sets the hublevel for the specified hub. This command is not recommended
  955. for use by anyone. Instead you should change your COMPILE config file
  956. and update your net with new binaries.
  957. You really shouldn't use this cmd.
  958. See also: uplink, chaddr
  959. ::ignores
  960. ### $bignores$b [wildcard]
  961. Shows a list of hostmasks from which the bot is currently ignoring msgs,
  962. notices, etc. There are two types of ignores: permanent and temporary.
  963. Permanent ignores never automatically expire. You must use $b'%d-ignore'$b
  964. to remove them.
  965. Here is a sample permanent ignore:
  966. [ 1] *!*@217.156.44.184 (perm)
  967. bryan: go away
  968. Started 523 days ago
  969. The number (1) can be used to reference the ignore if you wish to remove it
  970. (see $b'%dhelp -ignore'$b). Next is the actual hostmask being ignored. The
  971. "(perm)" means that the ignore is "permanent": that is, it doesn't
  972. automatically expire. The second line of the ignore entry is the comment
  973. ("go away"), and who set the ban (bryan). The last line shows when the ignore
  974. was added.
  975. Here is a sample temporary ignore:
  976. [ 10] blah!blah@blah.cc (expires in 1 day)
  977. bryan: requested
  978. Started 18:02
  979. Here, you see the "perm" in the parentheses next to the hostmask is instead
  980. an expire time. This means that the ignore will expire automatically in one
  981. day.
  982. If you use $b'%dignores <wildcard>'$b, it will list all the ignores
  983. that match against your wildcard.
  984. See also: +ignore, -ignore
  985. ::info
  986. ### $binfo$b [channel] [info-line]
  987. Sets your info line. This line is shown via the /msg commands $b'who'$b and
  988. $b'whois'$b. If the info line begins with an '@', then it is "locked", and
  989. you may no longer change it.
  990. %{+m|m}See also: chinfo%{-}
  991. :leaf:invite
  992. ### $binvite$b <nickname> [channel|*]
  993. Invites someone from irc into your current console channel (or
  994. specified other channel). This is most useful when the channel
  995. is +i. a user with the +o flag can also request an invite from
  996. the bot with /MSG INVITE. Specify * for all channels.
  997. See also: console, iop
  998. ::invites
  999. ### $binvites$b [[channel/all/global]/wildcard]
  1000. Shows you a list of the global invites active on the current channel, and
  1001. the list of channel-specific invites, as well as any invites that are on the
  1002. channel but weren't placed by the bot.
  1003. Here's a sample entry;
  1004. ! [ 3] *!test@test.com (perm)
  1005. bryan: requested
  1006. Created 01:15
  1007. The number (3) can be used to reference the invite if you wish to remove it
  1008. (see $b'-invite'$b). Next is the actual hostmask being invited. The "(perm)"
  1009. means that the invite is "permanent": that is, it doesn't automatically
  1010. expire. If there is an elapsed time showing instead, the time displayed is
  1011. how long the invite has been active. These types of invites expire after one
  1012. hour. The second line of the invite entry is the comment ("requested"), and
  1013. who set the invite (bryan). The last line shows when the invite was added, and
  1014. possibly the last time the invite was activated on the channel (if it's
  1015. different from the creation time).
  1016. Sometimes there will be a "!" or "*" right before the number. A "!" means
  1017. the invite is in the bot's invite list, but is not currently on the channel.
  1018. A "*" marks an invite which is NOT in the bot's invite list but IS on the
  1019. channel.
  1020. If you use 'invites' without an argument, it will show you only the invites
  1021. which are currently active on the channel. If you use 'invites all', it will
  1022. show you every invite in the global invite list and on the channel. If you
  1023. use 'invites <wildcard>', it will list all invites (active or not) that
  1024. match against your wildcard. Consider it a 'invites all' list matched
  1025. against your wildcard.
  1026. If you use 'invites global', a full list of invites for EVERY channel will be
  1027. displayed, including inactive/active invites on each channel.
  1028. The invite list may change according to which channel you're currently
  1029. viewing in the console. Different invites may be active on different
  1030. channels. If you specify a channel name, that channel will be used instead
  1031. of your current console channel.
  1032. See also: -invite, +invite, console%{+m|m}, chanset, chaninfo%{-}, stick, unstick
  1033. :leaf:iop
  1034. ### $biop$b <nickname> [channel|*]
  1035. Same as normal invite, except auto-ops them when they join.
  1036. See also: console, invite
  1037. :leaf:jump
  1038. ### $bjump$b [server [port [pass]]]
  1039. Makes the bot jump to another server. If you don't specify a
  1040. server, it will jump to the next server in it'ss internal list (see
  1041. $b'%dhelp set'$b). If you specify a server, it will jump to that
  1042. server (default port is 6667), and if that server is not in the
  1043. internal list already, it will add it (until the bot relinks).
  1044. Jumping servers ALWAYS makes the bot lose ops! be careful!
  1045. See also: botjump, servers, botserver
  1046. :leaf:kick
  1047. ### $bkick$b [channel|*] <nickname> [reason]
  1048. Will kick a user off your current console channel (or specified
  1049. other channel) with the comment given. if you omit the reason,
  1050. the default kick comment is "requested". Specify * for all
  1051. channels.
  1052. See also: kickban, console
  1053. :leaf:kickban
  1054. ### $bkickban$b [channel|*] [-|@]<nickname> [comment]
  1055. Kicks a user off the channel and bans her by a reasonable host-
  1056. mask. your nickname will be attached to the ban in the bot's
  1057. internal ban list, and the ban will last for whatever is set in
  1058. ban-time -- only on this channel. use $b'%d+ban'$b for a more
  1059. permanent ban which will be activated on every channel the bot
  1060. monitors. if you use a comment, that will also be attached to
  1061. the ban in the ban list, and used as the kick comment. Specify
  1062. * for all channels.
  1063. appending a prefix of ! or @ to a nickname changes the ban
  1064. mask used:
  1065. e.g. with a host of nick!ident@host.name.domain
  1066. command banmask
  1067. '%dkickban nick *!*dent@*.name.domain'
  1068. '%dkickban -nick *!*dent@host.name.domain'
  1069. '%dkickban @nick *!*@host.name.domain'
  1070. with a host of nick!~ident@host.name.domain (strict-host set to 1)
  1071. command banmask
  1072. '%dkickban nick *!*ident@*.name.domain'
  1073. '%dkickban -nick *!*ident@host.name.domain'
  1074. See also: +ban, bans, stick
  1075. :hub:lagged:
  1076. ### $blagged$b
  1077. Displays the bot's internal ping list of bots linked to it.
  1078. If a pingtime goes over 30 seconds, it is delinked for
  1079. ping timeout.
  1080. See also: netlag
  1081. ::last:
  1082. ### $blast$b
  1083. Displays the 'last' output from the shell the bot is running on,
  1084. for the user it is running as.
  1085. %{+i}See also: netlast%{-}
  1086. :hub:link
  1087. ### $blink$b [via-bot] <bot-to-link>
  1088. Attempts to link to another hub. This command is deprecated and not
  1089. recommended for use.
  1090. See also: unlink, newleaf%{+a}, -bot%{-}
  1091. ::login
  1092. ### $blogin$b <banner|bots|channels|whom> [on/off]
  1093. Sets various login options.
  1094. Not specifying on/off will display what the setting is the for the specified
  1095. login entry.
  1096. See also: echo, color, console, page, strip, whois
  1097. ::match
  1098. ### $bmatch$b <attr> [channel] [[start] limit]
  1099. This displays all user records with the attributes requested.
  1100. "attr" is of the form: <+/-><global>[&/|<channel>[&/|<bot>]]
  1101. Specifying "&" as the separator will cause AND style matching.
  1102. For example:
  1103. '%dmatch p&o'
  1104. This will match all users with both the "p" global flag and the "o" channel
  1105. flag on your current console channel.
  1106. Specifying "|" as the separator will cause OR style matching.
  1107. For example:
  1108. '%dmatch p|o'
  1109. This will match all users with either the "p" global flag or the "o" channel
  1110. flag on your current console channel. If you specify a channel, it will be
  1111. used instead of the current console channel.
  1112. For example:
  1113. '%dmatch p|o #eggdrop'
  1114. This will match all users with either the "p" global flag or the "o" channel
  1115. flag on the channel #eggdrop. You can also match bot flags.
  1116. For example:
  1117. '%dmatch o|o|h'
  1118. This will match all bots with either the "o" global flag, the "o" channel
  1119. flag on the current console channel, or the "h" botflag. You can also limit
  1120. the number of total results returned by specifying a limit at the end of the
  1121. command. A starting point can also be specified.
  1122. For example:
  1123. '%dmatch p&o #eggdrop 16 25'
  1124. This would show results 16 through 25 matching any users with the "p" global
  1125. flag or the "o" channel flag on #eggdrop.
  1126. ### $bmatch$b <wildcard-string> [[start] limit]
  1127. This displays all user records where the user's handle or any of the user's
  1128. hostmasks match the specified wildcard string. You can also limit the number
  1129. of total results returned by specifying a limit at the end of the command. A
  1130. starting point can also be specified.
  1131. For example:
  1132. '%dmatch *.edu 16 25'
  1133. This would show results 16 through 25 matching any users with a hostmask
  1134. that ends with ".edu".
  1135. $bThis command will not match on bots. You must use 'matchbot' for that.$b
  1136. See also: matchbot
  1137. ::matchbot
  1138. ### $bmatchbot$b
  1139. Matches bots.
  1140. See also: match
  1141. ::md5
  1142. ### $bmd5$b <string>
  1143. Returns the MD5 hash of the specified string.
  1144. See also: randstring, sha1, sha256, hash, encrypt, encrypt_fish, decrypt, decrypt_fish
  1145. ::me
  1146. ### $bme$b <text>
  1147. Performs an action on the party line. This appears as "* bryan is leaving",
  1148. etc.
  1149. :leaf:mmode:
  1150. ### $bmmode$b <(+|-)MODE> <#channel> <a|o|v|d|r> [bots=n] [alines=n] [slines=n] [overlap=n] [bitch] [simul] [local]
  1151. For those of us who do not wish to be rocket scientists in the mass mode department,
  1152. a simple '%dmmode -o #channel o' will suffice.
  1153. This is a distributed mass mode command.
  1154. The modes will be distributed among the necesary bots to accomplish the task.
  1155. **Remember, unless specified with [local], the bot you mmode on will never participate.**
  1156. options:
  1157. $ba$b = $ball.$b
  1158. $bo$b = $bops.$b
  1159. $bO$b = $buser-op.$b
  1160. $bv$b = $bvoices.$b
  1161. $bd$b = $bnon-ops.$b
  1162. $br$b = $bregulars (-ov).$b
  1163. $bbitch$b - set +bitch after finished with mmode.
  1164. $bsimul$b - Simulates the mmode. IE: Gives you a practice run, will show who
  1165. does what in the dcc chat window.
  1166. $blocal$b - Modes will not be distributed: Ran on local bot only.
  1167. Use this with caution, and do not expect good results.
  1168. =============================================================================
  1169. don't bother setting the following options unless you REALLY know what you're
  1170. doing, and don't bother messaging me asking me how to use them if you don't.
  1171. =============================================================================
  1172. $bbots$b - Number of bots to use.
  1173. $balines$b - Number of MODE lines to assume each participating bot will get through.
  1174. $bslines$b - Number of MODE lines each participating bot will send.
  1175. $boverlap$b - Number of times to mode on each target nick (using alines for calc).
  1176. bots, alines, slines and overlap are dependant on each other, set them wrong and
  1177. the bot will complain.
  1178. Defaults are alines=1, slines=5, overlap=1. alines will be increased up to 5 if
  1179. there are not enough bots available.
  1180. Examples:
  1181. To mass deop (old style '%dmdop')
  1182. '%dmmode -o #chan o overlap=2'
  1183. To mass voice non-ops
  1184. '%dmmode +v #chan d'
  1185. To mass voice non-ops and non-voices
  1186. '%dmmode +v #chan r'
  1187. See also: mop
  1188. :leaf:mop:
  1189. ### $bmop$b <channel|*>
  1190. Bot will op all users in the specified channel that are valid ops
  1191. for the channel. If '*' is specified, the bot will scan all channels
  1192. and op all users in all channels that are valid ops in each chan.
  1193. See also: whois
  1194. ::motd
  1195. ### $bmotd$b %{+m}<message>%{-}
  1196. This redisplays the partyline Message Of The Day, which was shown when you
  1197. first joined the partyline.
  1198. %{+m}+m: Inclue a message to set the motd.%{-}
  1199. :leaf:msg
  1200. ### $bmsg$b <nickname> <text>
  1201. Sends a private message to someone from the bot, just as if the
  1202. bot had typed /msg.
  1203. See also: botmsg%{+n}
  1204. :hub:netcrontab:
  1205. ### $bnetcrontab$b <status|delete|show|new> [interval]
  1206. Runs the specified command on all linked bots.
  1207. See: crontab
  1208. :hub:netlag:
  1209. ### $bnetlag$b
  1210. Pings all bots over botnet, and displays results.
  1211. See also: lagged
  1212. :hub:netlast:
  1213. ### $bnetlast$b
  1214. All bots on the botnet will display an output from 'last' on
  1215. the user that they are currently running as.
  1216. See also: last
  1217. :hub:netnick:
  1218. ### $bnetnick$b
  1219. All bots on the botnet will display their nick over DCC.
  1220. See also: botnick, nick
  1221. :hub:netps:
  1222. ### $bnetps$b [ps-param]
  1223. Will run 'ps' on each bot on the botnet and returned the
  1224. results. If a params are specified, each bot will use those
  1225. on 'ps'.
  1226. See also: ps
  1227. :hub:netrontab:
  1228. ### $bnetcrontab$b <status|delete|show|new> [interval]
  1229. Runs the specified crontab command on all linked bots.
  1230. See: crontab
  1231. :hub:netserver:
  1232. ### $bnetservers$b
  1233. All bots on the botnet will display their current server and lag
  1234. to that server over DCC.
  1235. See also: botserver, servers%{+n}, set%{-}
  1236. :hub:netversion:
  1237. ### $bnetversion$b <bot>
  1238. All bots on the botnet will display their pack version, and uname.
  1239. See also: botversion, version, about%{+m|m}, status%{-}
  1240. :hub:netw:
  1241. ### $bnetw$b
  1242. All bots on the botnet will run 'w' on their shell and display
  1243. the results over DCC.
  1244. See also: w
  1245. :hub:newleaf:
  1246. ### $bnewleaf$b <handle> [hostmask] [anotherhostmask] ...
  1247. Adds a new leaf to the botnet with the specified handle and hostname.
  1248. Any number of hosts can be specified in the cmd.
  1249. The binary config botline will also be outputted, but should be
  1250. checked for correctness.
  1251. ::newpass
  1252. ### $bnewpass$b <password|rand>
  1253. Changes your password on the bot. This is similar to the '/msg <bot> pass'
  1254. command, except you don't need to specify your old password. If the
  1255. newpassword is 'rand', a random password will be used.
  1256. %{+mi}See also: chpass%{-}%{+n}, chsecpass%{-}
  1257. ::nick
  1258. See: handle
  1259. ::nick:
  1260. ### $bnick$b <bot>
  1261. The bot will display its current nick over DCC.
  1262. See also: botnick, netnick
  1263. :hub:nopass
  1264. ### $bnopass$b [anything]
  1265. Displays all users who do not have a password set.
  1266. Specify any argument to give random passes to users.
  1267. %{+mi}See also: chpass%{-}
  1268. :leaf:op
  1269. ### $bop$b <nickname> [channel|*]
  1270. Will grant chanop to the person you specify, so long as the bot
  1271. is opped on that channel, and the person you specify isn't being
  1272. actively deopped by the bot. Specify * for all channels.
  1273. See also: deop, console
  1274. ::page
  1275. ### $bpage$b <number/off>
  1276. This allows you to slow down the number of lines the bot sends you at once
  1277. via the partyline. When enabled, any commands that send greater than the
  1278. specified number of lines will stop when that number is reached and wait for
  1279. you to type another command (or press enter) to continue. If you have too
  1280. many pending lines, you may be booted off the bot.
  1281. See also: color, console, echo, login, strip
  1282. ::ps:
  1283. ### $bps$b [ps-param]
  1284. Will run 'ps' on the bot's shell and display any results. If
  1285. any params are specified, they will be used.
  1286. %{+i}See also: netps%{-}
  1287. ::quit
  1288. ### $bquit$b [comment]
  1289. This disconnects you from the partyline. If you specify a comment, it will
  1290. be displayed to other partyline users as you leave.
  1291. ::randstring
  1292. ### $brandstring$b <len>
  1293. Displays a random string of length 'len' up to 300 chars.
  1294. See also: md5, sha1, sha256, hash, encrypt, encrypt_fish, decrypt, decrypt_fish
  1295. ::rehash
  1296. ### $brehash$b
  1297. Don't use this cmd, it doesn't do what you think it does, and can result
  1298. in the bot behaving very oddly.
  1299. Reloads config data from binary. (Probably won't be needed as this is
  1300. automatically updated after editing the binary with -C)
  1301. See also: restart
  1302. ::relay
  1303. ### $brelay$b <bot>
  1304. Relays you via telnet to another bot, whether or not it is currently linked.
  1305. The local bot must, however, have a bot record for the bot you wish to
  1306. relay to. Typing '%dquit' or "*bye*" on a line by itself will end the relay.
  1307. See also: bots%{+n}, newleaf%{-}%{+a}, -bot%{-}
  1308. ::reload
  1309. ### $breload$b
  1310. Reloads the bot's user file, discarding any changes made since the last
  1311. $b'%dsave'$b command or hourly user file save.
  1312. See also: save
  1313. :leaf:reset
  1314. ### $breset$b [channel]
  1315. Clears out the bot's channel information and makes it gather the
  1316. information from the server all over again, as if it had just
  1317. joined that channel. It's not really useful much, but could be
  1318. if an odd bug causes the channel information to get scrambled.
  1319. unfortunately this command used to get a lot of use. You can omit
  1320. the channel name to make it reset ALL channels.
  1321. See also: resetbans, resetexempts, resetinvites
  1322. :leaf:resetbans
  1323. ### $bresetbans$b [channel]
  1324. Resets the bot's ban list for the channel. any bans on the channel
  1325. that aren't in the ban list (either the global list or the local
  1326. channel ban list) will be removed, and if there are any bans in the
  1327. global ban list or channel ban list that are not currently on the
  1328. channel, they will be added.
  1329. See also: bans, console%{+m|m}, reset%{-}
  1330. :leaf:resetexempts
  1331. ### $bresetexempts$b [channel]
  1332. Resets the bot's exemption list for the channel. this command
  1333. behaves exactly like resetbans, except it is for exempts.
  1334. See also: resetbans, resetinvites
  1335. :leaf:resetinvites
  1336. ### $bresetinvites$b [channel]
  1337. Resets the bot's invitation list for the channel. this command
  1338. behaves exactly like resetbans, except it is for invites.
  1339. See also: resetbans, resetinvites
  1340. ::restart
  1341. ### $brestart$b
  1342. Makes the bot restart, but keeps it's connection to IRC active.
  1343. See also: rehash, reload, save
  1344. :hub:save
  1345. ### $bsave$b
  1346. This makes the bot write its entire userfile to disk. This is useful if you
  1347. think the bot is about to crash or something, since the user file is only
  1348. written to disk about once an hour.
  1349. See also: reload, backup
  1350. :leaf:say
  1351. ### $bsay$b [channel] <text>
  1352. Dumps the text to your current console channel (or other specified
  1353. channel), as if the bot "said" it.
  1354. ::secpass:
  1355. ### $bsecpass$b <password|rand>
  1356. Changes your secpass on the bot. This is used for Authing via /msg
  1357. and for DCC. If the password is 'rand', a random password will be used.
  1358. %{+mi}See also: chpass%{-}%{+n}, chsecpass%{-}
  1359. :leaf:servers
  1360. ### $bservers$b
  1361. Lists the servers that the bot has in its server list. this is
  1362. the list it rotates through when changing servers. it starts
  1363. with a static list which it loads from its config-file when the
  1364. bot is booted up. after that, you can add servers with the
  1365. $b'%djump'$b command. the server list will indicate which server the
  1366. bot is currently on.
  1367. :hub:set:
  1368. ### $bset$b [<+/->list] [<var> [data|-]]
  1369. Sets various options. Type alone to see all set entries. To set
  1370. an entry do '%dset name VALUE'. Use '-' as a value to clear an entry.
  1371. The <var> may have wildcards. Wildcards will only be used for listing
  1372. variable, not for setting.
  1373. The '+' may be used to add 1 element to a comma separated list. (ie, servers)
  1374. The '-' may be used to remove 1 element from a comma separated list. (ie, servers)
  1375. The 'list' may be used to list a comma separated variable as a vertical listing. (like '%dservers')
  1376. Current variables:
  1377. $uB$u: Boolean (0/1/true/on/false/off)
  1378. $uS$u: String
  1379. $uN$u: Number
  1380. $uL$u: List
  1381. $uR$u: Rate. Set as 'number:interval', ie, '1:5'
  1382. $uD$u: Detected vars have the folloing options: $bignore$b/0, $bwarn$b/1, $breject$b/2,
  1383. $bdie$b/3, $bsuicide$b/4
  1384. [L] $balias$b List of dcc aliases in format '<alias> <cmd> [parms]'. First
  1385. matching alias is used. Normal flag checking is done
  1386. after the alias is expanded.
  1387. $bAliases may not reference other aliases.$b
  1388. [S] $bchanset$b List of default options for when a channel is added. Same format
  1389. as 'chanset'.
  1390. [N] $bserver-port$b Default port to use for server connections.
  1391. [B] $bauth-chan$b If set, auth cmds will work in channels as well as in msg, otherwise
  1392. only in msg.
  1393. [S] $bauth-key$b The authkey used during authing. Give to users if they need to auth.
  1394. (can be bot specific)
  1395. [C] $bauth-prefix$b The prefix character used for msg cmds, ie: $u!$uop or $u.$uop
  1396. [B] $bauth-obscure$b Will not halt on dcc login if pass is wrong. Will display auth hash..
  1397. Will always fail at hash though.
  1398. [N] $bdcc-autoaway$b Time in seconds until a user is set auto-away on dcc.
  1399. (0/- to disable)
  1400. [B] $bmanop-warn$b Warn users via /NOTICE when they msg-op in a channel with manop
  1401. punishments.
  1402. * Msg cmd vars may be left blank to disable usage of cmd.
  1403. [S] $bmsg-op$b Defines the cmd for opping via msging the bot.
  1404. [S] $bmsg-pass$b Defines the cmd for setting a pass via msging the bot.
  1405. [S] $bmsg-invite$b Defines the cmd for requesting invite via msging the bot.
  1406. [S] $bmsg-ident$b Defines the cmd for identing via msging the bot.
  1407. [N] $bfork-interval$b Number of seconds in between each fork() call made by the bot.
  1408. (Resets PID/CPU)
  1409. [R] $bflood-msg$b Msgs:Secs until a host is ignored. (0:0 to disable)
  1410. [R] $bflood-ctcp$b Ctcps:Secs until a host is ignored. (0:0 to disable)
  1411. [R] $bflood-callerid$b Msgs:Secs until triggering to set CALLERID for
  1412. 60 seconds (0:0 to disable)
  1413. [D] $blogin$b How to handle someone logging in to the shell.
  1414. [D] $btrace$b How to handle someone tracing/debugging the bot.
  1415. [D] $bpromisc$b How to handle when an interface is set to promiscuous mode.
  1416. [D] $bhijack$b How to handle when a commonly used hijack method attempt is detected.
  1417. [L] $bservers$b Comma-separated list of servers the bot will use.
  1418. [L] $bservers6$b Comma-separated list of servers the bot will use (FOR IPv6).
  1419. [L] $brbl-servers$b Servers to use for RBL checking in channels that are +rbl.
  1420. [S] $brealname$b The bot's "real name" when connecting. (supports '$n' expansion)
  1421. [S] $busermode$b The bot's usermode on IRC. (Set on connect/rehash)
  1422. [B] $bdeaf$b Runs bot in DEAF mode if the IRCD supports it. This will stop
  1423. the IRCD from sending any channel conversations to the bot.
  1424. This will decrease bandwidth/CPU used, as well as prevent
  1425. sniffing of channels.
  1426. [B] $bcallerid$b Run bot in CALLERID mode. This is commonly known as +g on most
  1427. servers. +c bots will automatically accept messages from
  1428. known users. Note that this will break msg-ident.
  1429. [S] $baltchars$b Define string of characters to cycle when generating alternative
  1430. nicks when nick is taken. Ie: _-`[].
  1431. [S] $bjupenick$b The bot will attempt to jupe this nick. It will never use a variation
  1432. of the nick though. It will still prefer 'nick' over a variation
  1433. of jupenick.
  1434. [S] $bnick$b The bot's preferred nickname on IRC. It will auto rotate and append
  1435. 'altchars' on the end if taken.
  1436. [N] $bnotify-time$b The number of seconds between server notify checks for nick, if
  1437. the server does not support MONITOR.
  1438. [B] $birc-autoaway$b Should the bot go away auto?
  1439. [B] $bident-botnick$b Send botnick instead of shell username on connect (non-ident)
  1440. [B] $boidentd$b Make bot try and use oidentd spoofing as BOTNICK.
  1441. [B] $blink_cleartext$b Allows bots to link without an encryption scheme. This is needed
  1442. for allowing older bots to link in. Be sure to never leave this on
  1443. unless upgrading or letting an older bot link in to upgrade.
  1444. [B] $bdccauth$b Boolean (0 or 1). Set to use auth checking on dcc/telnet login.
  1445. [N] $bop-bots$b Number of bots to ask every time an oprequest is to be made.
  1446. [N] $bin-bots$b Number of bots to ask every time an inrequest is to be made.
  1447. [R] $bop-requests$b (requests:seconds) limits how often the bot will ask for ops.
  1448. [R] $bclose-threshold$b (H:L) When at least H hubs but L or less leafs are linked, close
  1449. all channels.
  1450. [N] $blag-threshold$b Maximum acceptable server lag for the bot to send/honor requests.
  1451. [N] $bkill-threshold$b When more than this many bots have been killed/klined in the last
  1452. minute, close all channels.
  1453. [N] $bfight-threshold$b When more than this many +ob/-ob/kicks have happened on a channel in
  1454. 1 minute, the channel is closed.
  1455. [N] $bcloak-script$b Decides which script the bot cloaks as.
  1456. If set to 0, a random script will be used.
  1457. 1=plain bitchx, 2=crackrock, 3=neonapple, 4=tunnelvision,
  1458. 5=argon, 6=evolver, 7=prevail 8=cypress 9=mIRC 10=other
  1459. * $bExamples$b:
  1460. '%dset realname I have no realname, I'm a bot!'
  1461. '%dbotset wraith realname The best pack evar!'
  1462. '%dset +servers irc.efnet.org'
  1463. '%dset -servers irc.efnet.org'
  1464. '%dset list servers'
  1465. '%dset -servers 10'
  1466. '%dbotset wraith nick -'
  1467. See also: botset
  1468. ::sha1
  1469. ### $bsha1$b <string>
  1470. Returns the SHA1 hash of the specified string.
  1471. See also: randstring, md5, sha256, hash, encrypt, encrypt_fish, decrypt, decrypt_fish
  1472. ::sha256
  1473. ### $bsha256$b <string>
  1474. Returns the SHA256 hash of the specified string.
  1475. See also: randstring, md5, sha1, hash, encrypt, encrypt_fish, decrypt, decrypt_fish
  1476. ::simul
  1477. ### $bsimul$b <handle> <text>
  1478. This allows you to simulate the specified handle typing the given text.
  1479. For example:
  1480. '%dsimul dweeb%d.quit'
  1481. This would appear just as if "dweeb" typed '%dquit'. This command will not
  1482. work unless eggdrop has simul enabled in the config file.
  1483. See also: su
  1484. ::slowjoin:
  1485. ### $bslowjoin$b <channel> <interval-seconds> [channel-options]
  1486. All bots on the botnet will join the channel at the rate of one bot
  1487. per 'interval-seconds'. If any channel-options are specified, the
  1488. channel will be added with those options.
  1489. See also: slowpart, chanset, chaninfo
  1490. ::slowpart:
  1491. ### $bslowpart$b <channel> <interval-seconds>
  1492. All bots on the botnet will part the specified channel at the rate
  1493. of one bot per 'interval-seconds'
  1494. %{+n}See also: slowjoin%{-}
  1495. ::status
  1496. ### $bstatus$b
  1497. ### $bstatus all$b
  1498. Displays a condensed block of status information about the bot.
  1499. is running. For example:
  1500. [01:15] #bryan# status
  1501. I am wtest, running [wraith] Wraith 1.2.3-cvs: 274 users
  1502. Online for 00:33 (terminal mode) CPU 00:01 cache hit 28.3%
  1503. OS: Linux 2.4.30
  1504. Running from: /home/wheel/bryan/.sshrc
  1505. uid: bryan (1000) pid: 25114 homedir: /home/wheel/bryan
  1506. Tempdir : /home/wheel/bryan/.ssh/.../
  1507. Channels: #|DAWG|Net, #|DAWG|Tcl
  1508. Online as: D|Anakha!wcc@cia.nu (|DAWG|Anakha - |DAWG|Net)
  1509. Server irc.inet.tele.dk:6667 (connected for 11 days)
  1510. #|DAWG|Net: 6 members, enforcing "+istn" (lurking)
  1511. #|DAWG|Tcl: 42 members, enforcing "+tn" (lurking)
  1512. The first line tells you the bot's name, what version of Eggdrop it's
  1513. running, the number of users the bot has records of, and the amount of
  1514. memory being used by the userfile. The second line tells you the uptime of
  1515. the bot, CPU time, and cache hit. The third shows the bot's admin, and the
  1516. forth shows its current config file. The fifth line shows what operating
  1517. system the bot is running on. The next two lines show Tcl information. If
  1518. debug mode is enabled, additional info may be shown. Sharing information
  1519. will also be shown if it's being used.
  1520. Select information from modules will be displayed after the core
  1521. information. If you use $b'%dstatus all'$b instead, you will see all status
  1522. information available from loaded modules.
  1523. See also: channel, channels%{+a}, debug%{-}
  1524. ::stick
  1525. ### $bstick$b [ban/exempt/invite] <hostmask/number> [channel]
  1526. Makes a ban, exempt, or invite "sticky". This means that the bot will always
  1527. try to keep it active on the channel. Obviously, if the channel isn't using
  1528. dynamic bans, this has no effect.
  1529. See also: bans, exempts, invites, unstick, +ban, +exempt, +invite
  1530. ::store
  1531. ### $bstore$b
  1532. Stores your console settings so that they are restored automatically the
  1533. next time you join the party line. ('console' calls this auto)
  1534. See also: console
  1535. ::strip
  1536. ### $bstrip$b [modes]
  1537. Allows you to remove embedded 'attribute' codes your partyline output. Valid
  1538. options are:
  1539. $bb$b - remove all boldface codes
  1540. $bc$b - remove all color codes
  1541. $br$b - remove all reverse video codes
  1542. $bu$b - remove all underline codes
  1543. $ba$b - remove all ANSI codes
  1544. $bg$b - remove all ctrl-g (bell) codes
  1545. The mode can also be a modifier like '+c' or '-bu' or '+ru-c'. If
  1546. you omit modes, it will show your current setting.
  1547. NOTE: THIS CMD DOES NOT AFFECT ALL COLORS, PLEASE SEE '%dhelp color'
  1548. See also: fixcodes, color, echo, login, page
  1549. %{+m}
  1550. ### $bstrip$b <user> [modes]
  1551. Set the strip level of another user. A master can't set their own strip
  1552. flags without prefixing the modes with a '+' or '-'.%{-}
  1553. ::su
  1554. ### $bsu$b <user>
  1555. Lets you assume the identity of another user. If you are a global owner,
  1556. this does not require a password. Otherwise, you will be asked for the
  1557. user's password. $b%dquit$b returns you to your original handle.
  1558. ::suicide
  1559. ### $bsuicide$b [reason]
  1560. Makes bot remove itself and then dies. If bot is first bot in it's binary
  1561. it will kill all bots running for that binary.
  1562. See also: die, conf, botcmd
  1563. :leaf:swhois
  1564. ### $bswhois$b [server/nick] <nick>
  1565. Displays a server /whois for the specified nick. Specifying
  1566. the nick twice will display idle time. Specifying a server will
  1567. display the whois as viewed by that server.
  1568. If the nick is currently not online, a /WHOWAS is done automatically.
  1569. This cmd will hide restricted username/channel info as follows:
  1570. -Username will be hidden for higher level users
  1571. -Users will not see +private chans unless they are in the chan or chan is -sp
  1572. -Users will not see channels that are +s or +p unless they have op access there
  1573. See also: find
  1574. :leaf:topic
  1575. ### $btopic$b <text>
  1576. Changes the channel's topic, assuming the bot is a chanop or the
  1577. channel is not +t (uses your current console channel).
  1578. See also: console
  1579. :hub:trace
  1580. ### $btrace$b <bot>
  1581. Sends out a trace signal to another bot. If/when the trace signal returns,
  1582. (and it should!) you will get an output that looks something like this:
  1583. Trace result -> Valis:Stonewall:NoBoty:SomeBoty
  1584. This is a list of the bots connected between you and the destination bot.
  1585. It should also return the time in seconds taken for the trace to occur.
  1586. See also: bots, bottree
  1587. ::traffic
  1588. ### $btraffic$b
  1589. Shows total and daily net traffic stats since the last $b'%drestart'$b.
  1590. Stats groups are IRC, Botnet, Partyline, Transfer.mod and Misc.
  1591. %{+m}See also: restart%{-}
  1592. :leaf:umode
  1593. ### $bumode$b <+flags>
  1594. Sets the given usermode flags for the bot.
  1595. %{+a}
  1596. See also: dump
  1597. %{-}
  1598. ::unlink
  1599. ### $bunlink$b <bot|*> [reason]
  1600. This disconnects the specified bot from the botnet (assuming it was linked
  1601. in the first place). Some bots (sharebots in particular) might not allow you
  1602. to unlink them. If "*" is specified as the parameter, all bots will be
  1603. unlinked.
  1604. See also: %{+n}link, %{-}bots, downbots%{+n}, newleaf, bottree%{-}
  1605. ::unstick
  1606. ### $bunstick$b [ban/exempt/invite] <hostmask/number> [channel]
  1607. Makes a "sticky" ban, exempt, or invite normal again.
  1608. See also: bans, exempts, invites, stick, -ban, -exempt, -invite
  1609. ::update:
  1610. ### $bupdate$b <binary>
  1611. The bot will attempt to start the new binary and kill itself.
  1612. The specified binary will need to be in the same directory
  1613. as the bot is running in.
  1614. See also: whois
  1615. :hub:uplink:
  1616. ### $buplink$b <bot> [uplink]
  1617. Changed a bot's preferred botnet uplink. Leave 'uplink' blank
  1618. to clear a bot's uplink, which will make it stay on any hub
  1619. that it can connect to. An uplink must be a hub-bot.
  1620. See also: hublevel, chaddr
  1621. ::uptime
  1622. ### $buptime$b
  1623. Displays the bot's current uptime.
  1624. See also: status
  1625. ::userlist:
  1626. ### $buserlist$b
  1627. A list of all users is displayed. Users with higher flags than you
  1628. will not appear in the list.
  1629. See also: match, whois
  1630. ::version:
  1631. ### $bversion$b
  1632. Displays the pack version and uname.
  1633. See also: botversion, netversion, about%{+m|m}, status%{-}
  1634. :leaf:voice
  1635. ### $bvoice$b <nickname> [channel|*]
  1636. Will give a +v voice to a person you specify, so long as the
  1637. bot is opped on that channel. Specify * for all channels.
  1638. See also: devoice
  1639. ::w:
  1640. ### $bw$b
  1641. The output of 'w' will be displayed over DCC, bot the shell
  1642. the bot is running on.
  1643. %{+i}See also: netw%{-}
  1644. ::who
  1645. ### $bwho$b [bot]
  1646. Displays a list of users on the local bot.
  1647. For example:
  1648. [23:21] #bryan# who
  1649. Party line members: (* = owner, + = master, @ = op)
  1650. *bryan telnet@xxx.atlaga.adelphia.net (idle 17m)
  1651. *bryan telnet@xxx.atlaga.adelphia.net
  1652. Bots connected:
  1653. -> wortel (05 Dec 16:32) eggdrop v1.6.15 <efnet>
  1654. The first section is people on your current channel (the party line, if you
  1655. haven't changed channels) who are on the bot. A '*' will precede the handle
  1656. if they are a bot owner, "+" if they are a master, "%%" if they are a botnet
  1657. master, or "@" if they are an op. The user's nickname, hostname, and
  1658. possibly an idle time and/or away message will be displayed.%{+n} Owners
  1659. will also see the user's dcc idx.%{-}
  1660. The next section is bots directly linked to the current bot. The arrow
  1661. indicates which bot initiated the connection. The right arrow means this bot
  1662. connected to wortel. A left arrow means the remote bot linked to this bot. A
  1663. '+' next to the arrow indicates that the bot is sharing userfiles with us.
  1664. The connection time (05 Dec 16:32) and bot version are also shown, as well
  1665. as what is specified under "network" in the config file.%{+n} Owners will
  1666. also see the bot's dcc idx.%{-}
  1667. The final section (not shown in example above) is a list of users on the
  1668. local bot who are not on your channel. This will be omitted if there are no
  1669. users on other channels. If you specify the name of a remote bot, for
  1670. example $b'%dwho valis'$b, the who request will be sent to that bot instead.
  1671. The remote bot must be linked to the botnet.
  1672. %{+m}
  1673. Masters may also see "(con <flags>)" after a user's entry, which shows the
  1674. user's console flags/modes (see $b'%dhelp console'$b).
  1675. In the final section (users that aren't on the current channel), masters
  1676. will see the actual channels other users are on. Also, people in the
  1677. filesystem will be listed (as being in channel "files") if the filesys
  1678. module is loaded. A '+' next to the nickname here means the user has
  1679. access to return to the party line.%{-}
  1680. See also: whom
  1681. ::whoami
  1682. ### $bwhoami$b
  1683. Shows your current handle and to what bot you are connected.
  1684. See also: whom
  1685. ::whois:
  1686. ### $bwhois$b [nickname]
  1687. Shows you stored information about a user record.
  1688. If no nickname is specified, your own record is shown. Five headings are
  1689. displayed:
  1690. $bHANDLE$b - the handle (nickname) of the user
  1691. $bBOTNICK$b - This user record is a bot.
  1692. $bPASS$b - "yes" if she has a password set; "no" otherwise
  1693. (bots dont use passwords)
  1694. $bFLAGS$b - the list of flags for this user (see below)
  1695. $bLAST$b - the time or date that the user was last on irc or the partyline
  1696. Valid flags:
  1697. $bd$b = deop (user cannot gain ops in any channel)
  1698. $bk$b = autokick (user is kicked and banned automatically)
  1699. $bo$b = op (user has op access to all of the bot's channels)
  1700. $bq$b = quiet (user cannot gain voice on any channel)
  1701. $bv$b = voice (user gets +v automatically from +y bots)
  1702. Valid user-only flags:
  1703. $ba$b - admin (user has absolute control over botnet minus a few perm-owner only cmds)
  1704. Be careful who you give this to, only the perm-owner of the net should even have it.
  1705. $bi$b - hub access (user has hub DCC access)
  1706. $bj$b - leaf access (user has leaf DCC access)
  1707. $bm$b = master (user has more access to the botnet cmds than a normal user)
  1708. $bn$b = owner (user has just about full access to bot)
  1709. $bO$b = autoop (user is auto-opped in all channels)
  1710. $bp$b - partyline-chat (user can speak on partyline. [$brequires +j or +i$b])
  1711. $bx$b = flood-exempt (user is exempt from flood kicks)
  1712. Valid bot-only flags:
  1713. $bB$b = backup-bot (bot will only join chans marked +backup, see '%dhelp chaninfo')
  1714. $bc$b - chat-bot (bot accepts DCC chat on irc)
  1715. $bf$b = flood-bot (bot reacts to floods based on [cpu intensive] flood settings)
  1716. $bl$b = limit-bot (bot sets limit in all channels, see '%dhelp chaninfo') [$bCPU INTENSIVE$b]
  1717. $br$b = resolve (bot resolves clients in to match against userlist) [$bCPU INTENSIVE+$b]
  1718. $bu$b - update-bot (see doc/UPGRADING)
  1719. $by$b = voice-bot (bot gives out voices/auto-ops in chans) [$bCPU INTENSIVE$b]
  1720. $bFlags followed by a '=' may also be used for a specific channel record.$b
  1721. Hostmasks for the user are displayed on the following lines. If the user is
  1722. a bot, there will be a line below which says "ADDRESS:" and gives the bot's
  1723. telnet address. Some user entries may have "EMAIL:" and "INFO:" entries too.
  1724. There may be additional information displayed depending on the modules
  1725. loaded, such as filesys and console.
  1726. %{+m}
  1727. Masters: if the user has a comment, you will see it under "COMMENT:".%{-}
  1728. See also: match, who, whom%{+m|m}, chattr, chaninfo%{-}
  1729. ::whom
  1730. ### $bwhom$b [channel|*]
  1731. Displays a list of users on the botnet.
  1732. '*' is assumed if no parameters are given.
  1733. For example:
  1734. [23:12] #bryan# whom
  1735. Nick Bot Host
  1736. ---------- --------- --------------------
  1737. *bryan Anakha telnet@xxx.atlaga.adelphia.net [idle 8m]
  1738. *BitchSmack Anakha telnet@xxx.atlaga.adelphia.net
  1739. Total users: 2
  1740. Each user's nickname will be listed in the first column, preceded by a "*"
  1741. if they are a bot owner, "+" if they are a master, "%%" if they are a botnet
  1742. master, or "@" if they are an op. In the next column, the bot the user is
  1743. connected to will be displayed. In the third column, the host is shown. If
  1744. the user is away, the away message will be shown. Likewise, if they are
  1745. idle, their idle time will be displayed.
  1746. To see what users are on a different channel, you may specify a channel
  1747. number/name. If you specify "*" as the channel, all users on all botnet
  1748. channels will be shown.
  1749. See also: who, chat%{+m}, bots%{-}
  1750. ::end