If a command needs the channel name then you must specify the channel
as the first argument to the command when private messaging the bot a
-command.
-
- The following sub sections are internally organized with commands
-that need a channel in one list, and commands that do not need a
-channel in another list.
+command. If, however, you are using the command in a channel you may
+omit the channel argument, and the bot will use the current channel.
* Menu:
3.3.1 Bot Control Commands
--------------------------
- * `cycle' Yes Makes the bot leave and join CHANNEL.
-
- * `die' Makes the bot stop immediately.
+These commands are used to control the behaviour of the bot.
- * `join' Makes the bot join CHANNEL.
+ -- Command: cycle channel
+ Makes the bot leave and join CHANNEL.
- * `nick' Makes the bot use nickname NICK.
+ -- Command: die
+ Makes the bot stop immediately.
- * `save' Saves the userlist.
+ -- Command: join channel
+ Makes the bot join CHANNEL.
- * `setfloodrate'
+ -- Command: nick newnick
+ Makes the bot use nickname NEW-NICK.
- * `setversion'
+ -- Command: setfloodrate messages-per-second
+ Sets the flood rate to MESSAGES-PER-SECOND. The bot will consider
+ users sending more than MESSAGES-PER-SECOND messges in a second to
+ be flooding and will ignore them.
+ -- Command: setversion version-info
+ Sets the string returned when someone requestions the version info
+ of the bot.
\1f
File: bobot++.info, Node: Message Commands, Next: Channel Control, Prev: Bot Control Commands, Up: Built-In Commands
3.3.2 Message Commands
----------------------
- * `action' `do' Yes USER Causes the bot to perform the action `do'
- in the current channel.
+These commands cause the bot to send messages (e.g. sending a message
+to a channel or performing an action). For all commands TARGET may be
+either a user or a channel.
- * `do'
+ -- Command: action target do
+ Makes the bot to perform the action DO in a message sent to TARGET.
- * `msg'
-
- * `say' Yes Makes the bot say MESSAGE on CHANNEL.
+ -- Command: do command
+ Sends a raw irc command. COMMAND is the IRC command you wish to
+ send (e.g. `PRIVMSG #foo Hello!').
+ -- Command: msg target message
+ -- Command: say target message
+ Makes the bot say MESSAGE to TARGET.
\1f
File: bobot++.info, Node: Channel Control, Next: Spylist Commands, Prev: Message Commands, Up: Built-In Commands
3.3.3 Channel Control
---------------------
- * `ban' Bans MASK or NICK from CHANNEL. You need to be a trusted
- user to ban with a MASK.
-
- * `deban' Yes Debans MASK or NICK from CHANNEL. You need to be a
- trusted user to deban with a MASK.
+ -- Command: ban channel mask
+ Bans MASK from CHANNEL. You must be a trusted user to ban using a
+ host mask, but a normal user may ban individual nicks.
- * `deop' Yes Deops MASK or NICK on CHANNEL.
+ -- Command: deban channel mask
+ Debans MASK from CHANNEL. You need to be a trusted user to deban
+ with a MASK.
- * `invite' Yes Invites NICK on CHANNEL.
+ -- Command: deop channel mask
+ Deops MASK on CHANNEL.
- * `keep' Yes Sets the MODES that the bot will keep for CHANNEL.
+ -- Command: invite nick channel
+ Invites NICK to CHANNEL.
- * `kick' Yes Kicks MASK or NICK out of CHANNEL, because of
- REASON. You need to be a trusted user to use a MASK.
+ -- Command: keep channel modes
+ Sets the MODES that the bot will keep for CHANNEL.
- * `kickban' Yes Bans then kicks MASK or NICK out of CHANNEL,
- because of REASON. You need to be a trusted user to use a MASK.
+ -- Command: kick channel mask reason
+ -- Command: kickban channel mask reason
+ Kicks MASK out of CHANNEL, because of REASON. `kickban' also bans
+ MASK.You need to be a trusted user to use a mask.
- * `lock' Locks topic on CHANNEL.
+ -- Command: lock channel
+ Locks topic on CHANNEL
- * `mode' Yes Sends MODE STRING as mode for CHANNEL.
+ -- Command: mode channel modes
+ Sets mode of CHANNEL to the mode string MODES.
- * `op' Yes Ops NICK on CHANNEL.
+ -- Command: op channel nick
+ Ops NICK on CHANNEL
- * `part' Yes Makes the bot leave CHANNEL.
-
- * `tban' Yes Bans NICK or MASK from CHANNEL for TIME seconds.
+ -- Command: part channel
+ Makes the bot leave CHANNEL.
- * `tkban' Yes Bans NICK or MASK from CHANNEL for TIME seconds,
- then kicks him/them because of REASON.
+ -- Command: tban channel mask time
+ -- Command: tkban channel mask time
+ Bans MASK from CHANNEL for TIME seconds. `tkban' also kicks the
+ user. You must be a trusted user to use a mask.
* `topic' Yes If no TOPICis given, prints CHANNEL's topic.
Otherwise, the bot will change CHANNEL's topic to TOPIC.
3.3.5 User List Commands
------------------------
- * `adduser'
+ -- Command: adduser mask
+ Adds the user
- * `deluser' Removes NICK or MASK from the userlist.
+ `deluser' Removes NICK or MASK from the userlist.
- * `userlist' Shows the bot's userlist
+ -- Command: save
+ Saves the userlist.
+
+ `userlist' Shows the bot's userlist
\1f
File: bobot++.info, Node: Server List Commands, Next: Shit List Commands, Prev: User List Commands, Up: Built-In Commands
4.3.1 "High Level" Message Functions
------------------------------------
- -- Function: bot:say channel message
- Send a public or private MESSAGE to CHANNEL.
-
- Sends a normal text message, as if a user had typed it in. The
- DEST can be a nickname or a channel.
-
-- Function: bot:action channel message
Send an "action" type MESSAGE to CHANNEL
* Menu:
* %bot:load-extensions: Query Functions. (line 75)
+* action: Message Commands. (line 11)
+* adduser: User List Commands. (line 7)
+* ban: Channel Control. (line 7)
* bot:action: High Level Message Functions.
- (line 13)
+ (line 7)
* bot:addcommand: Adding New Commands. (line 11)
* bot:addhook: Creating a Hook. (line 9)
* bot:addserver: Scheme Commands. (line 22)
* bot:match-to-me: Query Functions. (line 63)
* bot:mode: Scheme Commands. (line 93)
* bot:msg: High Level Message Functions.
- (line 16)
+ (line 10)
* bot:nextserver: Scheme Commands. (line 96)
* bot:nick: Scheme Commands. (line 99)
* bot:notice: High Level Message Functions.
- (line 27)
+ (line 21)
* bot:op: Scheme Commands. (line 102)
* bot:part: Scheme Commands. (line 105)
* bot:random: Query Functions. (line 33)
* bot:reconnect: Scheme Commands. (line 108)
* bot:say: High Level Message Functions.
- (line 7)
+ (line 11)
* bot:sent-to-me?: Query Functions. (line 67)
* bot:server: Scheme Commands. (line 111)
* bot:setfloodrate: Scheme Commands. (line 115)
* bot:use-module: Query Functions. (line 57)
* bot:who: Scheme Commands. (line 133)
* bot:whois: Scheme Commands. (line 137)
+* cycle: Bot Control Commands.
+ (line 9)
+* deban: Channel Control. (line 11)
+* deop: Channel Control. (line 15)
+* die: Bot Control Commands.
+ (line 12)
+* do: Message Commands. (line 14)
* hooks/action: Received Message Hooks.
(line 9)
* hooks/ctcp: Received Message Hooks.
* hooks/timer: Miscellaneous Hooks. (line 12)
* hooks/topic: Received Message Hooks.
(line 153)
+* invite: Channel Control. (line 18)
+* join: Bot Control Commands.
+ (line 15)
+* keep: Channel Control. (line 21)
+* kick: Channel Control. (line 24)
+* kickban: Channel Control. (line 25)
+* lock: Channel Control. (line 29)
+* mode: Channel Control. (line 32)
+* msg: Message Commands. (line 18)
+* nick: Bot Control Commands.
+ (line 18)
+* op: Channel Control. (line 35)
+* part: Channel Control. (line 38)
+* save: User List Commands. (line 12)
+* say: Message Commands. (line 19)
+* setfloodrate: Bot Control Commands.
+ (line 21)
+* setversion: Bot Control Commands.
+ (line 26)
+* tban: Channel Control. (line 41)
+* tkban: Channel Control. (line 42)
\1f
File: bobot++.info, Node: Variable Index, Prev: Function Index, Up: Top
Node: Automatic Op\7f16585
Node: Shit Levels\7f16999
Node: Built-In Commands\7f17725
-Node: Bot Control Commands\7f18632
-Node: Message Commands\7f19089
-Node: Channel Control\7f19443
-Node: Spylist Commands\7f20811
-Node: User List Commands\7f21125
-Node: Server List Commands\7f21423
-Node: Shit List Commands\7f22138
-Node: Channel Info\7f22433
-Node: Scripting Commands\7f22801
-Node: Authentication Commands\7f23166
-Node: Miscellaneous Commands\7f23618
-Node: Scripting\7f24179
-Node: Adding New Commands\7f25268
-Node: Hooks\7f26579
-Node: Creating a Hook\7f27417
-Node: Hook Types\7f28623
-Node: Received Message Hooks\7f29187
-Node: Sent Message Hooks\7f34414
-Node: DCC CHAT Hooks\7f36298
-Node: Miscellaneous Hooks\7f37338
-Node: Sending Messages\7f37787
-Node: High Level Message Functions\7f38319
-Node: Low Level Message Functions\7f39383
-Node: Misc Scripting Stuff\7f40436
-Node: Scheme Commands\7f40934
-Node: Query Functions\7f45590
-Node: Concept Index\7f47816
-Node: Function Index\7f48035
-Node: Variable Index\7f56287
+Node: Bot Control Commands\7f18601
+Node: Message Commands\7f19456
+Node: Channel Control\7f20141
+Node: Spylist Commands\7f21649
+Node: User List Commands\7f21963
+Node: Server List Commands\7f22331
+Node: Shit List Commands\7f23046
+Node: Channel Info\7f23341
+Node: Scripting Commands\7f23709
+Node: Authentication Commands\7f24074
+Node: Miscellaneous Commands\7f24526
+Node: Scripting\7f25087
+Node: Adding New Commands\7f26176
+Node: Hooks\7f27487
+Node: Creating a Hook\7f28325
+Node: Hook Types\7f29531
+Node: Received Message Hooks\7f30095
+Node: Sent Message Hooks\7f35322
+Node: DCC CHAT Hooks\7f37206
+Node: Miscellaneous Hooks\7f38246
+Node: Sending Messages\7f38695
+Node: High Level Message Functions\7f39227
+Node: Low Level Message Functions\7f40090
+Node: Misc Scripting Stuff\7f41143
+Node: Scheme Commands\7f41641
+Node: Query Functions\7f46297
+Node: Concept Index\7f48523
+Node: Function Index\7f48742
+Node: Variable Index\7f59197
\1f
End Tag Table
If a command needs the channel name then you must specify the channel
as the first argument to the command when private messaging the bot a
-command.
-
-The following sub sections are internally organized with commands that
-need a channel in one list, and commands that do not need a channel in
-another list.
+command. If, however, you are using the command in a channel you may
+omit the channel argument, and the bot will use the current channel.
@menu
* Bot Control Commands::
@node Bot Control Commands, Message Commands, Built-In Commands, Built-In Commands
@subsection Bot Control Commands
-@itemize
-
-@item @command{cycle} Yes Makes the bot leave and join
-@var{channel}.
+These commands are used to control the behaviour of the bot.
-@item @command{die} Makes the bot stop immediately.
+@deffn Command cycle channel
+Makes the bot leave and join @var{channel}.
+@end deffn
-@item @command{join} Makes the bot join @var{channel}.
+@deffn Command die
+Makes the bot stop immediately.
+@end deffn
-@item @command{nick} Makes the bot use nickname @var{nick}.
+@deffn Command join channel
+Makes the bot join @var{channel}.
+@end deffn
-@item @command{save} Saves the userlist.
+@deffn Command nick newnick
+Makes the bot use nickname @var{new-nick}.
+@end deffn
-@item @command{setfloodrate}
+@deffn Command setfloodrate messages-per-second
+Sets the flood rate to @var{messages-per-second}. The bot will
+consider users sending more than @var{messages-per-second} messges in
+a second to be flooding and will ignore them.
+@end deffn
-@item @command{setversion}
+@deffn Command setversion version-info
+Sets the string returned when someone requestions the version info of
+the bot.
+@end deffn
-@end itemize
@node Message Commands, Channel Control, Bot Control Commands, Built-In Commands
@subsection Message Commands
-@itemize
-
-@item @command{action} @option{do} Yes @var{USER}
-Causes the bot to perform the action @option{do} in the current
-channel.
+These commands cause the bot to send messages (e.g. sending a message
+to a channel or performing an action). For all commands @var{target}
+may be either a user or a channel.
-@item @command{do}
+@deffn Command action target do
+Makes the bot to perform the action @var{do} in a message sent to
+@var{target}.
+@end deffn
-@item @command{msg}
+@deffn Command do command
+Sends a raw irc command. @var{command} is the IRC command you wish to
+send (e.g. @samp{PRIVMSG #foo Hello!}).
+@end deffn
-@item @command{say} Yes Makes the bot say @var{message}
-on @var{channel}.
-
-@end itemize
+@deffn Command msg target message
+@deffnx Command say target message
+Makes the bot say @var{message} to @var{target}.
+@end deffn
@node Channel Control, Spylist Commands, Message Commands, Built-In Commands
@subsection Channel Control
-@itemize
-
-@item @command{ban} Bans @var{mask} or @var{nick} from
-@var{channel}. You need to be a trusted user to ban with a
-@var{mask}.
+@deffn Command ban channel mask
+Bans @var{mask} from @var{channel}. You must be a trusted user to ban
+using a host mask, but a normal user may ban individual nicks.
+@end deffn
-@item @command{deban} Yes Debans @var{mask} or
-@var{nick} from @var{channel}. You need to be a trusted user to deban
-with a @var{mask}.
+@deffn Command deban channel mask
+Debans @var{mask} from @var{channel}. You must be a trusted user to
+deban with a @var{mask}.
+@end deffn
-@item @command{deop} Yes Deops @var{mask} or @var{nick}
-on @var{channel}.
+@deffn Command deop channel mask
+Deops @var{mask} on @var{channel}.
+@end deffn
-@item @command{invite} Yes Invites @var{nick} on
-@var{channel}.
+@deffn Command invite nick channel
+Invites @var{nick} to @var{channel}.
+@end deffn
-@item @command{keep} Yes Sets the @var{modes} that the
-bot will keep for @var{channel}.
-
-@item @command{kick} Yes Kicks @var{mask} or @var{nick}
-out of @var{channel}, because of @var{reason}. You need to be a
-trusted user to use a @var{mask}.
-
-@item @command{kickban} Yes Bans then kicks @var{mask}
-or @var{nick} out of @var{channel}, because of @var{reason}. You need
-to be a trusted user to use a @var{mask}.
-
-@item @command{lock} Locks topic on @var{channel}.
-
-@item @command{mode} Yes Sends @var{mode string} as
-mode for @var{channel}.
-
-@item @command{op} Yes Ops @var{nick} on @var{channel}.
+@deffn Command keep channel modes
+Sets the @var{modes} that the bot will keep for @var{channel}.
+@end deffn
-@item @command{part} Yes Makes the bot leave @var{channel}.
+@deffn Command kick channel mask reason
+@deffnx Command kickban channel mask reason
+Kicks @var{mask} out of @var{channel}, because of
+@var{reason}. @command{kickban} also bans @var{mask}.You must be a
+trusted user to use a mask.
+@end deffn
-@item @command{tban} Yes Bans @var{nick} or @var{mask}
-from @var{channel} for @var{time} seconds.
+@deffn Command lock channel
+Locks topic on @var{channel}
+@end deffn
-@item @command{tkban} Yes Bans @var{nick} or @var{mask}
-from @var{channel} for @var{time} seconds, then kicks him/them because
-of @var{reason}.
+@deffn Command mode channel modes
+Sets mode of @var{channel} to the mode string @var{modes}.
+@end deffn
-@item @command{topic} Yes If no @var{topic}is given,
-prints @var{channel}'s topic. Otherwise, the bot will change
-@var{channel}'s topic to @var{topic}.
+@deffn Command op channel nick
+Ops @var{nick} on @var{channel}
+@end deffn
-@item @command{unlock} Yes Makes the bot unlock topic
-on @var{channel}
+@deffn Command part channel
+Makes the bot leave @var{channel}.
+@end deffn
+
+@deffn Command tban channel mask time
+@deffnx Command tkban channel mask time
+Bans @var{mask} from @var{channel} for @var{time}
+seconds. @command{tkban} also kicks the user. You must be a trusted
+user to use a mask.
+@end deffn
+
+@deffn Command topic channel [topic]
+Sets the topic in @var{channel} to @var{topic}. If @var{topic} is not
+supplied the current topic is sent as a notice to the user calling the
+command.
+@end deffn
-@end itemize
+@deffn Command unlock channel
+Unlocks the topic on @var{channel}
+@end deffn
@node Spylist Commands, User List Commands, Channel Control, Built-In Commands
@subsection Spylist Commands
@node User List Commands, Server List Commands, Spylist Commands, Built-In Commands
@subsection User List Commands
-@itemize
-@item @command{adduser}
+@deffn Command adduser mask
+Adds the user
+@end deffn
-@item @command{deluser} Removes @var{nick} or
+@command{deluser} Removes @var{nick} or
@var{mask} from the userlist.
+@deffn Command save
+Saves the userlist.
+@end deffn
-@item @command{userlist} Shows the bot's userlist
-@end itemize
+@command{userlist} Shows the bot's userlist
@node Server List Commands, Shit List Commands, User List Commands, Built-In Commands
@subsection Server List Commands
@node High Level Message Functions, Low Level Message Functions, Sending Messages, Sending Messages
@subsection ``High Level'' Message Functions
-@defun bot:say channel message
-Send a public or private @var{message} to @var{channel}.
-
-Sends a normal text message, as if a user had typed it in. The
-@var{dest} can be a nickname or a channel.
-@end defun
-
@defun bot:action channel message
Send an ``action'' type @var{message} to @var{channel}
@end defun
@c (2, 0, 0)
@defun bot:ban channel mask-or-nick
-Bans @var{mask} or @var{nick} from @var{channel}. You need to be a trusted
+Bans @var{mask} or @var{nick} from @var{channel}. You must be a trusted
user to ban with a @var{mask}.
@end defun
@c (2, 0, 0)
@defun bot:deban channel mask-or-nick
-Debans @var{mask} or @var{nick} from @var{channel}. You need to be a trusted
+Debans @var{mask} or @var{nick} from @var{channel}. You must be a trusted
user to deban with a @var{mask}.
@end defun
@c (2, 1, 0)
@defun bot:kick channel mask-or-nick [reason]
Kicks @var{mask} or @var{nick} out of @var{channel}, because of @var{reason}.
-You need to be a trusted user to use a @var{mask}.
+You must be a trusted user to use a @var{mask}.
@end defun
@c (2, 1, 0)
@defun bot:kickban channel mask-or-nick [reason]
Bans then kicks @var{mask} or @var{nick} out of @var{channel},
because of @var{reason}.
-You need to be a trusted user to use a @var{mask}.
+You must be a trusted user to use a @var{mask}.
@end defun
@c (1, 0, 0)
HCoop / clinton / bobotpp.git / commitdiff