help.txt 44 KB

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