help.txt 83 KB

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