help.txt 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849
  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. ::+exempt
  15. ### %b+exempt%b <hostmask> [channel] [%%<XdXhXm>] [comment]
  16. Adds an exempt to the list of exempts stored on the bot, with optional
  17. comment and exempt time. This exempt is stored with your handle as the
  18. creator, and will be in effect for every channel if no channel is specified.
  19. Exempt time has to be expressed in days, hours, and/or minutes.
  20. See also: exempts, -exempt, stick, unstick
  21. ::+host
  22. ### %b+host%b [handle] <hostmask>
  23. Adds a hostmask to a user's user record. Hostmasks are used to identify your
  24. handle on IRC. If a handle is not specified, the hostmask will be added to
  25. YOUR user record.
  26. See also: -host
  27. ::+ignore
  28. ### %b+ignore%b <hostmask> [%%<XdXhXm>] [comment]
  29. Adds an ignore to the list of ignores stored on the bot, with optional
  30. comment and ignore time. This ignore is stored with your handle as the
  31. creator. Ignore time has to be expressed in days, hours, and/or minutes.
  32. See also: -ignore, ignores
  33. ::+invite
  34. ### %b+invite%b <hostmask> [channel] [%%<XdXhXm>] [comment]
  35. Adds an invite to the list of invites stored on the bot, with optional
  36. comment and invite time. This invite is stored with your handle as the
  37. creator, and will be in effect for every channel if no channel is specified.
  38. Invite time has to be expressed in days, hours, and/or minutes.
  39. See also: invites, -invite, stick, unstick
  40. ::+noteign
  41. ### %b+noteign%b%{+m} [user]%{-} <ignoremask>
  42. Add a new ignore to the user's note ignore list.
  43. See also: -noteign noteigns
  44. ::+user
  45. ### %b+user%b <handle> [hostmask]
  46. Creates a new user record for the handle given. The new user record will
  47. have no flags, an optional hostmask, and a random pass/secpass.
  48. See also: -user, +host, -host%(hub)%{+n}, newleaf
  49. ::-ban
  50. ### %b-ban%b <banmask or number> [channel]
  51. Removes the specified ban from the list of bans stored on the bot. You may
  52. also reference the ban by the number shown by the 'bans' command.
  53. See also: bans, +ban, stick, unstick
  54. :hub:-bot
  55. ### %b-bot%b <bot>
  56. This is exactly the same as %b'%d-user'%b (it removes a user record). It is
  57. included for convenience.
  58. See also: +user, -user%{+n}, newleaf
  59. ::-chan
  60. ### %b-chan%b <channel>
  61. This removes ALL information about a channel from the bot.
  62. %f*** IMPORTANT ***%f
  63. This erases ALL information about the channel, including channel settings,
  64. bans, exempts, invites, and channel records for users -- %bEVERYTHING%b.
  65. %bDO NOT%b use it to have the bot temporarily leave a channel. This
  66. command is for abandoning a channel (e.g. the channel will have to be
  67. redefined and all user flags for that channel will have to be redone.
  68. If you want to do this try '%dcycle' or '%ddown'
  69. See also: +chan, chanset, chaninfo, cycle, down
  70. ::-exempt
  71. Removes the specified exempt from the list of exempts stored on the bot. You
  72. may also reference the exempt by the number shown by the 'exempts' command.
  73. See also: exempts, +exempt, stick, unstick
  74. ::-host
  75. ### %b-host%b <hostmask>
  76. Removes a host from your handle.
  77. %{+m|m}
  78. ### %b-host%b <handle> <hostmask>
  79. Removes a hostmask from a user's user record.
  80. %{-}
  81. See also: +host
  82. ::-ignore
  83. ### %b-ignore%b <hostmask/number>
  84. Removes the specified ignore from the list of ignores stored on the bot. You
  85. may also reference the ignore by the number shown by the 'ignores' command.
  86. See also: +ignore, ignores
  87. ::-invite
  88. ### %b-invite%b <hostmask or number>
  89. Removes the specified invite from the list of invites stored on the bot. You
  90. may also reference the invite by the number shown by the 'invites' command.
  91. See also: invites, +invite, stick, unstick
  92. ::-noteign
  93. ### %b-noteign%b%{+m} [user]%{-} <ignoremask>
  94. Remove an existing ignore from the user's note ignore list.
  95. See also: +noteign noteigns
  96. ::-user
  97. ### %b-user%b <handle>
  98. Removes the specified handle's user record.
  99. See also: +user%(hub)%{+a}, -bot%{+n}, newleaf
  100. :leaf:act
  101. ### %bact%b [channel] <text>
  102. Performs an action on the current console channel (or otherwise
  103. specified channel), as if the bot did it. Just like the /me
  104. command in IRC.
  105. See also: console
  106. ::addlog
  107. ### %baddlog%b <text>
  108. Adds your comment to the bot's logfile. Bot masters can go back later and
  109. review the log, and will see your comment (with your handle attached). This
  110. is useful for explaining confusing activity.
  111. :leaf:adduser
  112. ### %badduser%b [!]<nickname> [handle]
  113. Creates a new user record for a user on the channel, using their
  114. current hostname. It's similar to a user msg'ing the bot 'hello'
  115. except that no information is sent to that user. If the bot
  116. already knows someone by that nickname, and the user on the channel
  117. doesn't have a bot record, then it does the equivalent of an
  118. 'ident' for that user -- except that, again, no information is
  119. sent to the user telling them that anything was done.
  120. If the user is using a different nickname than the bot normally
  121. knows her by, you can specify her "handle" (the nickname that the
  122. bot remembers).
  123. If you want to add a user using a static hostmask, prefix their nick
  124. with a '!'. i.e. .adduser !Lamer
  125. See also: +host, -host%{+m}, +user, -user%{-}
  126. ::away
  127. ### %baway%b [reason]
  128. Marks you as "away" on the party line. Your away message will show up in
  129. the %b'%dwho'%b list, and will be displayed to anyone who tries to send you
  130. a note. Your notes will be stored, and then displayed to you as soon as you
  131. are no longer away. Saying something on the party line will automatically
  132. remove your "away" status, or you can type %b'%dback'%b or %b'%daway'%b by
  133. itself.
  134. See also: back
  135. ::back
  136. ### %bback%b
  137. This marks you as no longer away on the party line.
  138. See also: away
  139. :hub:backup
  140. ### %bbackup%b
  141. This makes the bot write a backup of its entire user list to the disk.
  142. This is useful if you feel the need to backup the userfile and channel
  143. settings.
  144. See also: reload, save
  145. ::bans
  146. ### %bbans%b [[channel/all]/wildcard]
  147. Shows you a list of the global bans active on the current channel, and the
  148. list of channel-specific bans, as well as any bans that are on the channel
  149. but weren't placed by the bot.
  150. Here's a sample entry;
  151. [ 5] *!*habib@*frys.com (perm)
  152. paulie: revolving check policy
  153. Created 15:10
  154. The number (5) can be used to reference the ban if you wish to remove it
  155. (see %b'-ban'%b). Next is the actual hostmask being banned. The "(perm)"
  156. means that the ban is "permanent": that is, it doesn't automatically expire.
  157. If there is an elapsed time showing instead, the time displayed is how long
  158. the ban has been active. These types of bans expire after two hours. The
  159. second line of the ban entry is the comment ("revolving check policy"), and
  160. who set the ban (paulie). The last line shows when the ban was added, and
  161. possibly the last time the ban was activated on the channel (if it's
  162. different from the creation time).
  163. Sometimes there will be a "!" or "*" right before the number. A "!" means
  164. the ban is in the bot's ban list, but is not currently on the channel. A "*"
  165. marks a ban which is NOT in the bot's ban list but IS on the channel.
  166. If you use 'bans' without an argument, it will show you only the bans which
  167. are currently active on the channel. If you use 'bans all', it will show you
  168. every ban in the global ban list and on the channel. If you use 'bans
  169. <wildcard>', it will list all bans (active or not) that match against your
  170. wildcard. Consider it a 'bans all' list matched against your wildcard.
  171. The ban list may change according to which channel you're currently viewing
  172. in the console. Different bans may be active on different channels. If you
  173. specify a channel name, that channel will be used instead of your current
  174. console channel.
  175. See also: -ban, +ban, console%{+m|m}, chanset, chaninfo%{-}, stick, unstick
  176. :hub:binds
  177. ### %bbinds%b [type/match] [all]
  178. Shows the Tcl bindings in effect, in a list similar to this:
  179. Command bindings:
  180. TYPE FLGS COMMAND HITS BINDING (TCL)
  181. msg -|- rose 0 msg_rose
  182. msg -|- go 0 msg_go
  183. dcc m|- bind 0 cmd_bind
  184. pub -|- gross 0 pub_gross
  185. The fields should be self-explanatory, except for HITS, which records the
  186. number of times that binding has been called. If not, go read the file
  187. %b'doc/tcl-commands.doc'%b for help on the Tcl bind command. Note that the
  188. builtin commands are now shown. You may also specify a type of binding to
  189. show (i.e. %b'%dbinds msg'%b) or you can specify a wild card match (i.e.
  190. %b'%dbinds *seen*'%b) if you want to narrow the field a bit. The wild card
  191. matches will match against the TYPE, COMMAND and BINDING fields. You can
  192. view more binds by adding 'all' to the end of the command.
  193. See also: tcl
  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, though it may be rejected if that bot does not allow
  199. remote boots. You can not boot a bot owner.
  200. :hub:botinfo
  201. ### %bbotinfo%b
  202. Requests information from every bot currently on the botnet. Each bot should
  203. eventually send you one line containing its version, network setting,
  204. channels, and uptime.
  205. See also: %{+n}bottree, vbottree%{+m}, bots
  206. :hub:bots
  207. ### %bbots%b
  208. Shows the list of bots currently on the botnet.
  209. Example:
  210. Bots: cEvin, ruthie, Killa1
  211. There is no indication of which bots are directly connected to this current
  212. bot. %{+n}Use %b'%dwho'%b or %b'%dbottree'%b for that information.%{-}
  213. See also: downbots%{+n}, bottree, vbottree%{-}, botinfo
  214. :hub:bottree
  215. ### %bbottree%b
  216. Shows a tree-format diagram of the bots currently on the botnet. It's just a
  217. nice way to get a feel for how the bots are physically connected. If 2 bots
  218. are sharing, a + will be indicated, or a ? if nothing is known.
  219. See also: bots, downbots, botinfo, vbottree
  220. :hub:chaddr
  221. ### %bchaddr%b <bot> <address[:bot port[/user port]]>
  222. Changes the address for a bot. This is the address your bot will try to
  223. connect to when linking. If the bot has a separate port for bots and users,
  224. they should be separated by a slash (/).
  225. %{+a}
  226. It is not recommneded that this is used, you should change your source,
  227. and update all bots instead.
  228. %{-}
  229. See also: link
  230. :leaf:channel
  231. ### %bchannel%b [channel-name]
  232. Shows you an extensive display of the users on a channel, and
  233. the current channel attributes. By default, it shows you the
  234. channel you are currently viewing on the console, but you can
  235. specify another channel if you wish.
  236. The first line will look like:
  237. Channel #hiya, 8 members, 45 users, mode +tn:
  238. This means that the bot is sitting on channel #hiya, where 8
  239. other irc'ers are. There are 45 people that the bot knows by
  240. hostmask, and the channel mode is +tn. If the bot isn't on
  241. the channel it is supposed to be on, it will say "Desiring
  242. channel #hiya" instead. Next is a list of the users on the
  243. channel, with each entry looking like this:
  244. NICKNAME HANDLE JOIN HOPS IDLE USER@HOST
  245. @kantSF kantSF 14:53 o 2 6m josh@random.edu
  246. The "@kantSF" means that the user's nickname is kantSF and that
  247. he is a chanop. The second "kantSF" is the nickname that the
  248. bot knows him by. Sometimes this will differ from the nickname
  249. a person is using. The time displayed is the time the user
  250. joined the channel. The next field is the attributes:
  251. n - bot owner o - can get ops (+o)
  252. m - bot master or owner f - channel friend
  253. b - another bot d - cannot get ops (+d)
  254. The last field is the user@host he is using irc from.
  255. See also: status, whois
  256. ::chanset
  257. ### %bchanset%b <channel> <settings>
  258. Allows you to change the channel settings (see %b'chaninfo'%b for the
  259. settings) for one specific channel or all channels. Use '*' to to apply the
  260. change to all channels.
  261. Changes are used until the next restart, and are saved
  262. whenever the userfile is saved.
  263. See also: %{+n}+chan, -chan%{-}, chaninfo
  264. ::chat
  265. ### %bchat%b <on/off>
  266. ### %bchat%b <[*]channel number/name>
  267. Changes your current channel on the partyline. When you first connect to
  268. the partyline, it places you on channel 0 (the main party line).
  269. Some channels may have assigned names if the assoc module is loaded. For
  270. these, you can specify the channel by name instead of channel number if
  271. you wish.
  272. %b'%dchat off'%b removes you from all channels, including the main party line.
  273. You can still use bot commands and see the console, but you can't talk to
  274. anyone except via %b'%dnote'%b. %b'%dchat on'%b returns you to the main party
  275. line (channel 0) if you were elsewhere.
  276. If you prefix the channel with a '*', you will join a local channel.
  277. See also: console
  278. ::chattr
  279. ### %bchattr%b <handle> [flags] [channel]
  280. This lets you view and change the flags for a user.
  281. For example, to give Lamer the p and f flags:
  282. .chattr Lamer +pf
  283. To remove Denali from the global op list:
  284. .chattr Denali -o
  285. You may also do any combination of the above:
  286. .chattr Fred1 -m+xj-o
  287. You can also change the flags for Usagi on a specific channel by supplying
  288. the channel after the attributes:
  289. .chattr Usagi -m+dk-o #blah
  290. Changing global and channel specific flags within the same command line is
  291. also possible (global +f, +o #lamer):
  292. .chattr Bill f|o #lamer
  293. Whether or not you change any flags, it will show you the user's attributes
  294. afterwards. To get a list of all possible flags, see %b'%dhelp whois'%b.
  295. %bNOTES:%b Only the owner may add or remove the 'a' (admin) or 'n' (owner) flags.
  296. It is pointless to -a a permanent owner.
  297. You must remove the permanent owner in the binary.
  298. See also: whois
  299. :hub:chhandle
  300. ### %bchhandle%b <oldhandle> <newhandle>
  301. Changes the handle of a user. For example, to change the handle of user
  302. 'gavroche' to 'jamie', you would use 'chhandle gavroche jamie'.
  303. See also: chpass%{+n}, chsecpass
  304. ::chinfo
  305. ### %bchinfo%b <user> [channel] [info-line/none]
  306. Sets the information line for a user. This line is shown via the /msg
  307. commands %b'who'%b and %b'whois'%b. If you have set greet on, it is also
  308. shown when the user joins the channel. If the info line begins with an '@',
  309. then it is "locked", and that user may no longer change it. If the channel
  310. name is omitted, the default info line is changed. If you specify 'none'
  311. as the info-line, it will be erased.
  312. See also: info
  313. :hub:chpass
  314. ### %bchpass%b <handle> [newpassword]
  315. Changes a user's password. If you do not specify the new password, the user
  316. effectively no longer has a password set. A password is needed to get ops,
  317. join the party line, etc. If the newpassword is 'rand', a random password
  318. will be used.
  319. See also: chhandle%{+n}, chsecpass
  320. ::comment
  321. ### %bcomment%b <user> <comment>
  322. Creates or changes the comment field for a user. The comment field can only
  323. be seen via 'whois' or 'match'. Non-masters cannot see the comment field.
  324. Using the comment 'none' will clear a user's comment.
  325. :hub:dccstat
  326. ### %bdccstat%b
  327. Displays a table-format list of all "dcc" connections in use on the bot.
  328. Dcc stands for "Direct Client-to-client Communication", and Eggdrop expands
  329. this to cover every open socket. Any type of network connection to the bot
  330. is considered a "dcc" connection.
  331. The headings of the table are:
  332. %bSOCK%b the socket number of this connection (always unique)
  333. %bADDR%b the ip address mask of the host the bot is connected to, if
  334. applicable
  335. %bPORT%b the port number being used for this connection
  336. %bNICK%b the handle of the user or bot, if applicable
  337. %bHOST%b the hostname corresponding to the IP address, if available
  338. %bTYPE%b the type of dcc connection (see below)
  339. The types of connections currently possible are as follows (but more are
  340. being added all the time):
  341. %bCHAT%b dcc-chat partyline user
  342. %bPASS%b user entering dcc chat (being asked for password)
  343. %bSEND%b user sending a file
  344. %bGET%b sending a file to a user
  345. %bGETP%b pending get (waiting for the user to acknowledge)
  346. %bLSTN%b telnet listening port (in place of a hostname, it will show the
  347. callback procedure name, or a mask of acceptable handles)
  348. %bT-IN%b incoming telnet user (being asked for handle)
  349. %bFILE%b user in dcc-chat file area
  350. %bBOT%b connected bot (botnet connection)
  351. %bBOT*%b pending bot link (waiting for acknowledgement)
  352. %bRELA%b user in relay connection to another bot
  353. %b>RLY%b bot being relay'd to (one for each "RELA")
  354. %bCONN%b pending telnet connection (chat, relay, bot-link, etc)
  355. %bNEW%b new user via telnet (entering a handle)
  356. %bNEWP%b new user via telnet (entering a password)
  357. In addition, 'CHAT' and 'BOT' have flags listed for each connection. Capital
  358. letters mean that the flag is on, and lowercase letters mean that the flag
  359. is off. The flags for 'CHAT' are:
  360. %bC%b in file area, but allowed to return to party line
  361. %bP%b party line access only
  362. %bT%b telnet connection (instead of dcc chat)
  363. %bE%b echo is on
  364. %bP%b paging is on
  365. %b6%b socket is ipv6
  366. The flags for 'BOT' are:
  367. %bP%b ping sent, waiting for reply
  368. %bU%b user-file sharing is active
  369. %bC%b local bot initiated the connection
  370. %bO%b user-file offered, waiting for reply
  371. %bS%b in the process of sending the user-file
  372. %bG%b in the process of getting the user-file
  373. %bW%b warned this bot to stop hubbing
  374. %bL%b leaf-only bot (not allowed to be a hub)
  375. %bI%b bot is currently in the 'linking' stage
  376. %bA%b bot is being aggressively shared with
  377. For 'CHAT' users, the party-line channel is also listed.
  378. ::debug
  379. ### %bdebug%b
  380. Display a dump of memory allocation information, assuming the bot was
  381. compiled with memory debugging. It's useless to anyone but developers
  382. trying to find memory leaks.
  383. :leaf:deluser
  384. ### %bdeluser%b <nickname>
  385. deletes a user record for a user on the channel, using their
  386. current hostname. Channel masters can remove users so long as
  387. the user isn't a bot master.
  388. see also: adduser%{+m}, +user, -user%{-}
  389. ::die
  390. ### %bdie%b [reason]
  391. This kills the bot. The bot goes offline immediately, logging who issued
  392. the 'die' command. You shouldn't have to use this too often. If you specify
  393. a reason, it is logged, otherwise the reason is "authorized by <handle>".
  394. ::echo
  395. ### %becho%b <on/off>
  396. Specifies whether you want your messages echoed back to you. If it's on,
  397. then when you say something on the party line, it will be displayed to you
  398. just like everyone else will see it. If it's off, then it won't happen.
  399. See also: color
  400. ::exempts
  401. ### %bexempts%b [[channel/all]/wildcard]
  402. Shows you a list of the global exempts active on the current channel, and
  403. the list of channel-specific exempts, as well as any exempts that are on the
  404. channel but weren't placed by the bot.
  405. Here's a sample entry;
  406. ! [ 3] *!test@test.com (perm)
  407. Wcc: requested
  408. Created 01:15
  409. The number (3) can be used to reference the exempt if you wish to remove it
  410. (see %b'-exempt'%b). Next is the actual hostmask being exempted. The "(perm)"
  411. means that the exempt is "permanent": that is, it doesn't automatically
  412. expire. If there is an elapsed time showing instead, the time displayed is
  413. how long the exempt has been active. These types of exempts expire after one
  414. hour. The second line of the exempt entry is the comment ("requested"), and
  415. who set the exempt (Wcc). The last line shows when the exempt was added, and
  416. possibly the last time the exempt was activated on the channel (if it's
  417. different from the creation time).
  418. Sometimes there will be a "!" or "*" right before the number. A "!" means
  419. the exempt is in the bot's exempt list, but is not currently on the channel.
  420. A "*" marks an exempt which is NOT in the bot's exempt list but IS on the
  421. channel.
  422. If you use 'exempts' without an argument, it will show you only the exempts
  423. which are currently active on the channel. If you use 'exempts all', it will
  424. show you every exempt in the global exempt list and on the channel. If you
  425. use 'exempts <wildcard>', it will list all exempts (active or not) that
  426. match against your wildcard. Consider it a 'exempts all' list matched
  427. against your wildcard.
  428. The exempt list may change according to which channel you're currently
  429. viewing in the console. Different exempts may be active on different
  430. channels. If you specify a channel name, that channel will be used instead
  431. of your current console channel.
  432. See also: -exempt, +exempt, console%{+m|m}, chanset, chaninfo%{-}, stick, unstick
  433. ::fixcodes
  434. ### %bfixcodes%b
  435. This is for use in situations where the bot gets mixed up about the type
  436. of connection you have with it. For example, you /CTCP CHAT the bot and
  437. it thinks you are connecting via telnet, and you see text displayed as
  438. "Local time is now 17:17" for example instead of "Local time is
  439. now 17:17". Use this to turn telnet codes on or off/change the display
  440. mode.
  441. ::fwd
  442. ### %bfwd%b <handle> [desto]
  443. This allows you to set a note forwarding address for a user,
  444. this means if a note needs to be stored for the user, the
  445. bot will attempt to pass it on to the given user@bot, if
  446. the bot is not online then the note is still stored locally,
  447. if the other user doesn't exist, the note is lost. Boohoo.
  448. ::handle
  449. ### %bhandle%b <new-handle>
  450. Changes your handle on the bot. This is the handle (nickname) that the
  451. bot will know you as from this point forward. It is used to log into the
  452. bot.
  453. See also: newpass%{+m}, %(hub)chhand, chpass%{+n}, chsecpass
  454. ::ignores
  455. ### %bignores%b [wildcard]
  456. Shows a list of hostmasks from which the bot is currently ignoring msgs,
  457. notices, etc. There are two types of ignores: permanent and temporary.
  458. Permanent ignores never automatically expire. You must use %b'%d-ignore'%b
  459. to remove them.
  460. Here is a sample permanent ignore:
  461. [ 1] *!*@217.156.44.184 (perm)
  462. Wcc: go away
  463. Started 523 days ago
  464. The number (1) can be used to reference the ignore if you wish to remove it
  465. (see %b'%dhelp -ignore'%b). Next is the actual hostmask being ignored. The
  466. "(perm)" means that the ignore is "permanent": that is, it doesn't
  467. automatically expire. The second line of the ignore entry is the comment
  468. ("go away"), and who set the ban (Wcc). The last line shows when the ignore
  469. was added.
  470. Here is a sample temporary ignore:
  471. [ 10] blah!blah@blah.cc (expires in 1 day)
  472. Wcc: requested
  473. Started 18:02
  474. Here, you see the "perm" in the parentheses next to the hostmask is instead
  475. an expire time. This means that the ignore will expire automatically in one
  476. day.
  477. If you use %b'%dignores <wildcard>'%b, it will list all the ignores
  478. that match against your wildcard.
  479. See also: +ignore, -ignore
  480. ::info
  481. ### %binfo%b [channel] [info-line]
  482. Sets your info line. This line is shown via the /msg commands %b'who'%b and
  483. %b'whois'%b. If you have set greet on, it is also shown when you joins the
  484. channel. If the info line begins with an '@', then it is "locked", and tou
  485. may no longer change it.
  486. %{+m|m}See also: chinfo%{-}
  487. ::invites
  488. ### %binvites%b [[channel/all]/wildcard]
  489. Shows you a list of the global invites active on the current channel, and
  490. the list of channel-specific invites, as well as any invites that are on the
  491. channel but weren't placed by the bot.
  492. Here's a sample entry;
  493. ! [ 3] *!test@test.com (perm)
  494. Wcc: requested
  495. Created 01:15
  496. The number (3) can be used to reference the invite if you wish to remove it
  497. (see %b'-invite'%b). Next is the actual hostmask being invited. The "(perm)"
  498. means that the invite is "permanent": that is, it doesn't automatically
  499. expire. If there is an elapsed time showing instead, the time displayed is
  500. how long the invite has been active. These types of invites expire after one
  501. hour. The second line of the invite entry is the comment ("requested"), and
  502. who set the invite (Wcc). The last line shows when the invite was added, and
  503. possibly the last time the invite was activated on the channel (if it's
  504. different from the creation time).
  505. Sometimes there will be a "!" or "*" right before the number. A "!" means
  506. the invite is in the bot's invite list, but is not currently on the channel.
  507. A "*" marks an invite which is NOT in the bot's invite list but IS on the
  508. channel.
  509. If you use 'invites' without an argument, it will show you only the invites
  510. which are currently active on the channel. If you use 'invites all', it will
  511. show you every invite in the global invite list and on the channel. If you
  512. use 'invites <wildcard>', it will list all invites (active or not) that
  513. match against your wildcard. Consider it a 'invites all' list matched
  514. against your wildcard.
  515. The invite list may change according to which channel you're currently
  516. viewing in the console. Different invites may be active on different
  517. channels. If you specify a channel name, that channel will be used instead
  518. of your current console channel.
  519. See also: -invite, +invite, console%{+m|m}, chanset, chaninfo%{-}, stick, unstick
  520. :leaf:kick
  521. ### %bkick%b [channel] <nickname> [reason]
  522. will kick a user off your current console channel (or specified
  523. other channel) with the comment given. if you omit the reason,
  524. the default kick comment is "requested".
  525. See also: kickban, console
  526. :leaf:kickban
  527. ### %bkickban%b [channel] [-|@]<nickname> [comment]
  528. kicks a user off the channel and bans her by a reasonable host-
  529. mask. your nickname will be attached to the ban in the bot's
  530. internal ban list, and the ban will last for whatever is set in
  531. ban-time -- only on this channel. use %b'.+ban'%b for a more
  532. permanent ban which will be activated on every channel the bot
  533. monitors. if you use a comment, that will also be attached to
  534. the ban in the ban list, and used as the kick comment.
  535. appending a prefix of ! or @ to a nickname changes the ban
  536. mask used:
  537. e.g. with a host of nick!ident@host.name.domain
  538. command banmask
  539. .kickban nick *!*dent@*.name.domain
  540. .kickban -nick *!*dent@host.name.domain
  541. .kickban @nick *!*@host.name.domain
  542. with a host of nick!~ident@host.name.domain (strict-host set to 1)
  543. command banmask
  544. .kickban nick *!*ident@*.name.domain
  545. .kickban -nick *!*ident@host.name.domain
  546. See also: +ban, bans, stick
  547. :hub:link
  548. ### %blink%b [via-bot] <bot-to-link>
  549. Attempts to link to another hub. This command is deprecated and not
  550. recommended for use.
  551. See also: unlink, newleaf%{+a}, -bot
  552. ::match
  553. ### %bmatch%b <attr> [channel] [[start] limit]
  554. This displays all user records with the attributes requested.
  555. "attr" is of the form: <+/-><global>[&/|<channel>[&/|<bot>]]
  556. Specifying "&" as the separator will cause AND style matching.
  557. For example:
  558. .match p&o
  559. This will match all users with both the "p" global flag and the "o" channel
  560. flag on your current console channel.
  561. Specifying "|" as the separator will cause OR style matching.
  562. For example:
  563. .match p|o
  564. This will match all users with either the "p" global flag or the "o" channel
  565. flag on your current console channel. If you specify a channel, it will be
  566. used instead of the current console channel.
  567. For example:
  568. .match p|o #eggdrop
  569. This will match all users with either the "p" global flag or the "o" channel
  570. flag on the channel #eggdrop. You can also match bot flags.
  571. For example:
  572. .match o|o|h
  573. This will match all bots with either the "o" global flag, the "o" channel
  574. flag on the current console channel, or the "h" botflag. You can also limit
  575. the number of total results returned by specifying a limit at the end of the
  576. command. A starting point can also be specified.
  577. For example:
  578. .match p&o #eggdrop 16 25
  579. This would show results 16 through 25 matching any users with the "p" global
  580. flag or the "o" channel flag on #eggdrop.
  581. ### %bmatch%b <wildcard-string> [[start] limit]
  582. This displays all user records where the user's handle or any of the user's
  583. hostmasks match the specified wildcard string. You can also limit the number
  584. of total results returned by specifying a limit at the end of the command. A
  585. starting point can also be specified.
  586. For example:
  587. .match *.edu 16 25
  588. This would show results 16 through 25 matching any users with a hostmask
  589. that ends with ".edu".
  590. ::me
  591. ### %bme%b <text>
  592. Performs an action on the party line. This appears as "* Wcc is leaving",
  593. etc.
  594. ::motd
  595. ### %bmotd%b %{+m}<message>%{-}
  596. This redisplays the partyline Message Of The Day, which was shown when you
  597. first joined the partyline.%{+m} Inclue a message to set the motd.
  598. :leaf:msg
  599. ### %bmsg%b <nickname> <text>
  600. sends a private message to someone from the bot, just as if the
  601. bot had typed /msg.
  602. %{+n}See also: netmsg%{-}
  603. ::newpass
  604. ### %bnewpass%b <password>
  605. Changes your password on the bot. This is similar to the '/msg <bot> pass'
  606. command, except you don't need to specify your old password.
  607. %(hub)%{+m}See also: chpass%{+n}, chsecpass
  608. ::note
  609. ### %bnote%b <nickname[@bot]> <message>
  610. sends a private note to a user on the party line. if that user
  611. is currently on the party line, and not marked as away, she will
  612. receive the message immediately. otherwise it may be stored
  613. and displayed the next time that user joins the party line. if
  614. you join the channel, and have notes stored for you on the bot,
  615. it will tell you. to send a note to someone on a different bot,
  616. use "nick@bot" for the nickname.
  617. See also: whom, notes, noteigns
  618. ::note
  619. ### %bnote%b <nickname[@bot]> <message>
  620. Sends a private note to a user on the partyline. If that user is currently
  621. logged in and not marked as away, the message will be received immediately.
  622. Otherwise, it will be stored and displayed the next time that user joins the
  623. partyline. To send a note to someone on a different bot, add "nick@bot" to
  624. the nickname.
  625. See also: whom, notes
  626. ::noteigns
  627. ### %bnoteigns%b%{+m} [user]%{-}
  628. List all note ignores. All notes sent from users who match one of the
  629. ignore masks will be rejected.
  630. See also: +noteign -noteign
  631. ::page
  632. ### %bpage%b <number/off>
  633. This allows you to slow down the number of lines the bot sends you at once
  634. via the partyline. When enabled, any commands that send greater than the
  635. specified number of lines will stop when that number is reached and wait for
  636. you to type another command (or press enter) to continue. If you have too
  637. many pending lines, you may be booted off the bot.
  638. ::quit
  639. ### %bquit%b [comment]
  640. This disconnects you from the partyline. If you specify a comment, it will
  641. be displayed to other partyline users as you leave.
  642. ::relay
  643. ### %brelay%b <botname>
  644. Relays you via telnet to another bot, whether or not it is currently linked.
  645. The local bot must, however, have a bot record for the bot you wish to
  646. relay to. Typing .quit or "*bye*" on a line by itself will end the relay.
  647. See also: bots%{+n}, newleaf%{+a}, -bot
  648. ::reload
  649. ### %breload%b
  650. Reloads the bot's user file, discarding any changes made since the last
  651. %b'%dsave'%b command or hourly user file save. Sharebots should probably
  652. never do this.
  653. See also: save
  654. :leaf:reset
  655. ### %breset%b [channel]
  656. clears out the bot's channel information and makes it gather the
  657. information from the server all over again, as if it had just
  658. joined that channel. it's not really useful much, but could be
  659. if an odd bug causes the channel information to get scrambled.
  660. unfortunately this command used to get a lot of use. you can omit
  661. the channel name to make it reset ALL channels.
  662. :leaf:resetbans
  663. ### %bresetbans%b [channel]
  664. resets the bot's ban list for the channel. any bans on the channel
  665. that aren't in the ban list (either the global list or the local
  666. channel ban list) will be removed, and if there are any bans in the
  667. global ban list or channel ban list that are not currently on the
  668. channel, they will be added.
  669. See also: bans, console%{+m|m}, reset
  670. :leaf:resetexempts
  671. ### %bresetexempts%b [channel]
  672. resets the bot's exemption list for the channel. this command
  673. behaves exactly like resetbans, except it is for exempts.
  674. See also: resetbans, resetinvites
  675. :leaf:resetinvites
  676. ### %bresetinvites%b [channel]
  677. resets the bot's invitation list for the channel. this command
  678. behaves exactly like resetbans, except it is for invites.
  679. See also: resetbans, resetinvites
  680. ::restart
  681. ### %brestart%b
  682. Restarts the Tcl interpreter, wipes all timers, reloads all modules, and
  683. reloads the config file for the bot (which resets any changes made via the
  684. %b'%dset'%b command and reloads any Tcl scripts your config loads). As with
  685. the %b'%drehash'%b command, it also saves and reloads the user file from disk.
  686. See also: reload, save
  687. :hub:save
  688. ### %bsave%b
  689. This makes the bot write its entire userfile to disk. This is useful if you
  690. think the bot is about to crash or something, since the user file is only
  691. written to disk about once an hour.
  692. See also: reload, backup
  693. :leaf:say
  694. ### %bsay%b [channel] <text>
  695. dumps the text to your current console channel (or other specified
  696. channel), as if the bot "said" it.
  697. ::simul
  698. ### %bsimul%b <handle> <text>
  699. This allows you to simulate the specified handle typing the given text.
  700. For example:
  701. %dsimul dweeb%d.quit
  702. This would appear just as if "dweeb" typed "%dquit". This command will not
  703. work unless eggdrop has simul enabled in the config file.
  704. See also: su
  705. ::stick
  706. ### %bstick%b [ban/exempt/invite] <hostmask/number> [channel]
  707. Makes a ban, exempt, or invite "sticky". This means that the bot will always
  708. try to keep it active on the channel. Obviously, if the channel isn't using
  709. dynamic bans, this has no effect.
  710. See also: bans, exempts, invites, unstick, +ban, +exempt, +invite
  711. ::strip
  712. ### %bstrip%b [modes]
  713. Allows you to remove embedded 'attribute' codes your partyline output. Valid
  714. options are:
  715. %bb%b - remove all boldface codes
  716. %bc%b - remove all color codes
  717. %br%b - remove all reverse video codes
  718. %bu%b - remove all underline codes
  719. %ba%b - remove all ANSI codes
  720. %bg%b - remove all ctrl-g (bell) codes
  721. The mode can also be a modifier like '+c' or '-bu' or '+ru-c'. If
  722. you omit modes, it will show your current setting.
  723. See also: fixcodes, color, echo
  724. %{+m}
  725. ### %bstrip%b <user> [modes]
  726. Set the strip level of another user. A master can't set their own strip
  727. flags without prefixing the modes with a '+' or '-'.
  728. ::su
  729. ### %bsu%b <user>
  730. Lets you assume the identity of another user. If you are a global owner,
  731. this does not require a password. Otherwise, you will be asked for the
  732. user's password. %b%dquit%b returns you to your original handle.
  733. :leaf:topic
  734. ### %btopic%b <text>
  735. changes the channel's topic, assuming the bot is a chanop or the
  736. channel is not +t (uses your current console channel).
  737. See also: console
  738. :hub:trace
  739. ### %btrace%b <bot>
  740. Sends out a trace signal to another bot. If/when the trace signal returns,
  741. (and it should!) you will get an output that looks something like this:
  742. Trace result -> Valis:Stonewall:NoBoty:SomeBoty
  743. This is a list of the bots connected between you and the destination bot.
  744. It should also return the time in seconds taken for the trace to occur.
  745. See also: bots, bottree, vbottree
  746. :hub:traffic
  747. ### %btraffic%b
  748. Shows total and daily net traffic stats since the last %b'%drestart'%b.
  749. Stats groups are IRC, Botnet, Partyline, Transfer.mod and Misc.
  750. %{+m}See also: restart
  751. ::unstick
  752. ### %bunstick%b [ban/exempt/invite] <hostmask/number> [channel]
  753. Makes a "sticky" ban, exempt, or invite normal again.
  754. See also: bans, exempts, invites, stick, -ban, -exempt, -invite
  755. ::whoami
  756. ### %bwhoami%b
  757. Shows your current handle and to what bot you are connected.
  758. See also: whom
  759. ::end