help.txt 82 KB

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